Saltar al contenido principal
POST
Crear un reporte
Este endpoint te permite solicitar la generación de tipos de reporte específicos. start_date debe ser anterior a end_date; de lo contrario, la API responde 400 REPORT_RANGE_ERROR. start_date también debe ser anterior a la hora actual, excepto en los reportes AGENDA y CASHFLOW, que aceptan fechas futuras. Para los tipos de reporte distintos de TRANSACTIONS, PAYMENTS, FRAUD_TRANSACTIONS, PAYOUTS, AGENDA y CASHFLOW, el rango entre start_date y end_date es de máximo 62 días, y un rango mayor se rechaza con 400. La respuesta de este endpoint proporciona un objeto que contiene:
  • El status de la generación del reporte.
  • Un id de reporte.
Usa el ID del reporte para descargarlo con el endpoint Descargar un reporte después de que se genere.

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-Organization-Code
string
requerido

Código de la organización asociado a la solicitud.

Cuerpo

application/json
type
enum<string>
requerido

Tipo de reporte que se va a ejecutar (MAX 255; MIN 3). SETTLEMENT_PAYOUTS está disponible para los comercios que usan el nuevo motor de conciliación de Yuno.

Opciones disponibles:
PAYOUTS,
PAYMENTS,
TRANSACTIONS,
SETTLEMENTS_FEES,
RECONCILIATION_OVERVIEW,
COMMUNICATIONS,
SETTLEMENT_PAYOUTS
start_date
string<date-time>
requerido

Marca de tiempo inicial de los datos que se incluirán en la ejecución del reporte (MAX 24; MIN 24; ISO 8601). Debe ser anterior a end_date; de lo contrario, la API responde 400 REPORT_RANGE_ERROR. También debe ser anterior a la hora actual, excepto en los reportes AGENDA y CASHFLOW, que aceptan fechas futuras. Para los tipos de reporte distintos de TRANSACTIONS, PAYMENTS, FRAUD_TRANSACTIONS, PAYOUTS, AGENDA y CASHFLOW, el rango entre start_date y end_date es de 62 días como máximo; un rango más largo se rechaza con 400.

end_date
string<date-time>
requerido

Marca de tiempo final de los datos que se incluirán en la ejecución del reporte (MAX 24; MIN 24; ISO 8601). Debe ser posterior a start_date; de lo contrario, la API responde 400 REPORT_RANGE_ERROR.

user_code
string

Identificador de usuario que se asociará a la solicitud del reporte.

merchant_reference_id
string

Identificador único del reporte en el lado del comercio (MAX 255; MIN 3).

account_id
string

Identificador(es) de cuenta. Omítelo para incluir todas las cuentas. Para varias cuentas, envía una lista separada por comas. Para el reporte Settlement Payouts, se compara con el nombre de la cuenta del proveedor y, para los comercios que usan el nuevo motor de conciliación de Yuno, también con la cuenta de Yuno a través del lote de liquidación. Los proveedores cuyos payouts llegan por un endpoint separado (por ejemplo, Pagar.me) no devuelven filas cuando se filtra de esta forma.
Ejemplo: 19d28762-c714-4fb0-9ef6-4e1953ed334b, 91d82267-c714-4fb0-9ef6-4e1953ed334b

acquirer
string

Filtra el reporte de Settlements por adquirente. Acepta un solo valor (sin distinguir mayúsculas de minúsculas; por convención, en mayúsculas). Para el reporte Settlement Payouts, este filtro acepta una lista de valores separados por comas, en mayúsculas.
Ejemplo: BAC_CREDOMATIC

provider_id
string

Para el reporte Settlement Payouts, filtra las filas por proveedor. Lista separada por comas, con valores en mayúsculas.
Ejemplo: ADYEN,CIELO

payment_status
string

Estado del pago (MAX 255; MIN 3; Estado del pago). No envíes este parámetro para solicitar la creación de un reporte con todos los estados de pago. De lo contrario, indica todos los estados que quieras incluir.
Ejemplo: CREATED,READY_TO_PAY,DECLINED

payment_sub_status
string

Subestado del pago (MAX 255; MIN 3; Subestado del pago). No envíes este parámetro para solicitar la creación de un reporte con todos los subestados de pago. De lo contrario, indica todos los subestados que quieras incluir.
Ejemplo: READY_TO_PAY,PENDING_FRAUD_REVIEW,EXPIRED

payment_method
string

Tipo de método de pago seleccionado por el cliente (MAX 255; MIN 3; Métodos de pago). No envíes este parámetro para solicitar la creación de un reporte con todos los métodos de pago. De lo contrario, indica todos los métodos que quieras incluir.
Ejemplo: ADDI,ACUOTAZ,PIX

currency
string

Moneda usada para realizar el pago (MAX 3; MIN 3; ISO 4217). No envíes este parámetro para solicitar la creación de un reporte con todas las monedas. De lo contrario, indica todas las monedas que quieras incluir. Para el reporte Settlement Payouts, filtra por la moneda de liquidación (lista separada por comas).
Ejemplo: ARS,BRL,COP

country
string

País donde se debe procesar la transacción (MAX 2; MIN 2; ISO 3166-1). No envíes este parámetro para solicitar la creación de un reporte con todos los países. De lo contrario, indica todos los países que quieras incluir.
Ejemplo: AR,BR,CO

transaction_type
string

Tipo de transacción (MAX 255; MIN 3; Tipos de transacción). No envíes este parámetro para solicitar la creación de un reporte con todos los tipos de transacción. De lo contrario, indica todos los tipos de transacción que quieras incluir.
Ejemplo: PURCHASE,REFUND,VERIFY

transaction_status
string

Estado de la transacción (MAX 255; MIN 3; Estado de la transacción). No envíes este parámetro para solicitar la creación de un reporte con todos los estados de transacción. De lo contrario, indica todos los estados de transacción que quieras incluir.
Ejemplo: SUCCEEDED,CREATED,EXPIRED

updated_at_start
string<date-time>

Marca de tiempo inicial de los datos que se incluirán en la ejecución del reporte según la fecha de actualización de la operación (MAX 27; MIN 27; ISO 8601).

updated_at_end
string<date-time>

Marca de tiempo final de los datos que se incluirán en la ejecución del reporte según la fecha de actualización de la operación (MAX 27; MIN 27; ISO 8601).

columns
string

Columnas que se incluirán (solo para los reportes de Payment, Transaction o Settlement Payouts). Consulta los campos disponibles en Campos de reportes. Para el reporte Settlement Payouts, este parámetro reemplaza la selección de columnas predeterminada en lugar de ampliarla: para agregar una columna opcional, también debes incluir todas las columnas predeterminadas que quieras conservar.
Ejemplo: account_id,amount_value,card_category. Un nombre que no sea una columna del tipo de reporte elegido devuelve 400 INVALID_COLUMNS.

metadata_fields
string

Columnas que se incluirán (solo si el comercio exporta campos de metadatos). Esta opción es exclusiva de los reportes de Transaction y Settlement.

Respuesta

201

id
string
Ejemplo:

"6d905149-b388-4522-8c0a-759fed1f39da"

type
string
Ejemplo:

"PAYMENTS"

start_date
string
Ejemplo:

"2023-07-01 00:00:00 +0000 UTC"

end_date
string
Ejemplo:

"2023-07-12 00:00:00 +0000 UTC"

merchant_reference_id
string
Ejemplo:

"payments_1"

created_at
string
Ejemplo:

"2023-07-12 20:10:30.311048496 +0000 UTC"

updated_at
string
Ejemplo:

"2023-07-12 20:10:30.311048496 +0000 UTC"

expires_at
string
Ejemplo:

""

status
string
Ejemplo:

"IN_PROCESS"