Skip to main content

​
Endpoint

GET /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.

​
Response

​
status
boolean
true on success.
​
message
string
Human-readable outcome.
​
data
array
Array of payout account objects.
​
data[].id
string
Unique payout account ID. Use this as payoutAccountId when updating or deleting.
​
data[].accountName
string
Name on the bank account.
​
data[].accountNumber
string
Bank account number.
​
data[].bankCode
string
Bank sort code.
​
data[].bankName
string
Name of the bank.
​
data[].clientId
string
The client account this payout account belongs to.
​
data[].createdAt
string
ISO 8601 timestamp of when this payout account was created.

​
Code examples

curl -X GET 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"

​
Example response

{
  "status": true,
  "message": "Payout accounts retrieved successfully",
  "data": [
    {
      "id": "payout_001",
      "accountName": "Ada Lovelace",
      "accountNumber": "0123456789",
      "bankCode": "058",
      "bankName": "Guaranty Trust Bank",
      "clientId": "client_001",
      "createdAt": "2024-05-20T09:00:00.000Z"
    }
  ]
}