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

Detalles del Endpoint

ParámetroDescripción
Endpointhttps://api.paas.sandbox.co.passportfintech.com/v1/payments/ach
MétodoPOST
EncabezadosContent-Type: application/json, Authorization
AutenticaciónToken de Acceso (Bearer Token)

Cuerpo de la Solicitud

ParámetroTipoRestriccionesObligatarioDescripción
account_idStringID único de la cuenta desde la cual se realizará el pago.
recipient_idStringID único del destinatario ACH que recibirá el pago.
amountObjetoDefine el valor y la moneda para la transacción.
valueStringValor a transferir.
currencyStringMoneda de la transacción. Debe ser "COP".
descriptionStringNoReferencia para el pago: campo de texto libre que permite ingresar cualquier información adicional o personalizada relacionada con la transacción.
typeint

Código usado para el tipo de transacción en diferentes escenarios según la tabla:

Dispersión:

  • Dispersión Cuenta Ahorros: 32
  • Inscripción CR Cuenta Ahorro: 33
  • Dispersión Cuenta Corriente: 22
  • Inscripción CR Cuenta Corriente: 23
  • Dispersión Depósito Electrónico: 52
  • Inscripción Depósito Electrónico: 53

La notación amount.value hace referencia al campo value dentro del objeto amount.

Ejemplo de Solicitud

JSON
Copy

Cuerpo de la Respuesta

  • Código HTTP: 200 OK
  • Retorna los datos del pago junto con su ID único.

Ejemplo de Respuesta

JSON
Copy
  1. El estado del pago será primero PENDING. Una vez que el pago se procese, cambiará a SETTLED.
  2. El id que aparece en la respuesta es el payment_id.
  3. 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 HTTPSignificadoDescripción
400 Bad RequestDatos inválidosFaltan campos requeridos o contienen valores incorrectos.
401 UnauthorizedToken inválidoEl token de acceso ha expirado o es inválido.
403 ForbiddenAcceso denegadoNo tienes permisos para crear un pago.
500 Server ErrorError del servidorError inesperado al procesar el pago.

Buenas Prácticas

  • Verifica que los campos account_id y recipient_id correspondan 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.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard