Skip to main content
GET
/
payment-method
/
{id}
/
payment
List payments for a payment method
curl --request GET \
  --url https://demo.api.harmony.compago.com/api/payment-method/{id}/payment \
  --header 'x-api-key: <api-key>'
{
  "count": 10,
  "page": 1,
  "pageSize": 100,
  "items": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "status": "CONFIRMED",
      "amount": 123,
      "currency": "MXN",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string<uuid>
required

The unique identifier of the payment method

Query Parameters

​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
pageSize
integer
default:100

Number of items per page (max 500)

Required range: 1 <= x <= 500
​
status
enum<string>

Filter by payment status

Available options:
NOT_INITIALIZED,
PENDING,
CONFIRMED,
CANCELLED,
REFUNDED

Response

Paginated list of payments

Paginated list of payments for a payment method

​
count
integer
required

Total number of payments matching the filter criteria

Example:

10

​
page
integer
required

Current page number

Example:

1

​
pageSize
integer
required

Number of items per page

Example:

100

​
items
object[]
required

Array of payment objects