Skip to main content
GET
Get a beneficiary

Headers

Authorization
string
default:NONE
required

Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.

Example:

"Bearer eyJraWQ..."

X-Api-Key
string
default:NONE
required

API key for server-to-server flows, or the literal string NONE when authenticating via JWT.

Example:

"pcx_abc123_xxxx"

Path Parameters

beneficiary_id
string
required

Response

Beneficiary object

beneficiary_id
string
account_type
enum<string>

bank — bank account (details in bank_details). momo — mobile money account (details in momo_details).

Available options:
bank,
momo
beneficiary_of
string

User ID of the beneficiary owner.

beneficiary_type
enum<string>
default:payout_recipient
Available options:
loan_client,
payout_recipient
fname
string
lname
string
email
string | null
phone_number
string | null
country
string
currency
string
bank_details
object | null
momo_details
object | null
loan_client_details
object | null
external_account_id
string | null
org_id
string | null
created_at
string<date-time>
updated_at
string<date-time>