GET
/
payout
/
methods
curl --request GET \
  --url https://api-staging.stablestack.xyz/api/payout/methods \
  --header 'x-api-key: <x-api-key>'
{
"status": "success",
"data": [
{
"id": "46a75b50-4bdc-4f59-b891-602dc247effe",
"type": "WALLET",
"currency": "USDC",
"label": "usdc wallet",
"wallet_address": "0x7hj656EC7ab90b098defB751B7401B5f6d8976F",
"network": "bep20",
"created_at": "2025-05-12T15:50:31.679Z",
"updated_at": "2025-05-12T15:50:31.679Z",
"customer_id": "85b148ab-3f6b-4d55-917f-3c8de668a48e"
},
{
"id": "b6d3af87-e67f-42a2-b24a-d33f220a0d37",
"type": "BANK",
"currency": "NGN",
"account_name": "John Doe",
"account_number": "1234567890",
"bank_name": "Test Bank",
"bank_code": "000006",
"sort_code": null,
"swift_code": null,
"routing_number": null,
"iban": null,
"created_at": "2025-05-12T15:30:56.623Z",
"updated_at": "2025-05-12T15:30:56.623Z",
"customer_id": "85b148ab-3f6b-4d55-917f-3c8de668a48e"
}
],
"pagination": {
"total": 2,
"page": 1,
"limit": 10,
"totalPages": 1,
"hasNextPage": false,
"hasPreviousPage": false
},
"message": "Customer payout methods retrieved successfully"
}

Retrieves payout methods with optional filtering. Returns both merchant-owned and customer-specific methods unless filtered.

Parameters

Query Parameters

  • customer_id (optional): Filter by specific customer ID
  • type (optional): Filter by type (BANK or WALLET)
  • currency (optional): Filter by currency code
  • page (optional): Page number for pagination (default: 1)
  • limit (optional): Items per page (default: 20, max: 100)

Headers

x-api-key
string
required

Query Parameters

customer_id
string | null

Filter by specific customer ID

type
enum<string>

Filter by type (BANK or WALLET)

Available options:
BANK,
WALLET
currency
string

Filter by currency

page
integer

Page number for pagination

Required range: x >= 1
limit
integer

Number of items per page

Required range: 1 <= x <= 100

Response

200
application/json

Payout methods retrieved successfully

The response is of type object.