List withdrawals
Returns a paginated list of withdrawals visible to the caller. Filters: entityType, entityId, status, currency. Rows always belong to the caller mode. Uses cursor-based pagination — pass cursor from a previous response to fetch the next page. Default page size is 20, maximum 100.
Authorization
bearer In: header
Query Parameters
Filter by entity type (merchant, tenant, partner).
"merchant" | "tenant" | "partner"Filter by a specific entity ID (UUID v7).
uuidFilter by lifecycle status (pending, approved, executing, ...).
"pending" | "approved" | "rejected" | "canceled" | "executing" | "completed" | "failed"Filter by ISO 4217 currency code.
Accepted for compatibility. Withdrawals always belong to the caller mode.
"true" | "false"Pagination cursor from a previous list response.
uuidPage size. Default 20, maximum 100.
200 < value <= 100Sort by createdAt. Defaults to descending (newest first).
"asc" | "desc"Response Body
application/json
curl -X GET "https://<api-host>/v1/withdrawals"{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
"livemode": true,
"entityType": "merchant",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"amount": {
"currency": "string",
"valueMinor": 9007199254740991
},
"fundingAccountId": "2d58f397-b4d9-4f93-90cb-6efb6d145ec8",
"withdrawalChannelId": "b70bedc4-aba7-434f-96c0-7262aa261ef0",
"withdrawalMethodId": "fe4c65d7-2e82-4bec-b31e-7ddd5bc33f55",
"destination": {
"type": "bank_account",
"details": {
"property1": "string",
"property2": "string"
}
},
"fee": {
"currency": "string",
"valueMinor": 9007199254740991
},
"status": "pending",
"failureReason": "string",
"rejectionReason": "string",
"executionComment": "string",
"providerReference": "string",
"idempotencyKey": "string",
"createdAt": "string",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"approvedAt": "string",
"approvedBy": "c91bd49a-5920-43a3-b792-1660455e23bf",
"rejectedAt": "string",
"rejectedBy": "5cb42f49-c6a2-45fc-805c-4333469e59d0",
"canceledAt": "string",
"canceledBy": "d47ffd0b-7a01-4641-8922-51e4bfae50be",
"executedAt": "string",
"executedBy": "7e6bdc13-8eb5-4edc-b30c-105a6e22bfbc",
"completedAt": "string",
"updatedAt": "string",
"currency": "string"
}
],
"pagination": {
"nextCursor": "string",
"prevCursor": "string",
"hasMore": true,
"totalCount": 0
}
}Get withdrawal by ID
Returns the full details of a single withdrawal request including status, fee, destination, and audit timestamps. Returns 404 if the withdrawal does not exist or is not visible to the caller.
Get withdrawal method catalog entry by type
Returns a single catalog entry by its machine-readable `type` key (e.g. "sepa_bank_transfer"). Use this when validating a saved method or when showing details of a specific method type.