Get Recipients | Redpin | Documentation

import requests
url = "https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "recipients": [
    {
      "recipient_id": "1668758",
      "name": "Bob Nighy Mashreq-13",
      "type": "Corporate",
      "country_code": "ARE",
      "nick_name": "string",
      "email": "string",
      "phone_number": "string",
      "mobile_number": "string",
      "client_reference_id": "recepient-123",
      "payment_reference": "string",
      "customer_own_account": "no",
      "address": {
        "address_line": "UMNIYATI ST",
        "city": "AL ASAYEL STREET 345",
        "state": "Dubai",
        "post_code": "1250"
      },
      "recipient_bank_details": {
        "currency_code": "AED",
        "bank_name": "MashreqBank PSC",
        "country_code": "ARE",
        "iban": "GB29NWBK60161331926819",
        "account_number": "12345678",
        "swift_code": "NWBKGB2L",
        "routing_code_type": "SORT",
        "routing_code_value": "601613"
      },
      "status": "ACTIVE",
      "last_updated": "2025-07-10T06:41:26Z",
      "additional_details": {
        "tax_id": "12345678"
      }
    }
  ],
  "meta_data": {
    "next_page": "string",
    "previous_page": "string",
    "total_pages": "26",
    "total_records": "26"
  }
}

Get the details of all active recipients for a customer.

Authentication

AuthorizationBearer

OAuth 2.0 Bearer token authentication. This API uses OAuth 2.0 Client Credentials flow. Please refer to the Authentication section for detailed information on how to obtain and use your OAuth credentials.

Path parameters

customer_idstringRequired

A unique identifier representing the customer for whom the recipient records are being retrieved.

Query parameters

pageintegerOptional>=1

The page number to retrieve. Use this to navigate through paginated results. Defaults to 1 if not specified.

limitintegerOptional>=1

The maximum number of records to return per page. Defaults to 50 if not specified.

Response

A recipient or recipients were found and their data is returned in the response body.

recipientslist of objects

Array for the recipients.

meta_dataobject

Container for metadata.

Authentication

Path parameters

Query parameters

Response

Errors