List Recipients

Overview

This endpoint lets you get a list of all Bre-B and ACH recipients linked to an entity customer in the Passport API. The response provides details like recipient key type, key value, and associated entity customer ID.

Endpoint Details

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

This endpoint retrieves all recipients linked to an authenticated customer.

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`.

Recipient Filters

Parameter	Description
customer_id	Filters by the customer identifier associated with the recipient.
type	Filters by recipient type (for example, `INDIVIDUAL` or `BUSINESS.`
recipient_id	Filters by the unique recipient identifier.
identification_number	Filters by the recipient’s identification number.
account_number	Filters by the recipient’s account number.
account_type	Filters by the recipient’s account type (for example, savings or ordinary account, depending on supported values).

Request Body

No response body

Example Request

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

Response Body

Example of Response

JSON
    
 
{
    "pagination_info": {
        "total_elements": 1,
        "first_request_timestamp": "2025-10-10T07:51:36.8Z",
        "current_page": 1,
        "total_pages": 1
    },
    "recipients": [
        {
            "customer_id": "31eb66c3-f309-48ce-8b12-086f9e76b84c",
            "key": {
                "key_type": "PHONE",
                "key_value": "3975999158"
            },
            "type": "BREB",
            "updated_at": "2025-10-10T07:43:41.267Z",
            "created_at": "2025-10-10T07:43:41.267Z",
            "alias": "Pepito SAS5",
            "id": "daa209f9-fbdf-4f2b-aadc-db42fe16358c"
        }
    ]
}
Copy

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 recipients.
500 Internal Server Error	Server Error	An unexpected error occurred while retrieving recipients.

Best Practices

Ensure the authentication token is valid before making a request.
Listing Recipients returns both those that have been resolved, and those that have not
Store recipient IDs for use in Bre-B payments and other transactions.

Last updated on