Skip to main content
GET
/
payment-method
List payment methods
curl --request GET \
  --url https://demo.api.harmony.compago.com/api/payment-method \
  --header 'x-api-key: <api-key>'
{
  "count": 25,
  "page": 1,
  "pageSize": 100,
  "items": [
    {
      "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "status": "PENDING",
      "externalId": "<string>",
      "card": {
        "lastFourDigits": "4242",
        "networkType": "VISA"
      },
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

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 method status

Available options:
PENDING,
ACTIVE,
EXPIRED,
REVOKED

Response

Paginated list of payment methods

Paginated list of payment methods

​
count
integer
required

Total number of payment methods matching the filter criteria

Example:

25

​
page
integer
required

Current page number

Example:

1

​
pageSize
integer
required

Number of items per page

Example:

100

​
items
object[]
required

Array of payment method objects