Title
Create new category
Edit page index title
Edit category
Edit link
Iniciar un Pago (ACH)
Visión General
Este endpoint permite iniciar un pago a través de la infraestructura Bre-B utilizando la API de Passport. Una solicitud exitosa crea el objeto de pago y devuelve los detalles de la transacción, incluyendo su estado y la información del destinatario.
Requisito
Destinatario (ACH) creado exitosamente previamente
Detalles del Endpoint
Parámetro | Descripción |
|---|---|
Endpoint | https://api.paas.sandbox.co.passportfintech.com/v1/payments/ach |
Método | POST |
Encabezados | Content-Type: application/json, Authorization |
Autenticación | Token de Acceso (Bearer Token) |
Cuerpo de la Solicitud
Parámetro | Tipo | Restricciones | Obligatario | Descripción |
|---|---|---|---|---|
account_id | String | Sí | ID único de la cuenta desde la cual se realizará el pago. | |
recipient_id | String | Sí | ID único del destinatario ACH que recibirá el pago. | |
amount | Objeto | Sí | Define el valor y la moneda para la transacción. | |
value | String | Sí | Valor a transferir. | |
currency | String | Sí | Moneda de la transacción. Debe ser | |
description | String | No | Referencia para el pago: campo de texto libre que permite ingresar cualquier información adicional o personalizada relacionada con la transacción. | |
type | int | Sí | Código usado para el tipo de transacción en diferentes escenarios según la tabla: Dispersión:
|
La notación amount.value hace referencia al campo value dentro del objeto amount.
Ejemplo de Solicitud
Cuerpo de la Respuesta
Código HTTP: 200 OK
Retorna los datos del pago junto con su ID único.
Ejemplo de Respuesta
El estado del pago será primero PENDING. Una vez que el pago se procese, cambiará a SETTLED.
El
idque aparece en la respuesta es elpayment_id.Cuando realizas un pago ACH, este se reflejará en la llamada GET Account. El saldo pendiente (pending_balance)se actualizará. Una vez que el pago ACH sea procesado, disminuirá el saldo pendiente y se actualizará tu saldo disponible (available_balance).
Errores Comunes y Manejo
Código HTTP | Significado | Descripción |
|---|---|---|
400 Bad Request | Datos inválidos | Faltan campos requeridos o contienen valores incorrectos. |
401 Unauthorized | Token inválido | El token de acceso ha expirado o es inválido. |
403 Forbidden | Acceso denegado | No tienes permisos para crear un pago. |
500 Server Error | Error del servidor | Error inesperado al procesar el pago. |
Buenas Prácticas
Verifica que los campos
account_idyrecipient_idcorrespondan a entidades válidas.Monitorea el estado del pago (
PENDING,SETTLED, etc.) para confirmar su procesamiento.Implementa manejo de errores en tu integración para gestionar rechazos o demoras en el procesamiento.