Skip to main content
POST
/
beneficiaries
Create a beneficiary
curl --request POST \
  --url https://prod-api.pcxpay.com/v1/beneficiaries \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "account_name": "<string>",
  "currency": "NGN",
  "country": "NG",
  "account_number": "<string>",
  "bank_code": "<string>",
  "bank_name": "<string>",
  "momo_details": {
    "phone_number": "<string>",
    "provider": "<string>"
  },
  "org_id": "<string>"
}
'
{
  "account_name": "<string>",
  "currency": "NGN",
  "country": "NG",
  "account_number": "<string>",
  "bank_code": "<string>",
  "bank_name": "<string>",
  "momo_details": {
    "phone_number": "<string>",
    "provider": "<string>"
  },
  "org_id": "<string>",
  "beneficiary_id": "<string>",
  "beneficiary_of": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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"

Body

application/json
​
account_name
string
required
​
currency
string
required

ISO 4217 currency code matching the destination country (e.g. NG → NGN, GB → GBP)

Example:

"NGN"

​
country
string
required

ISO alpha-2 country code

Example:

"NG"

​
account_type
enum<string>
required
Available options:
bank_account,
momo,
loan_client
​
account_number
string | null
​
bank_code
string | null
​
bank_name
string | null
​
momo_details
object

Required when account_type is momo.

​
org_id
string | null

Required for loan-client beneficiaries created on behalf of an organisation.

Response

Beneficiary created

​
account_name
string
required
​
currency
string
required

ISO 4217 currency code matching the destination country (e.g. NG → NGN, GB → GBP)

Example:

"NGN"

​
country
string
required

ISO alpha-2 country code

Example:

"NG"

​
account_type
enum<string>
required
Available options:
bank_account,
momo,
loan_client
​
account_number
string | null
​
bank_code
string | null
​
bank_name
string | null
​
momo_details
object

Required when account_type is momo.

​
org_id
string | null

Required for loan-client beneficiaries created on behalf of an organisation.

​
beneficiary_id
string
​
beneficiary_of
string

User ID of the beneficiary owner

​
created_at
string<date-time>
​
updated_at
string<date-time>