Skip to main content
GET
List Payment Destinations
Returns a paginated list of payment destinations for a beneficiary, wrapped in the standard paginated envelope.

Path Parameters

string
required
Id of the parent account (e.g. acct_...).
string
required
Beneficiary id (e.g. bene_…).

Query Parameters

integer
default:"1"
Page number, starting at 1. Default 1.
integer
default:"10"
Items per page. Default 10.
array
Filter by status: active, pending, disabled.
datetime
Created-at lower bound (inclusive).
datetime
Created-at upper bound (exclusive).

Response

Returns 200 with a paginated list of payment destination objects. Account identifiers are always masked.
object[]
The payment destination objects on this page. Each item has the same masked shape as Get Payment Destination.
integer
Current page number.
integer
Items per page.
integer
Total number of items.
integer
Total number of pages.