About LargeBillerSearch
This searches the Large Biller network by name, account number and zip code. Bill.com uses the RPPS Large Biller directory.
Example
Request
<API_URL_EndPoint>/LargeBillerSearch.json
data={
"name": "Big City Utilities",
"accNumber": "00000000",
"addressZip": "95052",
"start": 0,
"max": 999
}
Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"matchedOn" : {
"name" : true/false,
"accNumber" : true/false,
"addressZip" : true/false
},
"largeBillers" : [ {
"entity" : "LargeBiller",
"id" : "orv01NASUXYNHOLX16ik",
"billerReference" : 7493241799,
"billerName" : "Big City Utilities",
"lineOfBusiness" : "RB",
"billerClass" : "Electric / Gas / Power / Water",
"billerType" : "Gateway",
"currency" : "840"
} ]
}
}
Resources
Parameters
Request parameters
| Field Name | Description | Required? |
|---|---|---|
| name | Vendor Name | Yes |
| accNumber | Vendor account number | No |
| addressZip | Zip code of vendor address | No |
| start | Index of the first result to return | Yes |
| max | Maximum number of results to return | Yes |
Response parameters
| Field Name | Type | Description |
|---|---|---|
| matchedOn | boolean | Returns query matches. The query parameters are: name, account number and zip code. Response contains boolean for each query parameter. For example: { name: true, accNumber: true, addressZip: false } // Partial match { name: true, accNumber: true, addressZip: true } // Perfect match |
| results | Array | List of RPPS vendors with attributes: largeBillerId billerName billerReference lineOfBusiness billerClass billerType currency |