Skip to navigation

List customer withdrawals (status query)

Fallback for missed webhooks: query current status and reconcile. Filters combine (AND). from (inclusive) / to (exclusive) are ISO-8601 timestamps on createdAt. Results are newest first; pass nextCursor back as cursor for the next page.

Authentication

x-api-keystring
API Key authentication via header

Query parameters

customerIdstringOptional>=1 character
txHashstringOptional>=1 character
statusenumOptional
fromdatetimeOptional

ISO-8601; createdAt >= from

todatetimeOptional

ISO-8601; createdAt < to

limitintegerOptional1-100
cursorstringOptionalformat: "uuid"
withdrawalIdstringOptionalformat: "uuid"
idempotencyKeystringOptional1-255 characters

Response

Withdrawals
itemslist of objects
hasMoreboolean
nextCursorstring or nullformat: "uuid"

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error