Skip to main content
POST
/
beneficiary
Create beneficiary
curl --request POST \
  --url https://processor-prod.up.railway.app/beneficiary \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: <api-key>' \
  --data '
{
  "currency": "ngn",
  "identity_id": "68bf2de7196a18d7bd165ffb",
  "details": {
    "bank_code": "100004",
    "account_number": "1234567890"
  }
}
'
{
  "success": true,
  "status": 201,
  "message": "Beneficiary created successfully",
  "timestamp": "2025-09-08T20:40:35.538Z",
  "data": {
    "id": "68bf2eba196a18d7bd166184"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.bread.africa/llms.txt

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

Authorizations

​
x-service-key
string
header
required

Body

application/json
​
currency
enum<string>
required

The currency code for the beneficiary

Available options:
NGN
Example:

"ngn"

​
identity_id
string
required

The identity ID associated with this beneficiary

Example:

"68bf2de7196a18d7bd165ffb"

​
details
Nigerian Bank Account · object
required

Banking details based country

Response

201 - application/json

Beneficiary created successfully

​
success
boolean
Example:

true

​
status
integer
Example:

201

​
message
string
Example:

"Beneficiary created successfully"

​
timestamp
string<date-time>
Example:

"2025-09-08T20:40:35.538Z"

​
data
object