Listar pagos

GEThttps://api.copayex.com/api/v1/payments

Parámetros de solicitud

Campo	Tipo	Ubicación	Requerido	Descripción
`pageSize`	number	Query	No	Cantidad por página.
`pageIndex`	number	Query	No	Página base 0.
`status`	string	Query	No	Estado del pago.
`dateFrom`	string (ISO8601)	Query	No	Fecha inicial.
`dateTo`	string (ISO8601)	Query	No	Fecha final.
`query`	string	Query	No	Texto libre para ítems.
`searchTerm`	string	Query	No	Búsqueda directa por referencia.

Parámetros de respuesta

La respuesta envuelve los pagos en un objeto paginado:

Campo	Tipo	Descripción
`pageIndex`	number	Índice solicitado/devuelto (base 0).
`pageSize`	number	Cantidad de registros retornados.
`total`	number	Total de pagos que cumplen el filtro actual.
`data`	Payment[]	Arreglo de pagos con la siguiente estructura:

Campos del objeto Payment:

Campo	Tipo	Descripción
`id`	number	Identificador del pago.
`amount`	number	Importe aportado.
`paymentMethod`	string	Método utilizado (por ejemplo `"mercadopago"`).
`paymentMethodId`	string	ID del pago en Mercado Pago (u otro procesador).
`paymentData`	string	Cadena serializable a JSON con metadata adicional.
`name`	string	Nombre de la persona que pagó.
`itemId`	number	ID del ítem asociado.
`item`	Item \| null	Objeto del ítem vinculado (si la API lo expone).
`issuedAt`	string (ISO8601)	Fecha y hora en que se registró el pago.
`status`	`"approved" \| "refunded"`	Estado actual del pago.

Ejemplos de solicitud

curl -G "https://api.copayex.com/api/v1/payments" \
  -H "Authorization: Bearer <client_access_token>" \
  --data-urlencode "pageIndex=0" \
  --data-urlencode "pageSize=50"

const response = await fetch("https://api.copayex.com/api/v1/payments", {
  method: "GET",
  headers: {
    Authorization: "Bearer <client_access_token>",
  },
});
 
const data = await response.json();
console.log(data);

import requests
 
headers = {
    "Authorization": "Bearer <client_access_token>"
}
 
response = requests.get(
    "https://api.copayex.com/api/v1/payments",
    params={"pageIndex": 0, "pageSize": 50},
    headers=headers,
    timeout=10,
)
response.raise_for_status()
print(response.json())

Respuesta de ejemplo

{
  "pageIndex": 0,
  "pageSize": 10,
  "total": 1,
  "data": [
    {
      "id": 1,
      "amount": 100,
      "paymentMethod": "mercadopago",
      "paymentMethodId": "133331277860",
      "paymentData": "json data",
      "name": "Santi",
      "itemId": 1,
      "issuedAt": "2025-11-10T23:16:15.000Z",
      "status": "approved",
      "item": null
    }
  ]
}

Eliminar ítem Obtener pago