BRbreeze
Payout Pages

List payout pages

Changed on

Returns a paginated list of payout pages. Use the nextCursorToken from the response as cursorToken in the next request to page through results. When hasMore is false, you have reached the last page.

get/v1/payout_pages

Request

Query parameters

limitinteger
cursorTokenstring
statusstring[]

Filter by payout page status. Repeat the parameter to filter by multiple statuses (e.g. status=CREATED&status=PENDING).

emailstring email
idstring

Response

Success

status'SUCCEEDED' required
hasMoreboolean
nextCursorTokenstring

Pass this value as cursorToken in the next request to fetch the next page. Absent when there are no more items.

Changes

  • 4af083d182a6Revision changes
    • warning

      added the new BREEZE_CARD enum value to the // response property for the response status

    • warning

      added the new CARTES_BANCAIRES enum value to the //// response property for the response status

    • warning

      added the new DINERS enum value to the //// response property for the response status

    • info

      added the optional property /// to the response with the status