Skip to main content
GET
/
payment
List payments
curl --request GET \
  --url https://demo.api.honor.compago.com/api/developer/payment \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "status": "PENDING",
      "type": "CARD_NOT_PRESENT",
      "financingMethod": "INSTALLMENTS",
      "operationCode": 10000000001,
      "amount": 1500,
      "currency": "MXN",
      "terms": 6,
      "periodicity": "MONTHLY",
      "createdAt": "2023-11-07T05:31:56Z",
      "organization": {
        "id": "11111111-2222-3333-4444-555555555555",
        "name": "Acme Store"
      },
      "cardInformation": {
        "lastFourDigits": "**89",
        "networkType": "VISA",
        "issuingBank": "Bank of Example"
      },
      "paymentDisbursement": {
        "feePercentage": 3.5,
        "promotionFeeDiscount": 0,
        "finalFeePercentageForMerchant": 3.5,
        "finalFeePercentageForManufacturer": 0,
        "promotionBusinessTake": 0,
        "feeAmount": "52.50",
        "merchantFeeAmount": "52.50",
        "manufacturerFeeAmount": "0.00",
        "merchantIvaFeeAmount": "8.40",
        "manufacturerIvaFeeAmount": "0.00",
        "totalFeeIva": "8.40",
        "promotionTakeAmount": "0.00",
        "merchantTakeAmount": "1439.10",
        "manufacturerTakeAmount": "0.00"
      },
      "transaction": {
        "bankReference": "123456789012",
        "rawResponseText": "Approved",
        "authResult": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "count": 10
  }
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
id
string<uuid>

Filter by a specific payment ID

​
status

Filter by payment status. Supports multiple values by repeating the parameter (e.g. ?status=PENDING&status=CONFIRMED).

Available options:
PENDING,
CANCELLED,
CONFIRMED,
REFUNDED
​
type

Filter by payment type. Supports multiple values.

Available options:
CARD_NOT_PRESENT,
CARD_PRESENT
​
financingMethod

Filter by financing method. Supports multiple values.

Available options:
INSTALLMENTS,
PAY_NOW
​
terms

Filter by number of installment terms (e.g. 3, 6, 12). Supports multiple values.

Required range: x >= 1
​
issuingBank

Filter by the card's issuing bank name. Supports multiple values.

​
organizationId

Filter by organization ID. Only organizations under your sales partner account are accessible. Supports multiple values.

​
createdAtFrom
string<date>

Filter payments created on or after this date (inclusive). Uses Mexico City timezone (CST/CDT).

​
createdAtTo
string<date>

Filter payments created on or before this date (inclusive). Uses Mexico City timezone (CST/CDT).

​
operationCodeSearch
string

Search by operation code (partial match)

​
q
string

Free text search. Matches against payment amount and organization name.

​
limit
integer
default:20

Number of results per page (default: 20, max: 100)

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of results to skip for pagination (default: 0)

Required range: x >= 0

Response

Paginated list of payments

Paginated list of payments

​
data
object[]
required

Array of payment objects

​
pagination
object
required

Pagination metadata