About GetLargeBillerPaymentAddress
Large Billers may have multiple payment addresses. The payment address list to help user select the correct one. This API request can retrieve payment addresses of Large Billers - with address IDs for each.
First two lines of the payment address can be passed with the mandatory address ID to appear on the vendor payment if passed as an optional parameter into ConnectLargeBillerAsVendor API.
Example
Request
<API_URL_EndPoint>/GetLargeBillerPaymentAddress.json
data={
"largeBillerId": "123456",
"start": 0,
"max": 999
}
Response
NOTE: In the Response, use LargeBillerPaymentAddress id to connect vendor to the network.
IMPORTANT: More than one address can be returned (i.e., payment centers to process payments). Select the one that matches the zip code on the billing statement. Any address will work since the payment is sent electronically and all addresses are for the same largebillerId
.
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"addresses":
[{
"id": "0120023434",
"address1" : "value",
"address2" : "value",
"addressCity" : "value",
"addressState" : "value",
"addressCountry" : "value",
"addressZip" : "value",
},
{
"id": "015555",
"address1" : "value",
"address2" : "value",
"addressCity" : "value",
"addressState" : "value",
"addressCountry" : "value",
"addressZip" : "value",
}]
}
}
Resources
Parameters
Field Name | Description | Required? |
---|---|---|
largeBillerId | Vendor id of large biller, returned by LargeBillerSearch.json | Yes |
start | Index of first result to return | Yes |
max | Maximum number of results to return | Yes |