Skip to main content
GET
/
v1
/
payments
List payments
curl --request GET \
  --url https://api.yuvexpay.com/v1/payments \
  --header 'Authorization: Bearer <token>'
{
  "payments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "txId": "<string>",
      "amount": 123,
      "feeAmount": 123,
      "netAmount": 123,
      "feePassedToPayer": true,
      "payerFeeAmount": 123,
      "description": "<string>",
      "metadata": {},
      "expiresAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "methodData": {},
      "paidAt": "2023-11-07T05:31:56Z",
      "payer": {
        "name": "<string>",
        "document": "<string>",
        "institutionName": "<string>",
        "institutionIspb": "<string>"
      }
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123
  }
}

Authorizations

Authorization
string
header
required

YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.

Query Parameters

status
enum<string>

Filter by payment status. Possible payment statuses.

Available options:
NEW,
PENDING_METHOD_SELECTION,
PROCESSING,
CONFIRMED,
PAID,
CANCELLED,
EXPIRED,
REFUNDED,
PARTIAL_REFUND,
CHARGEBACK,
MED_FROZEN
method
enum<string>

Filter by payment method. Available public payment methods.

Available options:
PIX,
CARD,
BOLETO
startDate
string<date-time>

Start of date range (ISO 8601).

endDate
string<date-time>

End of date range (ISO 8601).

minAmount
number

Minimum payment amount.

maxAmount
number

Maximum payment amount.

page
integer
default:1

Page number for pagination.

Required range: x >= 1
limit
integer
default:20

Number of items per page (1-100).

Required range: 1 <= x <= 100

Response

Payments listed.

payments
object[]
pagination
object