Consultas y operaciones

Consulta cuentas, saldos, lotes, transacciones y mas de manera sencilla, obteniendo información detallada a través de nuestras herramientas disponibles.

URLs base del API

Productivo:

https://api.payouts.wompi.co/v1

Sandbox: Todos los endpoints estan disponibles en ambiente sandbox

https://api.sandbox.payouts.wompi.co/v1

Consultar bancos

La URL del endpoint para consultar los bancos es:

GET /banks

Consultar cuentas y saldo

La URL del endpoint para consultar los saldos de las cuentas disponibles es:

GET /accounts

En la respuesta de la consulta, dentro de los detalles de cada cuenta, el campo balanceInCents hace alusión al saldo disponible en la cuenta, expresado en centavos. Los últimos dos dígitos son los centavos.

Se pueden filtrar los registros enviando query params (parámetros de la url) opcionales en la petición:

• bankCodes: Códigos de los bancos, uno o más códigos separados por comas. por ejemplo: BANCOLOMBIA, BANCO_BOGOTA.
• status: Estado de la cuenta. Se debe enviar alguno de los siguientes valores IN_REVIEW, ACTIVE, INACTIVE.

Sandbox

En el ambiente sandbox, no se usan cuentas bancarias reales. El sistema genera automáticamente cuentas de prueba para simular los pagos.

Consultar límites

La URL del endpoint para consultar los límites es:

GET /limits

En la respuesta de la consulta, dentro de los detalles de cada cuenta, el campo dailyLimit hace alusión al límite diario, expresado en centavos. Los últimos dos dígitos son los centavos.

Consultar lotes

La URL del endpoint para consultar todos los lotes es:

GET /payouts

Se pueden filtrar los registros enviando query params (parámetros de la url) opcionales en la petición:

• status: Estado del lote, uno o más estados separados por comas. por ejemplo: PENDING, REJECTED. Los posibles valores son: PENDING, REJECTED, TOTAL_PAYMENT, PARTIAL_PAYMENT, PENDING_APPROVAL, NOT_APPROVED.
• fromDate: "Fecha desde" la que se desea filtra, con el formato YYYY-MM-DD. Por ejemplo, 2024-01-01.
• toDate: "Fecha hasta" la que se desea filtra, con el formato YYYY-MM-DD. Por ejemplo, 2024-02-01.
• reference: Referencia del lote.
• id: Id del lote.
• limit: Valor numérico opcional para limitar el número de registros a mostrar.
• page: Valor numérico opcional para paginar los registros.

Consultar un lote específico

La URL del endpoint para consultar un lote específico es:

GET /payouts/{payoutId}

Consultar transacciones de un lote

La URL del endpoint para consultar las transacciones de un lote es:

GET /payouts/{payoutId}/transactions

Se pueden filtrar los registros enviando query params (parámetros de la url) opcionales en la petición:

• status: Estado de las transacciones. Se debe enviar alguno de los siguientes valores PROCESSING, PENDING, APPROVED, FAILED, REJECTED.
• reference: Referencia de la transacción.
• accountNumber: Número de cuenta.
• payeeName: Nombre del beneficiario.
• limit: Valor numérico opcional para limitar el número de registros a mostrar.
• page: Valor numérico opcional para paginar los registros.

Consultar una transacción específica de un lote

La URL del endpoint para consultar una transacción específica de un lote es:

GET /payouts/{payoutId}/transactions/{transactionId}

Consultar transacciones de un lote por referencia

La URL del endpoint para consultar las transacciones de un lote por referencia es:

GET /transactions/{reference}

Se pueden filtrar los registros enviando query params (parámetros de la url) opcionales en la petición:

• status: Estado de la transacciones. Se debe enviar alguno de los siguientes valores PENDING, APPROVED, CANCELLED, FAILED.
• limit: Valor numérico opcional para limitar el número de registros a mostrar.
• page: Valor numérico opcional para paginar los registros.

Consultar reportes

La URL del endpoint para consultar los reportes es:

GET /reports/payouts

Los query params (parámetros de la url) que se deben enviar en la petición deben ser:

• periodicity: Periodicidad del informe. Puede ser: daily, weekly, biweekly, monthly.
• reportType: Tipo de reporte. Puede ser: payouts, transactions.
• limit: Valor numérico opcional para limitar el número de registros a mostrar.
• page: Valor numérico opcional para paginar los registros.

Descargar reporte

La URL del endpoint para obtener el CSV de un reporte es:

GET /reports/presigned_url

Los query params (parámetros de la url) que se deben enviar en la petición deben ser:

• reportExecutionId: _id del reporte.
• reportIntegration: Tipo de reporte. Puede ser payouts, merchant_reports.

Monitoreo de Disponibilidad

La URL del endpoint para consultar la disponibilidad de los servicios internos es:

GET /health

Este endpoint permite verificar el estado de salud de los servicios que componen Pagos a Terceros, tales como users, payments, notifications y afe-rules-engine.

Los servicios se clasifican en dos categorías:

• Críticos: users y payments
• Secundarios: notifications y afe-rules-engine

En la respuesta se indica:

1. status: Un estado general de Pagos a Terceros. Puede tomar uno de los siguientes valores:

• HEALTHY: Todos los servicios están operativos.
• PARTIAL_OUTAGE: Todos los servicios críticos están operativos, pero al menos un servicio secundario presenta interrupciones.
• UNHEALTHY: Al menos un servicio crítico no está operativo.

2. services: Lista de los servicios monitoreados. Cada uno incluye:

• name: Nombre del servicio.
• healthy: Indica si el servicio está disponible (true) o no (false).