bank info list
GET {{baseUrl}}/bank-info
Returns a list of BankInfo
objects.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
account_type | string | If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') | |
bank_name | string | If provided, will only return BankInfo's with this bank name. | |
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
employee_id | string | If provided, will only return bank accounts for this employee. | |
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
include_deleted_data | boolean | Whether to include data that was marked as deleted by third party webhooks. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
order_by | string | Overrides the default ordering for this endpoint. | |
page_size | number | Number of results to return per page. | |
remote_fields | string | Which fields should be returned in non-normalized form. | |
remote_id | string | The API provider's ID for the given object. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"fd1e0fb5-8f92-4ec9-9f32-179cf732867d","remote_id":"123234","employee":"a3617eb4-dfe3-426f-921e-a65fc1661e10","account_number":"439291590","routing_number":"089690059","bank_name":"Chase","account_type":"SAVINGS","remote_created_at":"2021-12-06T10:11:26Z","remote_data":[{"path":"ipsum elit amet labore","data":{"aute2a":{}}},{"path":"amet quis irure eu","data":{"consectetur__c":{},"cupidatat_aca":{},"do0e":{}}}],"remote_was_deleted":true},{"id":"fd1e0fb5-8f92-4ec9-9f32-179cf732867d","remote_id":"123234","employee":"a3617eb4-dfe3-426f-921e-a65fc1661e10","account_number":"439291590","routing_number":"089690059","bank_name":"Chase","account_type":"SAVINGS","remote_created_at":"2021-12-06T10:11:26Z","remote_data":[{"path":"occaecat nulla","data":{"magna19":{},"in_0ff":{}}},{"path":"deserunt ut Lorem","data":{"dolore83a":{},"deserunt9a6":{},"aliquipb":{}}}],"remote_was_deleted":false}]}