Inyo

Listar Pagos

Obtenga todas las transacciones en formato paginado.

Endpoint

GET https://{FQDN}/payments?resultsPerPage={size}&page={number}

Headers:

HeaderValor
AuthorizationBearer {accessToken}

Parámetros de Consulta

ParámetroTipoPredeterminadoDescripción
resultsPerPagenumber10Número de resultados por página
pagenumber0Número de página (indexado desde cero)

Ejemplo de Solicitud

curl -X GET 'https://{FQDN}/payments?resultsPerPage=10&page=0' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs...'

Respuesta (200)

Devuelve un array de objetos de pago. Cada objeto tiene la misma estructura que la respuesta de pago individual, incluidos los campos history, transactionFees, card, billing y customer.

[
  {
    "parentPaymentId": "9a8dd6f3-...",
    "externalId": "order-12345",
    "requestedOn": "2025-01-21 17:15:14",
    "amount": 57.00,
    "currency": "USD",
    "status": "REFUNDED",
    "approved": true,
    "history": [ ... ],
    "transactionFees": [ ... ],
    "card": { ... }
  },
  {
    "parentPaymentId": "b2c3d4e5-...",
    "externalId": "order-12346",
    "requestedOn": "2025-01-22 09:30:00",
    "amount": 150.00,
    "currency": "USD",
    "status": "CAPTURED",
    "approved": true,
    "history": [ ... ],
    "card": { ... }
  }
]

Paginación

Use page y resultsPerPage para iterar por los resultados:

# Primera página
GET /payments?resultsPerPage=25&page=0

# Segunda página
GET /payments?resultsPerPage=25&page=1

Incremente page hasta que la respuesta devuelva menos resultados que resultsPerPage, lo cual indica que llegó a la última página.