# Add and Edit Biller source: https://developer.mastercard.com/rpps-biller-maintenance-service/documentation/parameters/add-biller-parameters/index.md ## Biller - Request Model {#biller---request-model} ### Properties {#properties} | Name | Type | Description | Notes | |--------------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| | billerRecordAction | String | Represents an action by a Concentrator on a Biller. \* `Add` - Adding a new Biller to RPPS \* `Edit` - to modify existing biller details in RPPS \* `Deactivate` - to inactivate a biller from RPPS so they can no longer accept payments Represents an action by a Biller Service Provider on a Biller. | example: "Add" | | effectiveDate | String | ISO8601 standard date when the biller action will be live. The effectiveDate must be between 5 and 7 business days U.S. Central Date from the current date and cannot occur on weekends or holidays. Billers are processed on the effective date at 3:30am Central Time. Date Restrictions are set annually and posted in the Biller Directory. | example: "2030/12/31" | | rppsBiller | RPPSBiller | Used to provide information related to the RPPS biller. Examples include: biller info, address, mask, AKA | | ## RPPSBiller {#rppsbiller} ### Properties {#properties-1} | Name | Type | Description | Notes | |------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| | billerInfo | RPPSBillerBillerInfo | Used to provide information related to the biller, for example, ID, name, class, type, etc. This model is required when Add or Edit is input for the billerRecordAction in the Biller model. | | | addresses | List\ | Contains addresses. At least 1 address is required when an Add operation is performed. When an Edit operation is performed, this array is optional and should only contain addresses that are being edited or deleted. | example: \[{"type":"Sta","address1":"PO BOX 1","city":"O'FALLON","state":"MO","postalCode":"63368-0000"}\] | | masks | List\ | Used to provide mask related information about the biller, for example, mask format and mask descriptions. At least 1 mask is required when an Add operation is performed. When an Edit operation is performed, this array is optional and should only contain masks that are being edited or deleted. | example: \[{"maskFormat":"##########","maskDescriptions":\["auto"\]}\] | | akas | List\ | Used to provide an assumed name, also known as doing business as name. Akas are optional. When an Edit operation is performed, this array is optional and should only contain Akas that are being edited or deleted. | example: \[{"name":"Capital"}\] | ## RPPSBillerBillerInfo {#rppsbillerbillerinfo} ### Properties {#properties-2} | Name | Type | Description | Notes | |---------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| | rppsId | String | This ID uniquely identifies the biller's concentrator. Only numeric values will be accepted. | example: "01234567" | | billerId | String | This ID uniquely identifies the biller. Only numeric values will be accepted. | example: "0123456789" | | billerName | String | This is the name associated with the biller Id. Only the following special characters are allowed: \`\~!@#$\&\*+={};:/?,."_"' - | example: "ABC Lawn Service" | | batchName | String | This is the biller's name value which is populated in transaction files. If no value is provided, this will default to the biller's name. Only the following special characters are allowed: \`\~!@#$\&\*+={};:/?,."_"' - | \[optional\] example: "ABC Lawn" | | billerClass | String | The biller classification code associated with the biller. Valid biller classification codes are as listed: AFI - Auto Finance AIR - Airline BCA - Bank Card CAB - Cable CHU - Church CME - Club Membership CSP - College Savings Plan DSL - DSL - ISP FSE - Financial Services GOC - Gas / Oil Card HAS - Homeowners Association HSE - Healthcare Services INS - Insurance LFI - School / Car / Bank Loan \& Finance MOR - Mortgage MUN - Municipality OTH - Other PBA - Personal Banking (checking, savings, etc) PDC - Prepaid Debit Card PHN - Phone RET - Retail RPR - Rental Properties SAN - Sanitation SES - Schools \& Educational Services SRA - Satellite Radio SSY - Security Systems / Monitoring Services STV - Satellite TV SUB - Subscription TAX - Taxes \* TUI - Tuition UTL - Electric / Gas / Power / Water WPH - Wireless Phone | example: "INS" | | billerType | String | The biller type code must be either Core or Gateway and must align to the allowed biller types to the concentrator. Valid biller type codes are as listed: CRE - Core GTW - Gateway | example: "CRE" | | remittanceRTN | String | The routing number value that will be populated in every entry detail record. Only numeric values will be accepted. | \[optional\] default: "000000000" | | remittanceDDA | String | The account number value that wil be populated in every entry detail record. If no value is provided, will default to the Biller ID. Only numeric values will be accepted. | \[optional\] example: "654321" | | preNotes | String | Indicates if the biller will accept a pre-notification transaction. Only "Y" or "N" are allowed. | example: "Y" | | externalNotes | String | Contains special instructions for transaction routing. Only the following special characters are allowed: \`\~!@#$\&\*+={};:/?,."_"' - | example: "Please remove all dashes from the consumer's account number before matching to the RPPS account mask and sending the payment." | ## RPPSBillerAddress {#rppsbilleraddress} ### Properties {#properties-3} | Name | Type | Description | Notes | |--------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------| | recordAction | string | \* `Add` - Adding a new record \* `Edit` - Editing an existing record \* `Delete` - Delete an existing record Indicates the action being performed within the record | Required when billerRecordAction is `Edit` in the Biller Model. | | type | String | The type of address associated with the biller. Valid address codes are as listed: Sta - Standard Remittance Address Pre - Previous Remittance Address | example: "Sta" | | address1 | String | The address associated with the biller. | example: "PO BOX 1" | | address2 | String | The second address line associated with the biller. | \[optional\] | | address3 | String | The third address line associated with the biller. | \[optional\] example: "UNIT 1234" | | city | String | The city associated with the biller's address. | example: "O'FALLON" | | state | String | The state code associated with the biller's address. | example: "MO" | | postalCode | String | The postal code associated with the biller's address. | example: "63368-0000" | ## RPPSBillerMask {#rppsbillermask} ### Properties {#properties-4} | Name | Type | Description | Notes | |------------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------| | recordAction | string | \* `Add` - Adding a new record \* `Edit` - Editing an existing record \* `Delete` - Delete an existing record Indicates the action being performed within the record | Required when billerRecordAction is `Edit` in the Biller Model. | | maskFormat | String | Defines the formatting for a consumer's account number with a biller | example: "##########" | | maskDescriptions | List\ | An optional name that can be associated with an account mask. | \[optional\] example: \["auto"\] | ## RPPSBillerAkas {#rppsbillerakas} ### Properties {#properties-5} | Name | Type | Description | Notes | |--------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------| | recordAction | string | \* `Add` - Adding a new record \* `Edit` - Editing an existing record \* `Delete` - Delete an existing record Indicates the action being performed within the record | Required when billerRecordAction is `Edit` in the Biller Model. | | name | String | A name that provides an assumed name, also known as doing business as name. This will enable the biller to provide the name that is most recognized in the way they conduct business. | example: "Capital" | ## BillerRequestsProcessed {#billerrequestsprocessed} ### Properties {#properties-6} | Name | Type | Description | Notes | |--------------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| | billerRecordAction | String | Represents an action by a Concentrator on a Biller. Add, Edit or Deactivate | example: "Add" | | billerId | String | This ID uniquely identifies the biller. Only numeric values will be accepted. | example: "0123456789" | | statusIndicator | String | statusIndicator: "SUCCESS" - The action was successfully performed on the creditor. "REJECTED" - The action was not successfully performed on the creditor. | example: "Success" | | statusDescription | String | A verbose Success or Rejection message describing the status of the biller action performed. | Successfully created Biller workflow request. | | workRequestId | Number | The Biller Work Request Identifier that will be provided upon a successful biller action. The Identifier can be used to reference the details of the actions performed on the biller. | | | effectiveDate | String | ISO8601 standard date when the biller action will be live. Default is current date + 5 business days U.S. Central Date. The date cannot be set earlier than the default, but may be extended and cannot occur on weekends. Billers are processed on the effective date at 3:30am Central Time. Date Restrictions are set annually and posted in the Biller Directory. | example: "2030/12/31" |
## Error - Response Model {#error---response-model} ### Properties {#properties-7} | Name | Type | Description | Notes | |-----------------|-------------|-------------------------------------------------------------------------------------------------------------|-------| | **source** | **String** | The application name that generated this error. | | | **reasonCode** | **String** | A unique constant identifying the error case encountered during request processing. | | | **description** | **String** | Short description of the ReasonCode field | | | **recoverable** | **Boolean** | Indicates whether this error will always be returned for this request, or retrying could change the outcome | | | **details** | **String** | Detailed information about the ReasonCode field | |