Get Biller
Request URL
GET /transfer-to/bills/biller/:billerId
Description
This API returns the data for the specified biller. The billerId is given as a path parameter in the request URL. Replace :billerIdwith the desired ID.
Snippet Examples
javascript
const axios = require('axios');
const config = {
method: 'GET',
url: '${CONNECTFI_BASE_URL}/transfer-to/bills/biller/:billerId',
headers: {
'x-connectfi-token': "A long random string token received from /auth/get-token request"
},
};
let result;
try {
result = await axios.request(config);
if (result.status === 200) {
console.log(JSON.stringify(result.data));
}
} catch (err) {
console.log({
errCode: err.code,
responseStatus: err.response && err.response.status,
data: err.response && JSON.stringify(err.response.data)
});
}
cURL
curl --location "CONNECTFI_BASE_URL/transfer-to/bills/biller/:billerId" --header "x-connectfi-token: A long random string token received from /auth/get-token request"
Successful Response Examples
200 SUCCESSFUL RESPONSE
HEADERS
| Header | Value |
|---|---|
| x-connectfi-token | A long random string token received from /auth/get-token request |
PARAMETERS
| Parameter | Description | Value |
|---|---|---|
| billerId | [required] | 1234567890 |
REQUEST BODY
RESPONSE BODY
{
"code": "0",
"data": {
"original": {
"biller_id": "1234567890",
"accept_CDD_prenotes": "",
"accept_CDF_prenotes": "",
"accept_CDN_prenotes": "",
"accept_CDP_prenotes": "",
"accept_CDV_prenotes": "",
"accept_FBC_prenotes": "",
"accept_FBD_prenotes": "",
"accepts_DMP_payments_only": "",
"accepts_DMP_prenotes": "",
"accepts_exception_payments": "N",
"accepts_guaranteed_payments_only": "Y",
"accepts_prenotes": "N",
"addresses": [
{
"recordType": "1",
"address_key": "123456",
"record_effective_date": "2018-08-31",
"address_type": "Standard",
"address_line1": "PO BOX 1234",
"address_line2": "",
"city": "CAROL STREAM ",
"state": "IL",
"country_code": "USA",
"postal_code": "12345-1234"
}
],
"akas": [],
"average_response_time": "",
"billerKey": "123456",
"biller_class": "Insurance",
"biller_name": "Full BillerName",
"biller_type": "Core",
"check_digit_routine": "N",
"contacts": [
{
"recordType": "5",
"contact_key": "123456",
"record_effective_date": "2018-08-31",
"contact_type": "Payment Research - Primary",
"organization_name": "",
"courtesy_title": "",
"fist_name": "John",
"last_name": "Contact",
"title": "",
"address_line1": "",
"address_line2": "",
"city": "",
"state": "",
"country_code": "",
"postal_code": "",
"email": "John.contact@email.test"
}
],
"country_code": "USA",
"currency_code": "840",
"dtsCreatedAt": "2023-02-03T08:01:58.747Z",
"dtsUpdatedAt": "2024-08-08T13:02:42.598Z",
"file_format": "",
"isArchive": false,
"line_of_business": "RB",
"live_date": "2018-08-31",
"masks": [
{
"recordType": "2",
"mask_key": "625830",
"record_effective_date": "2018-08-31",
"mask_length": "9",
"mask": "#########",
"exception_mask": "N"
}
],
"note": "",
"phones": [
{
"recordType": "6",
"phone_key": "123456",
"record_effective_date": "2018-08-31",
"phone_type": "Phone",
"phone_number": "555-666-7777"
}
],
"previous_biller_name": "",
"recordType": "0",
"record_effective_date": "2018-11-30",
"require_addenda_with_reversals": "N",
"return_CDA": "",
"return_CDC": "",
"return_CDM": "",
"return_CDR": "",
"return_CDT": "",
"return_CDV": "",
"routing_number": "",
"state_code": "",
"territory_code": "National",
"total_AKAs": "0",
"total_addresses": "1",
"total_contacts": "1",
"total_masks": "1"
},
"matched": {
"biller_id": "1234567890",
"accept_CDD_prenotes": "",
"accept_CDF_prenotes": "",
"accept_CDN_prenotes": "",
"accept_CDP_prenotes": "",
"accept_CDV_prenotes": "",
"accept_FBC_prenotes": "",
"accept_FBD_prenotes": "",
"accepts_DMP_payments_only": "",
"accepts_DMP_prenotes": "",
"accepts_exception_payments": "N",
"accepts_guaranteed_payments_only": "Y",
"accepts_prenotes": "N",
"addresses": [
{
"recordType": "1",
"address_key": "123456",
"record_effective_date": "2018-08-31",
"address_type": "Standard",
"address_line1": "PO BOX 1234",
"address_line2": "",
"city": "CAROL STREAM ",
"state": "IL",
"country_code": "USA",
"postal_code": "12345-1234"
}
],
"akas": [],
"average_response_time": "",
"billerKey": "123456",
"biller_class": "Insurance",
"biller_name": "Full BillerName",
"biller_type": "Core",
"check_digit_routine": "N",
"contacts": [
{
"recordType": "5",
"contact_key": "123456",
"record_effective_date": "2018-08-31",
"contact_type": "Payment Research - Primary",
"organization_name": "",
"courtesy_title": "",
"fist_name": "John",
"last_name": "Contact",
"title": "",
"address_line1": "",
"address_line2": "",
"city": "",
"state": "",
"country_code": "",
"postal_code": "",
"email": "John.contact@email.test"
}
],
"country_code": "USA",
"currency_code": "840",
"dtsCreatedAt": "2023-02-03T08:01:58.747Z",
"dtsUpdatedAt": "2024-08-08T13:02:42.598Z",
"file_format": "",
"isArchive": false,
"line_of_business": "RB",
"live_date": "2018-08-31",
"masks": [
{
"recordType": "2",
"mask_key": "625830",
"record_effective_date": "2018-08-31",
"mask_length": "9",
"mask": "#########",
"exception_mask": "N"
}
],
"note": "",
"phones": [
{
"recordType": "6",
"phone_key": "123456",
"record_effective_date": "2018-08-31",
"phone_type": "Phone",
"phone_number": "555-666-7777"
}
],
"previous_biller_name": "",
"recordType": "0",
"record_effective_date": "2018-11-30",
"require_addenda_with_reversals": "N",
"return_CDA": "",
"return_CDC": "",
"return_CDM": "",
"return_CDR": "",
"return_CDT": "",
"return_CDV": "",
"routing_number": "",
"state_code": "",
"territory_code": "National",
"total_AKAs": "0",
"total_addresses": "1",
"total_contacts": "1",
"total_masks": "1"
}
},
"requestId": "09ac7770564311ef9766ab3b7e81a912"
}