List payment accounts

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

List payment accounts that match the query parameters.

Before you call this endpoint

  • Include an access token with either the payment-accounts.read or payment-accounts.manage scope.
  • Add query parameters to filter the results when you need a narrower result set.
  • Use the expand parameter when you want embedded resources included in the response.

What this endpoint does

The API returns the payment accounts that match the filters you send with the request. If you do not send any filters, the API returns payment accounts based on the default query behavior for this operation.

Authorization

Your access token must include at least one of these scopes:

  • payment-accounts.read
  • payment-accounts.manage
Query Params
paymentAccountIds
array of strings
paymentAccountIds
propertyIds
array of strings
propertyIds
bookingIds
array of strings
bookingIds
reservationIds
array of strings
reservationIds
payerInteractions
array of strings
payerInteractions
status
array of strings
status
targetTypes
array of strings
targetTypes
string
enum
Allowed:
date-time
date-time
paymentLinkUrls
array of strings
paymentLinkUrls
integer
Defaults to 1
integer
Defaults to 500
sort
array of strings
sort
expand
array of strings
expand
Responses

204

No payment accounts found.

400

Bad request.

401

You are unauthorized.

403

Forbidden.

404

The Request-URI could not be found.

499

Client closed request.

500

An unexpected error occurred.

503

The server is currently unavailable. Please try later.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json