List transfers

get

https://api.fintoc.com/v2/transfers

Lists the transfers of your organization in the live or test mode of the API key used. Filter by account_id, account_number_id, direction, status, and transfer_batch_id, or by date range with since and until. The list is paginated. Use the starting_after, ending_before, and limit query parameters to page through it. The Link response header carries the URLs to navigate the pages.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

account_id

string

Identifier of the account whose transfers are returned.

account_number_id

string

Identifier of the account number whose transfers are returned.

direction

string

enum

Direction of the transfers to return. One of inbound or outbound.

Allowed:

status

array of strings

Statuses to filter by. One or more of succeeded, rejected, failed, pending, returned, return_pending, and reject_failed. Returns transfers whose status matches any of the values you provide.

status

Allowed:

since

date-time

Lower bound for the transaction date. Returns transfers with a transaction_date on or after this ISO 8601 datetime in UTC.

until

date-time

Upper bound for the transaction date. Returns transfers with a transaction_date on or before this ISO 8601 datetime in UTC.

transfer_batch_id

string

Identifier of the transfer batch to filter by. Returns the transfers that belong to this batch.

starting_after

string

Cursor that fetches the next page of transfers. Use the ID of the last transfer from the current page.

ending_before

string

Cursor that fetches the previous page of transfers. Use the ID of the first transfer from the current page.

limit

integer

Maximum number of transfers to return per page. Ranges from 1 to 300. Defaults to 30.

Responses

200List of transfers for the current mode.

400Invalid request: a query parameter is invalid.

401Invalid or missing API key.