Skip to main content
GET
List recipients

Authorizations

Authorization
string
header
required

Bearer Authentication

Headers

X-BU-Version
enum<string>
default:2025-07-11

The API version to use for this request.

Available options:
2025-06-01,
2025-07-11
Example:

"2025-07-11"

X-BU-PROFILE-ID
string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

Query Parameters

sort
enum<string>

The order to sort the results

Available options:
asc,
desc
Example:

"asc"

currency
string[]

Filter by currency

cursor
string<string>

The cursor

limit
integer

The number of items to return

Example:

10

country
string
network
string[]

Filter by recipient network

category
string

Filter by recipient category

type
string[]

Filter recipient by the type

phone_number
string[]

Filter recipients by phone number

account_number
string[]

Filter recipients by account number

username
string[]

Filter recipients by username

Response

Recipients retrieved successfully

General response Values

status
enum<string>
required
Available options:
success,
error
Example:

"success"

message
string
required
Example:

"message for success"

pagination
object
required
data
object[]
required

List of recipients