Skip to main content
POST
/
beneficiaries
Create a beneficiary
curl --request POST \
  --url https://api.notchpay.co/beneficiaries \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "cm.mtn",
  "name": "John Doe",
  "account_number": 237680000000,
  "email": "john@example.com",
  "phone": 237680000000,
  "description": "Employé",
  "country": "CM",
  "reference": "ref_123456789"
}'
{
  "code": 201,
  "status": "Created",
  "message": "Beneficiary created successfully",
  "beneficiary": {
    "id": "ben_123456789",
    "name": "John Doe",
    "email": "john@example.com",
    "phone": 237600000000,
    "country": "CM",
    "payment_method": "pm.ndzAfIh555VCPML1",
    "created_at": "2023-01-01T12:00:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

Body

application/json
  • Option 1
  • Option 2
​
channel
string
required
Example:

"cm.mtn"

​
name
string
required
Example:

"John Doe"

​
account_number
string
required
Example:

237680000000

​
email
string
required
Example:

"john@example.com"

​
phone
string
Example:

237680000000

​
description
string
Example:

"Employé"

​
country
string
Example:

"CM"

​
reference
string
Example:

"ref_123456789"

Response

Beneficiary created

​
code
integer
required
Example:

201

​
status
string
required
Example:

"Created"

​
message
string
required
Example:

"Beneficiary created successfully"

​
beneficiary
any
required
⌘I