Sign in

v1

latestOpenAPI 3.0.22026-07-26128245430.3 KB
Transfers

Get all transfers

get/transfers

Query parameters

limitinteger

The number of items to return (min 1, default 10, max 100)

starting_afterstring

This is a transfer id. If this is specified, the next page that starts with a transfer right AFTER the specified transfer id on the transfer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that transfers older than the specified transfer id will be returned (shouldn't be set if ending_before is set)

ending_beforestring

This is a transfer id. If this is specified, the previous page that ends with a transfer right BEFORE the specified transfer id on the transfer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that transfers newer than the specified transfer id will be returned (shouldn't be set if starting_after is set)

tx_hashstring

The hash of the transaction

updated_after_msinteger

This is a unix timestamp in milliseconds. If this is specified, objects updated AFTER the specified timestamp will be returned

updated_before_msinteger

This is a unix timestamp in milliseconds. If this is specified, objects updated BEFORE the specified timestamp will be returned

template_idstring

A UUID that uniquely identifies a resource

This is a template id. If this is specified, the transfers with the specified template id will be returned.

state'awaiting_funds' | 'funds_received' | 'payment_submitted' | 'payment_processed' | 'in_review' | 'kyc_required' | 'kyc_in_review' | 'developer_kyb_required' | 'canceled' | 'error' | 'returned' | 'refund_in_flight' | 'refund_failed' | 'refunded' | 'undeliverable'

Filter transfers by their external state. See Transfer States for more details.

Response

List of transfers (the returned list is empty if none found)

countinteger required

The number of transfers returned