Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
Apple Pay

List Apple Pay web domains

List the web domains you have registered for Apple Pay

get/apple-pay/web-domains

Query parameters

ascendingboolean

Control the order (newest or oldest) in which the payment sessions are returned. false will arrange the results with newest first, whereas true shows oldest first. The default is false.

limitinteger
Example:10

Control how many items are return in a given page The max limit we allow is 50. The default is 20.

startsAfterstring
Example:apwd_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473

A token to identify where to resume a subsequent paginated query. The value of the paginationToken field from that response should be supplied here, to retrieve the next page of results for that timestamp range.

Headers

Accountstring
Example:ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327

The linked accountId (use this if you are processing Apple Pay directly under a sub account's registered Apple Pay domain)

Response

Successfully retrieved the Apple Pay web domains

paginationTokenstring nullable

A token to use for getting the next page of results - send the same request with this value in the 'paginationToken' query parameter. This field is null when there are no further items to return

Example response

{
  "items": [
    {
      "id": "apwd_01FCTS1XMKH9FF43CAFA4CXT3P",
      "domainName": "ryftpay.com",
      "createdTimestamp": 1631696701
    }
  ],
  "paginationToken": "apwd_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473"
}