Skip to main content
GET
List transfer recipients
This endpoint takes no parameters and is not paginated. Every recipient and every one of their payment details comes back in one response. If you hold thousands of recipients, hold your own index and read individual recipients by id.

Error codes

Authorizations

Authorization
string
header
required

A secret API key, sent as Authorization: Bearer sk_test_… in sandbox or Bearer sk_live_… in live.

Response

Successful response.

id
string
required

A 26-character ULID.

Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

type
enum<string>
required
Available options:
individual,
business
displayName
string
required
relationship
string | null
required
email
string<email> | null
required
phoneNumber
string | null
required
address
object | null
required
defaultPaymentDetailId
string | null
required

A 26-character ULID.

Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

paymentDetails
object[]
required
createdAt
string<date-time>
required
Example:

"2026-08-14T09:00:00.000Z"