Payouts
Exportar payouts
Descarga un rango de payouts filtrado por fechas en CSV (por defecto) o JSON, para conciliación.
GET
Parámetros de consulta
Cota inferior inclusiva sobre
createdAt (ISO 8601). Opcional.Cota superior inclusiva sobre
createdAt (ISO 8601). Opcional.Formato de salida:
csv (por defecto) o json.endDate es un timestamp, no un día calendario: 2024-01-31 equivale a 2024-01-31T00:00:00Z y excluye ese día — para incluir el día completo, envía 2024-01-31T23:59:59Z. Cuando se envían ambas fechas, startDate debe ser anterior o igual a endDate; de lo contrario la API responde 400 Bad Request.Respuesta
La respuesta es una descarga de archivo (Content-Disposition: attachment; filename="payouts_<startDate>_<endDate>.<format>") y se transmite en streaming, por lo que mantiene un uso de memoria eficiente en rangos de fechas grandes.
format=csv (por defecto) → Content-Type: text/csv. La primera línea es la fila de encabezados, seguida de una fila por payout. Los valores se escapan según RFC 4180. Columnas, en orden:
| Columna | Descripción |
|---|---|
id | Identificador del payout. |
externalId | Tu referencia externa, si la hay. |
state | Estado actual del payout. |
onBehalfOf | Usuario/entidad para quien se hizo el payout. |
amount | Monto del payout. |
developerFee | Comisión de desarrollador aplicada, si la hay. |
currency | Moneda del payout. |
destinationType | Tipo de destino (por ejemplo, bank, crypto_wallet, qr_code). |
errorReason | Motivo de la falla, si el payout falló. |
partnerName | Nombre del partner de liquidación. |
partnerTransactionId | ID de transacción del lado del partner. |
partnerStatus | Estado del lado del partner. |
createdAt | Timestamp de creación (ISO 8601). |
updatedAt | Timestamp de última actualización (ISO 8601). |
format=json → Content-Type: application/json. Un envoltorio con las filas en data y la cantidad de registros emitidos en count.