Skip to main content
GET
/
one-time-payment
List one-time payments
curl --request GET \
  --url https://demo.api.harmony.compago.com/api/one-time-payment \
  --header 'x-api-key: <api-key>'
{
  "count": 245,
  "page": 1,
  "pageSize": 100,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "PENDING",
      "description": "<string>",
      "amount": 123,
      "currency": "MXN",
      "externalId": "<string>",
      "expiresAt": "2023-11-07T05:31:56Z",
      "redirectUrl": "<string>",
      "homepageUrl": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "billingInformation": {
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "address": {
          "addressLine": "Av. Insurgentes Sur 1234",
          "city": "Ciudad de México",
          "state": "CDMX",
          "zip": "03100"
        }
      }
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

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:
PENDING,
CONFIRMED,
CANCELLED
​
currency
enum<string>

Filter by currency

Available options:
MXN

Response

Paginated list of one-time payments

​
count
integer
required

Total number of one-time payments matching the filter criteria

Example:

245

​
page
integer
required

Current page number

Example:

1

​
pageSize
integer
required

Number of items per page

Example:

100

​
items
object[]
required

Array of one-time payment objects