Skip to main content

Endpoint

PUT /clients/business/payouts/{payoutAccountId}

Path parameters

payoutAccountId
string
required
The unique ID of the payout account to update.

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
Updated name on the bank account.
accountNumber
string
required
Updated bank account number.
bankName
string
required
Updated name of the bank.
bankCode
string
required
Updated bank sort code.

Response

status
boolean
true on success.
message
string
Confirmation message.

Code examples

curl -X PUT https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/payouts/PAYOUT_ID \
  -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": "9876543210",
    "bankName": "Access Bank",
    "bankCode": "044"
  }'

Example response

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