API Reference

Create beneficiary

post
https://example.com/v1/pay/beneficiaries/create

Add a new beneficiary to the organization

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Details of the beneficiary to create

string
required
length between 3 and 3

Three-letter currency code (e.g., NGN, USD)

string
required
length between 2 and 3

Country code (e.g., NG, GH, ZA, KE)

string
required
length between 10 and 10

Bank account number

string
required
length ≥ 1

Account holder's name

string
required
length ≥ 3

Bank code

string
enum
required

Payment channel type

Allowed:
string

Optional description for the beneficiary

Headers
string
required
length ≥ 1

Starks API Key for authentication

Responses

Updated 7 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago