YUyuvexpay
Withdrawals

List withdrawals

Changed on

Retrieve a paginated list of withdrawals with optional filters.

get/v1/withdrawals

Request

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).

Response

Withdrawals listed.

Example response

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

Changes

  • e1a5e956b369Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

  • 74ad5da44cf9Revision changes
    • breaking

      removed the enum value BOLETO from the query request parameter method

    • breaking

      removed the enum value CARD from the query request parameter method

    • breaking

      removed the enum value CRYPTO_LTC from the query request parameter method

    • breaking

      removed the enum value LTC from the query request parameter currency

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status