# Get Biller Details
source: https://developer.mastercard.com/rpps-biller-maintenance-service/documentation/use-cases/get-biller-details/index.md

### Get Biller Details {#get-biller-details}

Concentrators can retrieve the details of an existing biller for purposes of validating records in RPPS and retrieving the internal keys needed for editing the biller. This is performed via the Remote Payment and Presentment Service (RPPS) Biller Maintenance Service. This is required before submitting an Edit request. The API call validates the Biller ID and retrieves the complete biller record from RPPS. This is accomplished by calling the GET `/biller/{biller_id}` path.

### Step-by-Step Workflow {#step-by-step-workflow}

**Step 1:** Identify the Biller ID you want to retrieve (must be 10 digits)
**Step 2:** Call GET `/biller/{biller_id}` with the biller ID in the path
**Step 3:** Receive the complete biller record including:

* Biller info (ID, name, type, class, remittance details)
* Addresses with internal keys
* Masks and mask descriptions with internal keys
* AKAs (alternate names) **Step 4:** Use this response data when preparing an Edit Biller request (include all keys) **Step 5:** If biller not found, verify the Biller ID is correct and active

#### Rationale {#rationale}

The Get Biller Details endpoint is read-only and retrieves the current state of a biller. It returns internal keys required for Edit requests, ensuring data consistency. This is a prerequisite for any Edit or Deactivate operations on existing billers.

#### API Reference {#api-reference}


API Reference: `GET /biller/{biller_id}`

## Getting Biller Details {#getting-biller-details}

### Request - Static Test Data {#request---static-test-data}

Below is an example request path for getting the biller details.

    /biller/{biller_id}

### Response - Success {#response---success}

```json
{
  "effectiveDate": "2024/12/16",
  "rppsBiller": {
    "billerInfo": {
      "rppsId": "00027877",
      "billerId": "0123456883",
      "billerName": "CALLSOURCE",
      "batchName": "CALLSOURCE",
      "billerClass": "OTH",
      "billerType": "GTW",
      "remittanceRTN": "111111111",
      "remittanceDDA": "654321",
      "preNotes": "N",
      "billerStatus": "Active"
    },
    "addresses": [
      {
        "key": 214128,
        "type": "Sta",
        "address1": "PO BOX 60280",
        "city": "LOS ANGELES",
        "state": "CA",
        "postalCode": "90060-0280"
      }
    ],
    "masks": [
      {
        "key": 1942,
        "maskFormat": "!!!!!!!!!!!!!!",
        "maskDescriptions": [
          "Standard Mask"
        ]
      },
      {
        "key": 1945,
        "maskFormat": "!!!!!!!!!!!",
        "maskDescriptions": [
          "Standard Mask"
        ]
      },
      {
        "key": 1946,
        "maskFormat": "!!!!!!!!!!",
        "maskDescriptions": [
          "Standard Mask"
        ]
      },
      {
        "key": 1947,
        "maskFormat": "!!!!!!!!!",
        "maskDescriptions": [
          "Standard Mask"
        ]
      },
      {
        "key": 1948,
        "maskFormat": "!!!!!!!!",
        "maskDescriptions": [
          "Standard Mask"
        ]
      },
      {
        "key": 1949,
        "maskFormat": "!!!!!!!",
        "maskDescriptions": [
          "Standard Mask"
        ]
      },
      {
        "key": 1950,
        "maskFormat": "!!!!!!",
        "maskDescriptions": [
          "Standard Mask"
        ]
      },
      {
        "key": 1951,
        "maskFormat": "!!!!!",
        "maskDescriptions": [
          "Standard Mask"
        ]
      },
      {
        "key": 1952,
        "maskFormat": "!!!!",
        "maskDescriptions": [
          "Standard Mask"
        ]
      },
      {
        "key": 1953,
        "maskFormat": "!!!",
        "maskDescriptions": [
          "Standard Mask"
        ]
      },
      {
        "key": 1954,
        "maskFormat": "!!",
        "maskDescriptions": [
          "Standard Mask"
        ]
      },
      {
        "key": 1955,
        "maskFormat": "!",
        "maskDescriptions": [
          "Standard Mask"
        ]
      }
    ]
  }
}
```

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

The following example shows the error returned when your Client ID does not have access to manage Billers:

```json
{
  "Errors": {
    "Error": [
      {
        "Source": "RPPS Biller Maintenance Service",
        "ReasonCode": "BPBMSAPI_ERR_0021",
        "Description": "User Error",
        "Recoverable": true,
        "Details": "Biller ID must be 10 digits"
      }
    ]
  }
}
```

## Next Steps {#next-steps}

For what is required in the payload, please refer to [Parameters](https://developer.mastercard.com/rpps-biller-maintenance-service/documentation/parameters/wr-status-parameters/index.md).

Please continue to [API Reference](https://developer.mastercard.com/rpps-biller-maintenance-service/documentation/api-reference/index.md).