BRbreeze
Payment Pages

List payment pages

Changed on

Returns a paginated list of payment pages. Prefer cursor pagination: pass the nextCursorToken from the previous response as cursorToken to fetch the next page; when hasMore is false you have reached the last page. offset is supported for backward compatibility but is being deprecated in favor of cursorToken. offset and cursorToken cannot be combined.

get/v1/payment_pages

Request

Query parameters

limitinteger

Number of payment pages to return per page (max 100, default 100)

offsetinteger

Number of payment pages to skip. Deprecated — use cursorToken for pagination. Cannot be combined with cursorToken.

cursorTokenstring

Value of nextCursorToken from a previous response to fetch the next page. Cannot be combined with offset.

status'UNPAID' | 'PAID' | 'EXPIRED' | 'CANCELED'

Filter by payment page status

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
    • info

      added the new optional query request parameter cursorToken

    • info

      query request parameter offset was deprecated

    • info

      added the optional property to the response with the status