v1
latestOpenAPI 3.0.02026-07-224537337.5 KBList Transfers
List all transfers
get/v2/transfer
Query parameters
pagestring required
Page number of the list (default: 1)
limitstring required
Number of items per page (default: 10)
customerstring
Example:customer_123abc...
Query by Customer ID.
status'pendingFunding' | 'pendingReview' | 'fundsReceived' | 'processing' | 'succeeded' | 'undeliverable' | 'returned' | 'pendingRefundInformation' | 'failed' | 'canceled' | 'refunded' | 'unexpectedError' | 'failedPrecondition' | 'expired'
Example:succeeded
Query by Payout status. See Transfer Lifecycle for status definitions.
type'offRamp' | 'onChain' | 'onRamp' | 'microdeposit' | 'unmatchedDeposit'
Example:onRamp
Query by Payout type.
sortstring required
Example:-created
Comma-separated sort fields. Prefix with "-" for descending, "+" (or no prefix) for ascending. Allowed fields: created, updated, status, type, amount. Example: "type,-created".
Response
Example response
{
"data": [],
"pagination": {
"page": 1,
"limit": 10,
"total": 1,
"totalPages": 1
}
}