Title
Page icon
Create new category
Edit page index title
Edit category
Edit link
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
Definition | Description |
|---|---|
Endpoint | https://api.paas.sandbox.co.passportfintech.com/v1/recipients/ach |
Method | POST |
Headers | Content-Type: application/json, Authorization |
Authentication | Access Token (Bearer Token) |
Request Body
Parameter | Type | Required | Constraints | Description |
|---|---|---|---|---|
customer_id | String | Yes | N/A | The unique identifier of the entity customer creating the recipient. |
alias | String | No | [0-128] | Friendly name or label for the ACH recipient (e.g., |
owner | Object | Information about the Recipient. | ||
type | String | Yes |
| Type of Recipient, allowed values: |
first_name | String | Conditional | Given name of the Recipient Required if | |
second_name | String | No | Second name of the Recipient. Optional if | |
first_last_name | String | Conditional | First last name of the Recipient. Required if | |
second_last_name | String | No | Second last name of the Recipient. Optional if | |
business_name | String | Conditional | Company legal name Required if | |
identification_type | String | Yes |
| Identification type (e.g., 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_number | String | Yes | [1,30] | The recipient's identification number. |
account | Object | Yes | Recipient accounts details. | |
account_type | String | Yes |
| ACH account type. |
account_number | String | Yes | [1-18] | ACH bank account number. |
participant | Object | Yes | Recipient bank details | |
name | String | Yes | For a comprehensive list of bank names, please refer to the section below. | Name of the bank associated with the account (case sensitive). |
Bank List
Bank Name |
|---|
BANCO AGRARIO |
BANCO AV VILLAS |
BANCO CAJA SOCIAL |
BANCO CITIBANK COLOMBIA |
ITAU BANCO CORPBANCA |
DAVIVIENDA |
BANCO DE BOGOTA |
BANCO W SA |
BANCO DE OCCIDENTE |
BANCO FINANDINA |
BANCO GNB SUDAMERIS |
BANCO MUNDO MUJER |
BANCO PICHINCHA S.A |
BANCO POPULAR |
BANCO PROCREDIT |
BANCO SANTANDER DE NEGOCIOS |
BANCOLDEX |
BANCOLOMBIA |
BANCOOMEVA |
BBVA |
CONFIAR |
BANCO COOPERATIVO COOPCENTRAL |
COTRAFA ENTIDAD FINANCIERA |
CFA FINANCIERA ANTIOQUIA |
ITAU* HELM BANK |
FINANCIERA JURISCOOOP CF |
SCOTIABANK COLPATRIA |
BANCO FALABELLA |
MIBANCO |
BANCAMIA S.A |
BANCO CREDIFINANCIERA SA |
BANCO SERFINANZA SA |
BANCO UNION |
NEQUI |
DAVIPLATA |
PIBANK |
MOVII |
COLTEFINANCIERA |
IRIS |
J.P. MORGAN COLOMBIA |
LULO BANK S.A. |
BANCO BGT PACTUAL |
UALA |
JFK COOPERATIVA FINANCIERA |
POWWI |
RAPPIPAY |
COINK |
BOLD CF |
GLOBAL66 |
NU |
DING TECNIPAGOS SA |
BNP PARIBAS COLOMBIA |
BANCO CONTACTAR S.A |
CREZCAMOS |
KOA C.F |
CREDIFAMILIA |
PAYCASH |
Example Request
Response Body
HTTP Status Code: 200 OK.
The response will contain the recipient details along with its unique identifier.
Example of Response
The response confirms the recipient has been successfully created and returns a unique recipient
idwhich is the same asrecipient_idto be used in other endpoints.For ACH transactions, there is no need for key resolution.
Common Errors and Handling
HTTP Status Code | Meaning | Description |
|---|---|---|
400 Bad Request | Invalid Data | Required fields are missing or contain incorrect values. |
401 Unauthorized | Expired Token | The access token is invalid or has expired. |
403 Forbidden | Access Denied | The request is not authorized to create a recipient. |
500 Internal Server Error | Server Error | An unexpected error occurred while creating the recipient. |
Best Practices
Ensure the
customer_idis correct and associated with a valid entity customer.Validate the recipient’s identification data before making the request.