Codat List Banking Accounts Example is an example object payload from Codat, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "list-banking-accounts",
"method": "GET",
"path": "/companies/{companyId}/connections/{connectionId}/data/banking-accounts",
"summary": "List accounts",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"name": "Basiq",
"example": {
"results": [
{
"id": "4811e776-6187-48d9-afee-635fb0d89d93",
"name": "Hooli Saver",
"holder": "david smith",
"type": "Debit",
"balance": {
"available": 2932.85,
"current": 2932.85
},
"identifiers": {
"type": "Account",
"number": "14293919644182",
"bankCode": "416-982"
},
"currency": "AUD",
"institution": {
"id": "AU00000",
"name": "Hooli Bank"
},
"modifiedDate": "2022-10-28T07:14:48Z",
"sourceModifiedDate": "2022-10-27T13:00:00Z",
"accountName": "Hooli Saver",
"accountHolder": "david smith",
"accountType": "Debit",
"accountNumbers": {
"type": "Account",
"number": "14293919644182",
"bankCode": "416-982"
}
},
{
"id": "736d90a5-f836-4ae0-a161-1e8056f39701",
"name": "Standard Variable Rate Home Loan",
"holder": "david smith",
"type": "Credit",
"balance": {
"available": 6940.31,
"current": 6940.31
},
"identifiers": {
"type": "Loan",
"number": "14293919644183",
"bankCode": "416-982"
},
"currency": "AUD",
"institution": {
"id": "AU00000",
"name": "Hooli Bank"
},
"modifiedDate": "2022-10-28T07:14:48Z",
"sourceModifiedDate": "2022-10-27T13:00:00Z",
"accountName": "Standard Variable Rate Home Loan",
"accountHolder": "david smith",
"accountType": "Credit",
"accountNumbers": {
"type": "Loan",
"number": "14293919644183",
"bankCode": "416-982"
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 4,
"_links": {
"current": {
"href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts?page=1&pageSize=2"
},
"self": {
"href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts"
},
"next": {
"href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Plaid",
"example": {
"results": [
{
"id": "3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB",
"name": "Plaid Silver Standard 0.1% Interest Saving",
"informalName": "Plaid Saving",
"type": "Debit",
"balance": {
"available": 200,
"current": 210
},
"identifiers": {
"type": "Depository",
"number": "1111222233331111",
"bankCode": "00021",
"maskedAccountNumber": "1111"
},
"currency": "CAD",
"institution": {
"id": "ins_100533",
"name": "American Express (CA)"
},
"modifiedDate": "2022-10-27T10:50:16Z",
"accountName": "Plaid Silver Standard 0.1% Interest Saving",
"accountType": "Debit",
"accountNumbers": {
"type": "Depository",
"number": "1111222233331111",
"bankCode": "00021",
"maskedAccountNumber": "1111"
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 1,
"_links": {
"current": {
"href": "/companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accounts?page=1&pageSize=2"
},
"self": {
"href": "/companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accounts"
}
}
}
}
]
}