> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.redpincompany.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.redpincompany.com/_mcp/server.

# Get recipient details

GET https://sandbox.currenciesdirect.com/v2/customers/{customer_id}/recipients/{recipient_id}

Get the details of a recipient's account using the Customer ID and recipient ID as parameters. 
This call will also return details of inactive recipients.

**Authentication:** [Bearer token required](/api-guide/getting-started/authentication#oauth-20-authentication)


Reference: https://docs.redpincompany.com/api-reference/customers/api-integration/recipients/get-recipient

## Authentication

- `Authorization` header (bearer token, required) — OAuth 2.0 Bearer token authentication. This API uses OAuth 2.0 Client Credentials flow. Please refer to the [Authentication](/api-guide/getting-started/authentication#oauth-20-authentication) section for detailed information on how to obtain and use your OAuth credentials.

## Servers

- `https://sandbox.currenciesdirect.com` (Sandbox, default)
- `https://api.redpincompany.com` (Production)

## Request

### Path parameters

- `customer_id` (string, required) — The unique identifier for the customer whose recipient details you want to retrieve
- `recipient_id` (string, required) — Unique Recipient Identifier

## Response

### 200

Recipient details retrieved successfully

- `recipient_id` (string, required) — The recipient id used to identify this recipient.
- `name` (string, required) — Name of the recipient as per their bank records.
- `type` (enum, required) — Indicates the recipient type — either "Individual" or "Corporate".
  - Allowed values: `Individual`, `Corporate`
- `country` (string, required) — Recipient's Country Code in [ISO 3166-1 Alpha-3 Country Codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
- `status` (enum, required) — Status of this recipient.
  - Allowed values: `ACTIVE`, `INACTIVE`
- `email` (string, optional) — Email id to which you want to receive the communications.
- `phone_number` (string, optional) — Recipient's phone number.
- `mobile_number` (string, optional) — Recipient's mobile number.
- `client_reference_id` (string, optional) — Unique client reference to identify this recipient in future.
- `payment_reference` (string, optional) — Optional reference used by certain recipients for payment identification. If provided, include this value in the payment_reference field when creating payments to that recipient.
- `customer_own_account` (enum, optional) — Enum: [yes,no]. Added recipient is customer's own account or not.
  - Allowed values: `yes`, `no`
- `last_updated` (datetime, optional) — Last modification timestamp.
- `address` (RecipientAddress, optional)
- `recipient_bank_details` (RecipientBankDetails, optional)
- `additional_details` (GetRecipientResponseAdditionalDetails, optional) — Additional details for the recipient.

## Errors

### 400 Bad Request Error

Bad request - invalid parameters

- `code` (string, required)
- `description` (string, required) — Human-readable error description
- `type` (enum, optional) — Category or type of the error. - `VALIDATION_ERROR`: Error due to invalid input data or format - `AUTHORIZATION_ERROR`: Error related to insufficient permissions - `SYSTEM_ERROR`: Internal system or server errors - `RESOURCE_ERROR`: Error related to resource availability - `BUSINESS_ERROR`: Error related to business logic violations - `DATA_ERROR`: Error related to data inconsistencies or duplication
  - Allowed values: `VALIDATION_ERROR`, `AUTHORIZATION_ERROR`, `SYSTEM_ERROR`, `RESOURCE_ERROR`, `BUSINESS_ERROR`, `DATA_ERROR`
- `field` (string, optional)
- `details` (map from string to any, optional) — Additional details about the error
- `timestamp` (datetime, optional)

### 401 Unauthorized Error

Unauthorized - invalid authorization header

- `code` (string, required)
- `description` (string, required) — Human-readable error description
- `type` (enum, optional) — Category or type of the error. - `VALIDATION_ERROR`: Error due to invalid input data or format - `AUTHORIZATION_ERROR`: Error related to insufficient permissions - `SYSTEM_ERROR`: Internal system or server errors - `RESOURCE_ERROR`: Error related to resource availability - `BUSINESS_ERROR`: Error related to business logic violations - `DATA_ERROR`: Error related to data inconsistencies or duplication
  - Allowed values: `VALIDATION_ERROR`, `AUTHORIZATION_ERROR`, `SYSTEM_ERROR`, `RESOURCE_ERROR`, `BUSINESS_ERROR`, `DATA_ERROR`
- `field` (string, optional)
- `details` (map from string to any, optional) — Additional details about the error
- `timestamp` (datetime, optional)

### 404 Not Found Error

Recipient not found

- `code` (string, required)
- `description` (string, required) — Human-readable error description
- `type` (enum, optional) — Category or type of the error. - `VALIDATION_ERROR`: Error due to invalid input data or format - `AUTHORIZATION_ERROR`: Error related to insufficient permissions - `SYSTEM_ERROR`: Internal system or server errors - `RESOURCE_ERROR`: Error related to resource availability - `BUSINESS_ERROR`: Error related to business logic violations - `DATA_ERROR`: Error related to data inconsistencies or duplication
  - Allowed values: `VALIDATION_ERROR`, `AUTHORIZATION_ERROR`, `SYSTEM_ERROR`, `RESOURCE_ERROR`, `BUSINESS_ERROR`, `DATA_ERROR`
- `field` (string, optional)
- `details` (map from string to any, optional) — Additional details about the error
- `timestamp` (datetime, optional)

## Types

### RecipientAddress

- `address_line` (string, required) — First line of the postal address of the recipient.
- `city` (string, required) — Recipient's city, town, or village.
- `country` (string, required) — Recipient's country name.
- `state` (string, optional) — Recipient's state, country, province or a prefecture.
- `post_code` (string, optional) — Recipient's postal code, zip code or pin code.

### RecipientBankDetails

- `currency_code` (string, required) — Recipient's Currency Code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three-letter format. **Format:** Three-letter currency codes (e.g., "GBP" for UK Pound, "USD" for US Dollar)
- `bank_name` (string, required) — Name of recipient's Bank.
- `country_code` (string, required) — Country Code of the Recipient's Bank in [ISO 3166-1 alpha-3 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3). **Format:** Three-letter country codes (e.g., "GBR" for United Kingdom, "USA" for United States)
- `iban` (string, optional) — Recipient IBAN as per their bank records.
- `account_number` (string, optional) — Recipient's bank account number as per their statement.
- `swift_code` (string, optional) — Swift Code of the recipient's bank account.
- `routing_code_type` (enum, optional) — Type of routing code used to identify the recipient's bank, based on the country: * `IFSC` – Indian Financial System Code (India), * `SORT` – Sort Code (United Kingdom, Ireland), * `BRANCH` – Branch Code (generic use), * `CNAPS` – China National Advanced Payment System (China), * `ABA` – American Bankers Association Routing Number (United States), * `BSB` – Bank State Branch (Australia), * `Transit` – Transit Number (Canada). Ensure the code type is valid for the recipient's country.
  - Allowed values: `IFSC`, `SORT`, `BRANCH`, `CNAPS`, `ABA`, `BSB`, `Transit`
- `routing_code_value` (string, optional) — Routing Code of the recipient's bank account.

### GetRecipientResponseAdditionalDetails

Additional details for the recipient.

- `tax_id` (string, optional) — Tax identification number or registration number for the recipient.

## Examples

### Get Recipient Details Active Recipient

**Response**

```json
{
  "recipient_id": "743513",
  "name": "Bob Nigh",
  "type": "Individual",
  "country": "GBR",
  "status": "ACTIVE",
  "email": "bob@outlook.com",
  "phone_number": "(020)123456789",
  "mobile_number": "+44-987654321",
  "client_reference_id": "937564823645",
  "payment_reference": "5654654654",
  "customer_own_account": "no",
  "last_updated": "2019-01-21T09:27:30Z",
  "address": {
    "address_line": "3 Stable Mews, Westminster",
    "city": "London",
    "country": "United Kingdom",
    "state": "London",
    "post_code": "TW3 4DF"
  },
  "recipient_bank_details": {
    "currency_code": "USD",
    "bank_name": "NATIONAL WESTMINSTER BANK PLC",
    "country_code": "GBR",
    "iban": "GB29NWBK60161331926819",
    "account_number": "12345678",
    "swift_code": "NWBKGB2L",
    "routing_code_type": "SORT",
    "routing_code_value": "601613"
  },
  "additional_details": {
    "tax_id": "12345678"
  }
}
```

**SDK Code**

```python Get Recipient Details Active Recipient
import requests

url = "https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Get Recipient Details Active Recipient
const url = 'https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Get Recipient Details Active Recipient
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Get Recipient Details Active Recipient
require 'uri'
require 'net/http'

url = URI("https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Get Recipient Details Active Recipient
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Get Recipient Details Active Recipient
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Get Recipient Details Active Recipient
using RestSharp;

var client = new RestClient("https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Get Recipient Details Active Recipient
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Get Recipient Details Inactive Recipient

**Response**

```json
{
  "recipient_id": "999999",
  "name": "Alice Wren",
  "type": "Corporate",
  "country": "USA",
  "status": "INACTIVE",
  "email": "alice@corp.com",
  "phone_number": "(415)9876543",
  "mobile_number": "+1-4159876543",
  "client_reference_id": "CORP-56789",
  "payment_reference": "REF-999-INV",
  "customer_own_account": "no",
  "last_updated": "2022-12-01T08:15:00Z",
  "address": {
    "address_line": "100 Silicon Valley Blvd",
    "city": "San Jose",
    "country": "United States",
    "state": "California",
    "post_code": "95110"
  },
  "recipient_bank_details": {
    "currency_code": "USD",
    "bank_name": "Bank of America",
    "country_code": "USA",
    "account_number": "9876543210",
    "swift_code": "BOFAUS3N",
    "routing_code_type": "ABA",
    "routing_code_value": "026009593"
  },
  "additional_details": {
    "tax_id": "12345678"
  }
}
```

**SDK Code**

```python Get Recipient Details Inactive Recipient
import requests

url = "https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Get Recipient Details Inactive Recipient
const url = 'https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Get Recipient Details Inactive Recipient
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Get Recipient Details Inactive Recipient
require 'uri'
require 'net/http'

url = URI("https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Get Recipient Details Inactive Recipient
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Get Recipient Details Inactive Recipient
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Get Recipient Details Inactive Recipient
using RestSharp;

var client = new RestClient("https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Get Recipient Details Inactive Recipient
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/recipients/743513")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```