Skip to main content
POST
List recipients

POBO error codes

Branch on errors[0].code. See Error codes for every code.

Authorizations

API-KEY
string
header
required

Your partner API key. Must carry the pobo permission.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.

Pattern: ^\d{4}-\d{2}\.\d+$

Body

application/json
page
integer

Zero-based page index. Default 0.

size
integer

Page size. Default 0, and 0 returns every recipient unpaged.

sortBy
string

field,asc|desc. createdOn,desc is recommended.

recipientType
enum<string>[]

Match any of these recipient types.

Available options:
INDIVIDUAL,
BUSINESS
paymentType
enum<string>[]

Match any of these payment types.

Available options:
BANK_ACCOUNT,
CRYPTO_WALLET
currency
string

Exact currency, case-insensitive.

Substring of first name, last name, currency, email or bank name.

Response

A page of recipients. Unwrapped.

recipients
object[]

One page of recipient objects. Deleted recipients are not listed.

totalCount
integer

Matches across all pages, not the size of this page.