Skip to main content
GET
Fetch payout methods
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

Payout methods retrieved successfully

status
string
Example:

"success"

data
object[]
pagination
object
message
string
Example:

"Payout methods retrieved successfully"