YUyuvexpay
Payments

List payments

Changed on

Retrieve a paginated list of payments with optional filters.

get/v1/payments

Request

Query parameters

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

Possible payment statuses. FREE: a coupon discounted the whole amount and the order completed without a charge; it is terminal and cannot be refunded.

Filter by payment status. FREE lists the orders a coupon covered in full.

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.

Example response

{
  "payments": [
    {
      "coupon": {
        "code": "BLACK10"
      }
    }
  ]
}

Changes

  • 5236ef291a8eRevision changes
    • warning

      added the new FREE enum value to the // response property for the response status

    • info

      added the new enum value FREE to the query request parameter 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

    • info

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

  • 3cfd7392f4b9Revision changes
    • 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