List Accounts

Overview

This endpoint allows you to retrieve a list of all accounts associated with an entity customer within the Passport API. The response includes details such as account type, balance, and entity association.

Endpoint Details

Definition	Description
Endpoint	https://api.paas.sandbox.co.passportfintech.com/v1/accounts
Method	GET
Headers	Authorization
Authentication	Access Token (Bearer Token)

This endpoint retrieves all accounts linked to an authenticated entity.

Query Parameters

Pagination Parameters

Parameter	Description
page_params.page_size	Number of records to return per page.
page_params.page_number	Page number to retrieve.
page_params.first_request_timestamp.seconds	UTC seconds since Unix epoch (`1970-01-01T00:00:00Z`). Must be between `0001-01-01T00:00:00Z` and `9999-12-31T23:59:59Z` (inclusive).
page_params.first_request_timestamp.nanos	Nanosecond fraction (0 to 999,999,999). Must be a non-negative value and represents fractional seconds at nanosecond resolution.

Ordering Parameters

Parameter	Description
order_params.order_key	Field used to sort the results.
order_params.order_direction	Sort direction. Allowed values: `ORDER_DIRECTION_ENUM_UNSPECIFIED`, `ASC`, `DESC`.

Account Filters

Parameter	Description
customer_id	Filters by the customer identifier associated with the account.
account_id	Filters by the unique account identifier.
status	Filters by account status (for example, active, inactive)
account_type	Filters by account type (for example, savings, ordinary)
account_number	Filters by the account number.

Request Body

No request body

Example Request

JSON
    
 
curl --location --request GET 'https://api.paas.sandbox.co.passportfintech.com/v1/accounts' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data ''
Copy

Response Body

Example of Response

JSON
    
 
{
    "accounts": [
        {
            "updated_at": "2025-10-09T17:41:23.179Z",
            "pending_balance": {
                "value": "0",
                "currency": "COP"
            },
            "customer_id": "db7e89e7-59d8-4ab1-b675-a2ae52c3339e",
            "account_type": "ORDINARY",
            "status": "ACTIVE",
            "account_number": "88827643001",
            "created_at": "2025-10-09T10:40:29.966Z",
            "available_balance": {
                "value": "90000000000000000",
                "currency": "COP"
            },
            "id": "6c23f053-0e1a-46b4-b902-97ba47e351bc"
        }
    ],
    "pagination_info": {
        "first_request_timestamp": "2025-10-09T17:43:22.10Z",
        "current_page": 1,
        "total_pages": 1,
        "total_elements": 1
    }
}
Copy

The available_balance represents funds ready for use, while pending_balance reflects transactions still being processed.

Common Errors and Handling

HTTP Status Code	Meaning	Description
400 Bad Request	Invalid Request	The request is malformed or contains invalid parameters.
401 Unauthorized	Expired Token	The access token is invalid or has expired.
403 Forbidden	Access Denied	The request is not authorized to list accounts.
500 Internal Server Error	Server Error	An unexpected error occurred while retrieving accounts.

Best Practices

Ensure the authentication token is valid before making a request.
Check if needed when dealing with large data sets.
Monitor account balances to prevent insufficient funds errors in transactions.

Last updated on