Endpoints

GET /api/v1/payments

Lista las transacciones del shop con filtros opcionales.

GET/api/v1/paymentssecret key

Lista las transacciones del shop autenticado, paginadas + filtrables. Cada tx devuelve `paymentMethodId` (el mismo id 4-dígitos que enviaste al crear) — podés usarlo como filtro para traer solo las txs de un retailer específico (ej. `?paymentMethodId=1003` para solo Walmart). El path legacy `GET /api/v1/transactions` sigue funcionando idéntico.

Body parameters

limitinteger
1–100. Default 50.
offsetinteger
Default 0.
statusstring
completed · pending · failed · refunded · expired · chargeback.
paymentMethodIdstring
Id 4-dígitos de GET /api/v1/payment-methods. Filtra al retailer / banco / método nativo exacto (ej. "1003" trae solo Walmart MEX).
countrystring
País del pagador. ISO-3 o ISO-2 indistintamente.
merchantOrderIdstring
Tu id propio guardado al crear el cobro — útil para disaster-recovery si perdés el txId.
methodstring
Legacy. Slug del bucket (pix, spei, voucher, …). Usá `paymentMethodId` para precisión por retailer.

Request

curl "https://sandbox.key2pays.com/api/v1/payments?limit=20&status=completed&paymentMethodId=1001" \
  -H "Authorization: Bearer sk_test_51N8mP...exampleK3Y"

Response

{
  "data": [
    {
      "id": "TXN-MVZQXW7B-A4F2",
      "amount": 50.00,
      "currency": "USD",
      "amountLocal": 882.17,
      "currencyLocal": "MXN",
      "paymentMethodId": "1001",
      "paymentMethod": "spei",
      "status": "completed",
      "country": "MEX",
      "fees": { "platform": 1.45, "provider": 1.50, "network": 1.50, "total": 4.45 },
      "timestamps": { "created": "2026-05-12T15:50:00Z" },
      "merchantOrderId": "ORD-12345"
    }
  ],
  "pagination": { "total": 1, "limit": 20, "offset": 0, "pages": 1 }
}

Previous · Endpoints

GET /api/v1/payments/{id}

Next · Endpoints

POST /payments/{id}/refund