Payout Destinations

List payout destinations

Lists a customer's payout destinations with the standard cursor pagination; filter with the customer_id query parameter. Returns a Page of PayoutDestination. BRL/Pix key destinations can be created and read; externally provisioned rails may still be gated.

get/payout-destinations

Request

  • Base URL
    https://developers.ozav.io/v2
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Query parameters

limitinteger

Page size.

starting_afterstring

Opaque cursor returned as next_cursor on the previous page.

customer_idstring

Filter to a single customer by its opaque ozav_cus_ id.

Response

Paginated payout destinations.

has_moreboolean required

True when more results exist beyond this page - keep paging with starting_after.

next_cursorstring nullable

Opaque cursor for the next page; pass it as starting_after. Null on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.