Skip to main content
GET
List transfer recipients

Authorizations

x-api-key
string
header
required

Merchant API key (e.g., sk_live_xxx or sk_test_xxx)

Query Parameters

page
number

Page number (default: 1)

Required range: x >= 1
Example:

1

perPage
number

Items per page (default: 50)

Required range: 1 <= x <= 100
Example:

50

type
enum<string>

Filter by recipient type

Available options:
bank-account,
mobile-money

Response

Recipients retrieved successfully

status
boolean
required

Request success status

Example:

true

message
string
required

Response message

Example:

"Operation completed successfully"

data
object