Skip to main content
GET
/
beneficiaries
/
{beneficiary_id}
Get a beneficiary by ID
curl --request GET \
  --url https://prod-api.pcxpay.com/v1/beneficiaries/{beneficiary_id} \
  --header 'Authorization: <authorization>' \
  --header 'X-Api-Key: <x-api-key>'
{
  "beneficiary_id": "<string>",
  "account_type": "bank",
  "beneficiary_of": "<string>",
  "beneficiary_type": "loan_client",
  "country": "<string>",
  "currency": "<string>",
  "fname": "<string>",
  "lname": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "momo_details": {},
  "bank_details": {},
  "loan_client_details": {},
  "external_account_id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.pcxpay.com/llms.txt

Use this file to discover all available pages before exploring further.

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 found

​
beneficiary_id
string
​
account_type
enum<string>
Available options:
bank,
momo
​
beneficiary_of
string

ID of the user who owns this beneficiary.

​
beneficiary_type
enum<string>
Available options:
loan_client,
payout_recipient
​
country
string
​
currency
string
​
fname
string
​
lname
string
​
email
string | null
​
phone_number
string | null
​
momo_details
object
​
bank_details
object
​
loan_client_details
object
​
external_account_id
string | null
​
created_at
string

ISO 8601 datetime.

​
updated_at
string

ISO 8601 datetime.