List withdrawals
Returns withdrawals created for the selected client. Filter the results by source account, status, or externalReference.
Authorization
Default In: header
Path Parameters
Client identifier (UUID) assigned when an onboarding case is created. It identifies the onboarding case and, once active, the client's Trade API resources. The client must belong to your partnership; anyone else's id returns 404.
uuidQuery Parameters
Maximum number of items to return (page size).
1 <= value <= 10020Cursor for the next page, from the previous response's pageInfo.endCursor.
Filter by account.
uuidFilter by status.
Allowed values
- "PENDING"
- "HELD"
- "COMPLETED"
- "CANCELED"
- "REJECTED"
Filter by your external reference.
Header Parameters
Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the X-Request-Id response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json