Link Account

Overview

This endpoint links an existing bank Account, manually opened and approved by the Sponsor Bank, to a Customer resource on the PaaS platform. While the account must already exist in the Sponsor Bank’s core system, this call registers a unique reference in the PaaS system to enable balance inquiries and transaction operations.

The account opening process with the sponsor bank is currently manual, and Passport facilitates it with the help of our Compliance Team, this endpoint is used after this process to link the objects.

Endpoint Details

Definition	Description
Endpoint	https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/accounts
Method	POST
Headers	Content-Type: application/json, Authorization
Authentication	Access Token (Bearer Token)

Response Body

Parameter	Type	Constraints	Required	Description
entity_customer_id	UUID	-	Yes	The unique identifier of the entity customer for whom the account is being linked.
type	String	ENUM: `ORDINARY`	Yes	The type of account.
account_number	string	1-35	Yes	The bank-assigned account number, as allocated by the Sponsor Bank.

Example Request

JSON
    
 
curl --location 'https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/accounts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data '{
    "entity_customer_id": "cde52c0b-029e-47a7-b6fe-58996680611f",
    "type": "ORDINARY",
    "account_number": "8800000001"
}'
Copy

Ensure that the provided entity_customer_id is valid before making the request.

Response Body

HTTP Status Code: 200 OK.
Returns the linked account and its metadata.

Example of Response

JSON
    
 
{
    "number": "880155861",
    "type": "ORDINARY",
    "id": "9bb99e5e-5bd0-44c9-944a-d01c9d8ffe21",
    "entity_customer_id": "cde52c0b-029e-47a7-b6fe-58996680611f",
    "pending_balance": {
        "value": "0",
        "currency": "COP"
    },
    "available_balance": {
        "value": "0",
        "currency": "COP"
    }
}
Copy

The response includes account balances (pending_balance and available_balance) in COP (Colombian Pesos).

Common Error 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 an account.
500 Internal Server Error	Server Error	An unexpected error occurred while creating the account.

Best Practices

Ensure the entity_customer_id is correct and associated with a valid customer.
Use the returned account id for further transactions or queries.

Last updated on