List payout accounts

Endpoint

GET /clients/business/payouts

Headers

string

required

Your public API key.

string

required

Your API secret. Use a stl_test_... value in sandbox, stl_live_... in production.

string

required

Your business ID.

Response

boolean

true on success.

string

Human-readable outcome.

array

Array of payout account objects.

string

Unique payout account ID. Use this as payoutAccountId when updating or deleting.

string

Name on the bank account.

string

Bank account number.

string

Bank sort code.

string

Name of the bank.

string

The client account this payout account belongs to.

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 "x-api-key: stl_c8e286ca55b0123e0b05da047494f585" \
  -H "x-api-secret: stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0" \
  -H "businessId: YOUR_BUSINESS_ID"

const res = await fetch(
  "https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/payouts",
  {
    headers: {
      "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
      "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
      businessId: "YOUR_BUSINESS_ID",
    },
  }
);
const { data } = await res.json();

import requests

res = requests.get(
    "https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/payouts",
    headers={
        "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
        "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
        "businessId": "YOUR_BUSINESS_ID",
    },
)
print(res.json()["data"])

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"
    }
  ]
}

Overview

Members

Business

Virtual accounts

Funds

Bulk transfers

Disputes

Subscriptions

Payouts

Audit logs

Settings

Endpoint

Headers

Response

Code examples

Example response

​Endpoint

​Headers

​Response

​Code examples

​Example response

Endpoint

Headers

Response

Code examples

Example response