Saltar al contenido principal
GET
Buscar pagos
Esta solicitud lista los pagos de la cuenta enviada en el header X-Account-Code. Úsala para sincronizar pagos con un data warehouse o para construir un panel de administración. Para consultar un solo pago, usa Obtener pago por ID u Obtener pago por ID de orden del comercio.

Ventana de creación

created_at_from y created_at_to son fechas y horas obligatorias en formato RFC 3339 con desplazamiento de zona horaria, por ejemplo 2026-11-03T00:00:00Z o 2026-11-03T00:00:00-03:00. created_at_from es inclusiva y created_at_to es exclusiva, así que dos ventanas consecutivas que comparten un límite no se superponen. created_at_to debe ser posterior a created_at_from, y la ventana entre ambas es de hasta 1 día (24 horas). Una ventana más amplia responde 400 DATE_RANGE_TOO_WIDE. Para cubrir un período más largo, envía una solicitud por cada ventana de 24 horas, por ejemplo días UTC consecutivos.

Filtros

Todos los filtros son opcionales y se combinan con AND: Envía cada parámetro una sola vez, salvo status. Un parámetro que no aparece en esta página, o un filtro con un valor inválido, responde 400 INVALID_PARAMETERS.

Paginación

Las filas se ordenan por created_at ascendente. limit define el tamaño de la página, de 1 a 100, y por defecto es 50. La respuesta es un objeto con tres campos: Para leer la página siguiente, envía cursor con el valor de next_cursor sin modificar, junto con el mismo X-Account-Code y los mismos filtros de la solicitud que lo devolvió. Sigue paginando hasta que has_more sea false. Un cursor modificado, o enviado con otra cuenta u otros filtros, responde 400 INVALID_CURSOR. La paginación solo avanza.

Filas

Cada fila es un resumen del pago: id, account_id, merchant_order_id, description, country, status, sub_status, amount.value, amount.currency, payment_method.type, customer_payer.id, created_at y updated_at.
Las filas no incluyen el arreglo transactions. Obtén el pago por su id para recibir el objeto de pago completo.

Errores

Los errores usan el envoltorio con code y messages.

Autorizaciones

public-api-key
string
header
predeterminado:<Your public-api-key>
requerido
private-secret-key
string
header
predeterminado:<Your private-secret-key>
requerido

Encabezados

X-Account-Code
string<uuid>
requerido

La cuenta cuyos pagos se listan.

Parámetros de consulta

created_at_from
string<date-time>
requerido

Inicio de la ventana de creación, inclusivo (RFC 3339 con desplazamiento de zona horaria, por ejemplo 2026-11-03T00:00:00Z). La ventana entre created_at_from y created_at_to es de hasta 1 día (24 horas).

created_at_to
string<date-time>
requerido

Fin de la ventana de creación, exclusivo (RFC 3339 con desplazamiento de zona horaria). Debe ser posterior a created_at_from y como máximo 1 día (24 horas) después.

updated_at_from
string<date-time>

Solo pagos cuya última actualización es igual o posterior a esta fecha y hora (RFC 3339 con desplazamiento de zona horaria).

updated_at_to
string<date-time>

Solo pagos cuya última actualización es anterior a esta fecha y hora, exclusiva (RFC 3339 con desplazamiento de zona horaria). Debe ser posterior a updated_at_from cuando se envían ambas.

status
enum<string>[]

Estados de pago a buscar. Envía una lista separada por coma (status=SUCCEEDED,DECLINED) o repite el parámetro (status=SUCCEEDED&status=DECLINED).

Opciones disponibles:
CREATED,
READY_TO_PAY,
PENDING,
SUCCEEDED,
VERIFIED,
DECLINED,
REJECTED,
ERROR,
EXPIRED,
CANCELED,
REFUNDED,
IN_DISPUTE,
CHARGEBACK
customer_id
string<uuid>

Solo pagos de este cliente.

country
string

Solo pagos de este país (ISO 3166-1 alpha-2).

Pattern: ^[A-Z]{2}$
currency
string

Solo pagos en esta moneda (ISO 4217).

Pattern: ^[A-Z]{3}$
merchant_order_id
string

Solo pagos con este ID de orden del comercio.

limit
integer
predeterminado:50

Cantidad de pagos por página, de 1 a 100.

Rango requerido: 1 <= x <= 100
cursor
string

El next_cursor de la página anterior, sin modificar. Envíalo con el mismo X-Account-Code y los mismos filtros de la solicitud que lo devolvió.

Respuesta

200

payments
object[]
requerido

Los pagos de la página, ordenados por created_at ascendente.

next_cursor
string | null
requerido

Cursor opaco de la página siguiente. Envíalo como cursor junto con los mismos filtros. null en la última página.

has_more
boolean
requerido

true cuando existe otra página después de esta, false en la última página.