GET
List beneficiaries
Returns the customer’s payees — deleted ones are left out, and the order isn’t defined. Page through them with limit (1-200, default 50) and the nextToken from the previous response; there are more pages while a nextToken comes back. The list covers all the customer’s accounts, whatever their status: payees saved for a closed or blocked account are still listed. A page can come back empty and still carry a nextToken. Deleted payees are filtered out after the page is read, so a customer with a long run of deleted ones can produce a page with nothing in it. Follow the token until it is absent rather than stopping on the first empty page.
Removed: the payee’s providerId is no longer returned. It was an internal Orenda identifier with no meaning outside our systems. Nothing else about the payee changed.

Authorizations

Authorization
string
header
required

The user's access_token from authentication. 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
default:50

Page size, 1-200. Defaults to 50.

Required range: 1 <= x <= 200
nextToken
string

From the previous page's response.

Response

Beneficiaries

success
boolean
Example:

true

message
string

What happened, for display.

data
object[]
nextToken
string

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