Create Recipient (ACH)

Overview

This endpoint allows entities to create a new ACH recipient, which can later be used only for ACH-related operations (e.g., ACH dispersions). Recipients created under this endpoint cannot be used for Bre-B payments, QR flows, or any other product.

The recipient can represent either a BUSINESS or an INDIVIDUAL, and must include the identification and account information required for ACH transfers.

Endpoint Details

DefinitionDescription
Endpointhttps://api.paas.sandbox.co.passportfintech.com/v1/recipients/ach
MethodPOST
HeadersContent-Type: application/json, Authorization
AuthenticationAccess Token (Bearer Token)

Request Body

ParameterTypeRequiredConstraintsDescription
customer_idStringYesN/AThe unique identifier of the entity customer creating the recipient.
aliasStringNo[0-128]Friendly name or label for the ACH recipient (e.g., Pepito SAS5)
recipient_typeStringYesINDIVIDUAL OR BUSINESSAllowed values: BUSINESS, INDIVIDUAL.
identification_typeStringYesCC, CE, NUIP, PPT, PEP, NIT, PAS, TDI

Identification type (e.g., NIT).

Cédula de Ciudadania: CC

Foreign Card: CE

Número Único de Identificación Persona: NUIP

Temporary Protection Permit: PPT

Special Permanence Permit: PEP

Número de Identificación Tributaria: NIT

Passport: PAS

Id Card: TDI

identification_numberStringYes[1,30]The recipient's identification number.
account_typeStringYesLOW_VALUE, ORDINARY, CHECKING, SAVINGS, or INCLUSIVE_LOW_VALUEACH account type.
account_numberStringYes[1-18]ACH bank account number.
bank_nameStringYesFor a comprehensive list of bank names, please refer to the section below.Name of the bank associated with the account.

Bank List

Bank Name
BANCAMIA S.A BANCO AGRARIO BANCO AV VILLAS BANCO BGT PACTUAL BANCO CAJA SOCIAL BANCO CITIBANK COLOMBIA BANCO CONTACTAR S.A BANCO COOPERATIVO COOPCENTRAL BANCO CREDIFINANCIERA SA BANCO DE BOGOTA BANCO DE OCCIDENTE BANCO FALABELLA BANCO FINANDINA BANCO GNB SUDAMERIS BANCO MUNDO MUJER BANCO PICHINCHA S.A BANCO POPULAR BANCO PROCREDIT BANCO SERFINANZA SA BANCO UNION BANCO W SA BANCOLDEX BANCOLOMBIA BANCOOMEVA BANCOSANTANDER DE NEGOCIOS BBVA BNP PARIBAS COLOMBIA BOLD CF CFA FINANCIERA ANTIOQUIA COINK COLTEFINANCIERA CONFIAR COTRAFA ENTIDAD FINANCIERA CREZCAMOS DAVIPLATA DAVIVIENDA DING TECNIPAGOS SA FINANCIERA JURISCOOOP CF GLOBAL66 IRIS CF ITAU BANCO CORPBANCA ITAU* HELM BANK J.P. MORGAN COLOMBIA JFK COOPERATIVA FINANCIERA LULO BANK S.A. MIBANCO MOVII NEQUI NU PIBANK POWWI RAPPIPAY SCOTIABANK COLPATRIA UALA

Example Request

JSON
Copy

Response Body

  • HTTP Status Code: 200 OK.
  • The response will contain the recipient details along with its unique identifier.

Example of Response

JSON
Copy
  1. The response indicates that the recipient has been successfully created, and it provides a unique recipient id that can be utilized for future transactions.
  2. For ACH transactions, there is no need for key resolution.

Common Errors and Handling

HTTP Status CodeMeaningDescription
400 Bad RequestInvalid DataRequired fields are missing or contain incorrect values.
401 UnauthorizedExpired TokenThe access token is invalid or has expired.
403 ForbiddenAccess DeniedThe request is not authorized to create a recipient.
500 Internal Server ErrorServer ErrorAn unexpected error occurred while creating the recipient.

Best Practices

  • Ensure the customer_id is correct and associated with a valid entity customer.
  • Validate the recipient’s identification data before making the request.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard