Skip to main content

​
Endpoint

POST /clients/business/payouts

​
Headers

​
Authorization
string
required
Bearer YOUR_ACCESS_TOKEN
​
SECRET_KEY
string
required
Your API secret key.
​
businessId
string
required
Your business ID.

​
Request body

​
accountName
string
required
The name on the bank account.
​
accountNumber
string
required
The bank account number.
​
bankName
string
required
The name of the bank, e.g. "Guaranty Trust Bank".
​
bankCode
string
required
The bank’s sort code, e.g. "058".

​
Response

​
status
boolean
true on success.
​
message
string
Confirmation message.

​
Code examples

curl -X POST https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/payouts \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "SECRET_KEY: YOUR_SECRET_KEY" \
  -H "businessId: YOUR_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "accountName": "Ada Lovelace",
    "accountNumber": "0123456789",
    "bankName": "Guaranty Trust Bank",
    "bankCode": "058"
  }'

​
Example response

{
  "status": true,
  "message": "Payout account created successfully"
}