Skip to main content
POST
Create an encrypted beneficiary

Authorizations

Authorization
string
header
required

A secret NorthFond business API key. Keep it on your server.

Headers

Idempotency-Key
string
required

A unique key for this logical write operation. Reuse it when retrying the exact same request.

Required string length: 8 - 255

Body

application/json
currency
string
required
Required string length: 3
Example:

"KES"

payment_method
enum<string>
required
Available options:
mobile_money,
bank_account,
buy_goods,
paybill
account_holder_name
string
required
Required string length: 1 - 160
details
object
required
external_reference
string
Required string length: 1 - 120
label
string
Maximum string length: 120

Response

Beneficiary created

id
string<uuid>
required
currency
string
required
payment_method
enum<string>
required
Available options:
mobile_money,
bank_account,
buy_goods,
paybill
account_holder_name
string
required
status
enum<string>
required
Available options:
active,
archived
created_at
string<date-time>
required
updated_at
string<date-time>
required
external_reference
string | null
label
string | null
details
object

Returned only on detail/create and redacted where sensitive.

archived_at
string<date-time> | null