Skip to main content
GET
List beneficiaries

Authorizations

Authorization
string
header
required

API key (sk_test_... or sk_live_...)

Query Parameters

customer_code
string<uuid>
required

Code of the customer

rail
enum<string>

Only beneficiaries of this rail (sepa or us). Omit it to list both.

Available options:
sepa,
us
page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Items per page (max 100)

Required range: 1 <= x <= 100

Response

Beneficiary list

success
boolean
Example:

true

data
(SEPA beneficiary · object | US beneficiary (ACH) · object)[]
meta
object
pagination
object