Skip to main content
GET
CLI

Authorizations

Authorization
string
header
required

API Key in Bearer format (e.g., Bearer sk_test_...)

Headers

X-API-Key
string

API key

Query Parameters

limit
number
default:500

Number of results to return (1-1000). Use with offset for traditional pagination.

Required range: 1 <= x <= 1000
offset
number
default:0

Number of results to skip. Use with limit for traditional pagination.

Required range: x >= 0
page_size
number
default:500

Number of results per page (1-1000). Use with starting_after for cursor-based pagination.

Required range: 1 <= x <= 1000
starting_after
string

Cursor for pagination. Use the ID of the last item from the previous page to get the next page. Use with page_size for cursor-based pagination.

id
string

Filter by transfer ID prefix (e.g. tfr_abc123)

sourceCustomerId
string

Filter by source customer ID

customerId
string

Filter by either source or destination customer ID

accountId
string
counterpartyId
string

Filter by counterparty ID

agentId
string

Filter by the agent whose key created or submitted the transfer

Example:

"agt_abc123"

agentApprovalStatus
enum<string>

Filter agent payments by owner approval state. PENDING lists drafts waiting for POST /v1/transfers/{id}/agent-approval.

Available options:
PENDING,
APPROVED,
DECLINED
clientReferenceId
string

Filter by the clientReferenceId supplied at transfer creation. Exact match. Not enforced unique — multiple transfers can share a value, so treat the result as a list.

Maximum string length: 256
Example:

"order_abc123"

flow
enum<string>
Available options:
CRYPTO_TO_CRYPTO,
CRYPTO_TO_FIAT,
FIAT_TO_CRYPTO,
FIAT_TO_FIAT,
FIAT_TO_CRYPTO_TO_FIAT,
FX,
INTERNAL,
FEE_CRYPTO,
REFUND_CRYPTO,
REFUND_FIAT
status
enum<string>

Filter by transfer status. Transfers that fail after funds are received are treated as IN_REVIEW and excluded from FAILED.

Available options:
DRAFT,
PENDING_AUTHORIZATION,
IN_REVIEW,
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED,
REVERSED
startDate
string
endDate
string
expand
enum<string>[]

Fields to expand in the response. Pass as comma-separated values or repeated query params.

Available options:
sourceAccount,
destinationAccount,
sourceCustomer,
counterparty,
documents
Example:

Response

Transfers retrieved successfully

has_more
boolean

Whether there are more results available

page_size
number

Number of results per page

url
string

URL for this request

data
object[]
page_next
string | null

URL to fetch the next page of results

page_prev
string | null

URL to fetch the previous page of results