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

Response

Withdrawals listed.

Example response

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

Changes

Changed in 2 of the 13 revisions of this API.416

  • 74ad5da44cf9415See the full diff
    • ▲

      removed the enum value BOLETO from the query request parameter method

      request-parameter-enum-value-removed

    • ▲

      removed the enum value CARD from the query request parameter method

      request-parameter-enum-value-removed

    • ▲

      removed the enum value CRYPTO_LTC from the query request parameter method

      request-parameter-enum-value-removed

    • ▲

      removed the enum value LTC from the query request parameter currency

      request-parameter-enum-value-removed

    • ●

      removed the optional property pagination/hasMore from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property pagination/totalPages to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property withdrawals/items/currency to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property withdrawals/items/errorMessage to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property withdrawals/items/paymentMethod to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property withdrawals/items/processedAt to the response with the 200 status

      response-optional-property-added

  • c756571007571See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog