Withdrawals

List withdrawals

Retrieve a paginated list of withdrawals with optional filters.

get/v1/withdrawals

Query parameters

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELLED'

Possible withdrawal statuses.

Filter by withdrawal status.

method'PIX'

Filter by withdrawal method. Public withdrawals currently support PIX only.

currency'BRL'

Filter by currency. Public withdrawals currently support BRL only.

startDatestring date-time

Start of date range (ISO 8601).

endDatestring date-time

End of date range (ISO 8601).

pageinteger

Page number for pagination.

limitinteger

Number of items per page (1-100).

Withdrawals listed.

{
  "withdrawals": [
    {
      "txId": "WIT1746280868443K3F9Q"
    }
  ]
}