Responses
Common Responses for the object.
Get
Get Response Parameters
Response Parameters
| Property | Description |
|---|---|
| id | Unique identifier beginning with assigned prefix followed by an autonumber |
| created_at | Datetime formatted as ISO8601 |
| account_number | Bank account account number |
| sort_code | Bank account sort code |
| account_name | Bank account customer name |
| bank_name | Name of the bank |
| customer_account | Linked customer account |
| enabled | True if an active account |
| custom_reference | Custom reference set on record |
| metadata | Returns optional, custom, metadata, if set |
Get Response Sample - Single
Response Sample
{
"bank_account":
{
"id":"BANK00003454",
"created_at":"2018-08-23T12:43:17.000Z",
"account_number":"12345678",
"sort_code":"123456",
"account_name":"Test Name",
"bank_name":"BARCLAYS BANK PLC",
"customer_account":"CUST00002352",
"enabled":true,
"custom_reference":"XYZ",
"metadata":""
}
}
Get Response Sample - Multiple
Response Sample
{
"bank_accounts": [
{
"Id": "FTBACC02888560",
"account_name": "Chris Bell",
"account_number": "31510604",
"bank_name": "BANK OF ENGLAND",
"created_at": "2022-05-12T11:19:49Z",
"custom_reference": "API POST Test",
"customer_account": "",
"enabled": true,
"sort_code": "100000",
"metadata":""
},
{
"Id": "FTBACC02888561",
"account_name": "Chris Brooke",
"account_number": "29823529",
"bank_name": "BANK OF IRELAND (UK) PLC",
"created_at": "2022-05-12T11:19:50Z",
"custom_reference": "API POST Test",
"customer_account": "",
"enabled": true,
"sort_code": "902127",
"metadata":""
}
]
}