Sign in
Payments

List payments

Retrieve a paginated list of payments with optional filters.

get/v1/payments

Query parameters

status'NEW' | 'PENDING_METHOD_SELECTION' | 'PROCESSING' | 'CONFIRMED' | 'PAID' | 'CANCELLED' | 'EXPIRED' | 'REFUNDED' | 'PARTIAL_REFUND' | 'CHARGEBACK' | 'MED_FROZEN'

Possible payment statuses.

Filter by payment status.

method'PIX' | 'CARD' | 'BOLETO'

Available public payment methods.

Filter by payment method.

startDatestring date-time

Start of date range (ISO 8601).

endDatestring date-time

End of date range (ISO 8601).

minAmountnumber

Minimum payment amount.

maxAmountnumber

Maximum payment amount.

pageinteger

Page number for pagination.

limitinteger

Number of items per page (1-100).

Response

Payments listed.

Changes

Changed in 6 of the 13 revisions of this API.139

  • 9d4ba1cc037c1See the full diff
    • ●

      added the new undefined enum value to the payments/items/payer/documentType response property for the response status 200

      response-property-enum-value-added

  • bb5bf9a209572See the full diff
    • ○

      added the optional property payments/items/paidAt to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property payments/items/payer to the response with the 200 status

      response-optional-property-added

  • c1963c0f2a872See the full diff
    • ○

      added the optional property payments/items/feePassedToPayer to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property payments/items/payerFeeAmount to the response with the 200 status

      response-optional-property-added

  • a382df24e8431See the full diff
    • ●

      deleted the query request parameter externalId

      request-parameter-removed

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

  • 74ad5da44cf9114See the full diff
    • ▲

      removed the enum value CRYPTO_LTC from the query request parameter method

      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

    • ○

      removed the CRYPTO_LTC enum value from the payments/items/methodData/type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the CRYPTO_LTC enum value from the payments/items/paymentMethod response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the LTC enum value from the payments/items/currency response property for the response status 200

      response-property-enum-value-removed

  • 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