Skip to main content
GET
List payments

Authorizations

api-key
string
header
required

API key provista por Payana.

Query Parameters

Búsqueda libre (beneficiario, concepto, etc.).

Maximum string length: 50
beneficiary_reference
string

Referencia (UUID) del beneficiario. Acepta múltiples valores separados por coma.

document_reference
string

Referencia (UUID) del documento asociado. Acepta múltiples valores separados por coma.

batch_reference
string

Referencia (UUID) del lote de pagos. Acepta múltiples valores separados por coma.

payable_reference
string

Referencia (UUID) del payable asociado.

state
enum<string>

Estado de archivado del pago. Si se usa archived, el filtro status se ignora. Por defecto se listan los pagos activos.

Available options:
active,
archived
status
enum<string>

Filtra por estado del pago. Estado del pago: pending (creado, sin procesar), in_process (en procesamiento), processed (acreditado) o failed (rechazado).

Available options:
pending,
in_process,
processed,
failed
expiration_date_from
string<date>

Fecha de vencimiento desde (inclusive), formato YYYY-MM-DD.

expiration_date_to
string<date>

Fecha de vencimiento hasta (inclusive), formato YYYY-MM-DD.

tags
string

IDs de etiquetas separados por coma (ej. 1,2,3).

payment_method
string

Métodos de pago separados por coma (ej. card,banking_correspondent).

only_expenses
boolean

Si es true, devuelve únicamente pagos de gastos.

page
integer
default:1

Página (1-indexed).

Required range: x >= 1
page_size
integer
default:25

Cantidad de ítems por página.

Required range: x >= 1
sort_by
enum<string>
default:created_at

Campo de ordenamiento.

Available options:
created_at,
amount,
expiration_date,
paid_at,
beneficiary
sort_order
enum<string>
default:desc

Dirección de ordenamiento.

Available options:
asc,
desc

Response

Payments list response

items
object[]
required
total
integer
required
current_page
integer
required
page_size
integer
required
total_pages
integer
required