Skip to main content
GET
/
v1
/
recipients
/
{id}
Retrieve a recipient
curl --request GET \
  --url https://api.sandbox.busha.so/v1/recipients/{id} \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "message": "Recipient retrieved successfully",
  "data": {
    "object": "recipient",
    "id": "8014c2ee-c70f-4c72-8d9f-c8b9d708a688",
    "user_id": "b8277d1c-1bde-46ef-92ce-ebb4752eede5",
    "profile_id": "b8277d1c-1bde-46ef-92ce-ebb4752eede5",
    "currency_id": "NGN",
    "country_id": "NG",
    "type": "ngn_bank",
    "legal_entity_type": "personal",
    "owned_by_customer": true,
    "active": true,
    "created_at": "2024-05-16T13:06:31.409336+01:00",
    "updated_at": "2024-05-16T13:06:31.409336+01:00",
    "fields": [
      {
        "value": "Access Bank Nigeria",
        "display_name": "Bank Name",
        "name": "bank_name",
        "is_copyable": false,
        "is_visible": true,
        "required": true
      },
      {
        "value": "0013246052",
        "display_name": "Account Number",
        "name": "account_number",
        "is_copyable": false,
        "is_visible": true,
        "required": true
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer Authentication

Headers

​
X-BU-PROFILE-ID
string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

​
X-BU-Version
enum<string>
default:2025-07-11

The API version to use for this request.

Available options:
2025-06-01,
2025-07-11
Example:

"2025-07-11"

Path Parameters

​
id
string<uuid>
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Recipient retrieved successfully

General response Values

​
status
enum<string>
required
Available options:
success,
error
Example:

"success"

​
message
string
required
Example:

"message for success"

​
data
object
required
deprecated