Fetch a beneficiary

curl --request GET \
  --url https://api.paystack.com/v1/beneficiaries/{beneficiaryId} \
  --header 'Authorization: Bearer <token>'

{
  "status": true,
  "message": "Beneficiary fetched successfully",
  "code": "ok",
  "data": {
    "id": "ben_01KPBAP7WTDKQKW5B3R31VPNX4",
    "customer_id": "cust_01HXYZABC1234567890ABCDEFG",
    "name": "Alice Bank Beneficiary",
    "type": "fiat",
    "currency": "NGN",
    "details": {
      "country_code": "NG",
      "network": "bank",
      "account_number": "0039415616",
      "provider": {
        "id": "prov_01KPBAP7WTDKQKW5B3R31VPNX4",
        "name": "Access Bank",
        "code": "000014"
      },
      "account_name": "ALICE JOHNSON"
    },
    "metadata": {},
    "status": "pending",
    "created_at": "2026-04-16T16:14:08.000Z",
    "updated_at": "2026-04-16T16:14:08.000Z",
    "label": "Alice's salary account",
    "merchant_reference": "ref_01HXYZ4K5ABCDEFGHJKLMNPQRS"
  },
  "meta": {
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

Beneficiaries

Fetch a beneficiary

Returns a single beneficiary scoped to the calling merchant.

The path id is the GlobalStack external identifier (ben_…) returned by POST /v1/beneficiaries and GET /v1/beneficiaries.

Errors

400 invalid_input — beneficiary_id does not start with ben_.
404 not_found — returned for all lookup misses:
- the id does not exist;
- the beneficiary exists but belongs to a different merchant.

Example

GET /v1/beneficiaries/ben_01KPBAP7WTDKQKW5B3R31VPNX4

GET

beneficiaries

{beneficiaryId}

Fetch a beneficiary

curl --request GET \
  --url https://api.paystack.com/v1/beneficiaries/{beneficiaryId} \
  --header 'Authorization: Bearer <token>'

{
  "status": true,
  "message": "Beneficiary fetched successfully",
  "code": "ok",
  "data": {
    "id": "ben_01KPBAP7WTDKQKW5B3R31VPNX4",
    "customer_id": "cust_01HXYZABC1234567890ABCDEFG",
    "name": "Alice Bank Beneficiary",
    "type": "fiat",
    "currency": "NGN",
    "details": {
      "country_code": "NG",
      "network": "bank",
      "account_number": "0039415616",
      "provider": {
        "id": "prov_01KPBAP7WTDKQKW5B3R31VPNX4",
        "name": "Access Bank",
        "code": "000014"
      },
      "account_name": "ALICE JOHNSON"
    },
    "metadata": {},
    "status": "pending",
    "created_at": "2026-04-16T16:14:08.000Z",
    "updated_at": "2026-04-16T16:14:08.000Z",
    "label": "Alice's salary account",
    "merchant_reference": "ref_01HXYZ4K5ABCDEFGHJKLMNPQRS"
  },
  "meta": {
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

Authorizations

Authorization

string

header

required

API key issued during merchant onboarding.

Path Parameters

beneficiaryId

string

required

Pattern: [^\/#\?]+?

Response

Beneficiary fetched successfully

status

enum<boolean>

required

Available options:

true

Example:

true

message

string

required

Human-readable summary

Example:

"Beneficiary fetched successfully"

code

enum<string>

required

Available options:

ok

Example:

"ok"

data

object

required

Show child attributes