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.

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
Implement Pagination if needed when dealing with large datasets.
Store recipient IDs for use in Bre-B payments and other transactions.

Last updated on