GET
List beneficiaries
Returns the customer’s payees, newest first. Page through them with limit and the nextToken from the previous response.

Authorizations

Authorization
string
header
required

The user's id_token from authentication — the ID token, not the access_token. The program and environment come from the token.

Path Parameters

customerId
string
required

The customer's id. It's the customerId from the signed-in user's application (the onboarding response, also returned on the customer's accounts).

Query Parameters

limit
integer
nextToken
string

From the previous page's response.

Response

Beneficiaries

success
boolean
Example:

true

data
object[]
nextToken
string

Pass to the next request to get the next page. Absent on the last page.