# Deactivate Biller
source: https://developer.mastercard.com/rpps-biller-maintenance-service/documentation/parameters/deactivate-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.                                                                                                                                                                                                                                                                                             | `Deactivate` only applies to this model |
| 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}

### Properties {#properties-1}

|    Name    |         Type         |                        Description                         | Notes |
|------------|----------------------|------------------------------------------------------------|-------|
| billerInfo | RPPSBillerBillerInfo | Used to provide billerId for the biller being deactivated. |       |

## RPPSBillerBillerInfo {#rppsbillerbillerinfo}

### Properties {#properties-2}

|          Name          |          Type          |                                                              Description                                                              |         Notes         |
|------------------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
| billerId               | String                 | This ID uniquely identifies the biller. Only numeric values will be accepted.                                                         | example: "0123456789" |
| rppsBillerDeactivation | RPPSBillerDeactivation | Used to deactivate the RPPS Biller. This model is required when `Deactivate` is input for the billerRecordAction in the Biller model. |                       |

## RPPSBillerDeactivation {#rppsbillerdeactivation}

### Properties {#properties-3}

|        Name        |  Type  |                                                                                                                          Description                                                                                                                           |                                       Notes                                        |
|--------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
| deactivationReason | String | Indicates where future payments will be directed for the deactivated biller. 'Stop Payment' will not require any additional fields. \* `Biller ID` - Deactivate Biller ID \* `Address` - Deactivate Biller Address \* `Stop Payment` - Stop Payment for Biller | `Deactivate`                                                                       |
| forwardBillerId    | String | This ID uniquely identifies the forward biller (the biller that will be used going forward). Only numeric values will be accepted.                                                                                                                             | This field is only required when `Biller ID` is input for the deactivation action. |
| forwardAddress1    | String | The address where future payments should be mailed. This field is only required when `Address` is input for the deactivation action. Only the following special characters are allowed: \`\~!@#$\&\*<>+={};:/?,."_"' -                                         | example: PO BOX 1                                                                  |
| forwardAddress2    | String | The second address line where future payments should be mailed. This field is only used when `Address` is input for the deactivation action. Only the following special characters are allowed: \`\~!@#$\&\*<>+={};:/?,."_"' -                                 | example: SUITE 1234                                                                |
| forwardCity        | String | The city where future payments should be mailed. This field is only required when `Address` is input for the deactivation action.                                                                                                                              | example: O'FALLON                                                                  |
| forwardState       | String | The state code where future payments should be mailed.                                                                                                                                                                                                         | example: MO                                                                        |
| forwardPostalCode  | String | The postal where future payments should be mailed. This field is only required when `Address` is input for the deactivation action.                                                                                                                            | example: 63368-0000                                                                |

## BillerRequestsProcessed {#billerrequestsprocessed}

### Properties {#properties-4}

|        Name        |  Type  |                                                                                                                                                                              Description                                                                                                                                                                              |                     Notes                     |
|--------------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
| billerRecordAction | String | Represents an action by a Concentrator on a Biller. Add, Edit or Deactivate                                                                                                                                                                                                                                                                                           | example: "Deactivate"                         |
| 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"                         |

<br />

## Error - Response Model {#error---response-model}

### Properties {#properties-5}

|      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                                                             |       |