Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
In-Person SKUs

List all in-person SKUs

List the SKUs that are offered for in-person payments

get/in-person/skus

Query parameters

limitinteger
Example:10

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

startsAfterstring
Example:ipsku_01FCTS1XMKH9FF43CAFA4CXT3P

A token to identify the item to start querying after. This is used to get the next page of results after a previous response returned a non-null paginationToken. The value of the paginationToken field from that response should be supplied here, to retrieve the next page of results for that timestamp range.

countrystring required
Example:EU

Filter for the SKUs available in a specific country. Typically you should always use this to ensure the SKUs you attempt to order are available in the country the order is shipped to.

productIdstring
Example:ippd_01FCTS1XMKH9FF43CAFA4CXT3P

Filter for all SKUs belonging to a specific product.

Response

The resource was retrieved successfully

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": "ipsku_01FCTS1XMKH9FF43CAFA4CXT3P",
      "name": "PAX A920 Pro",
      "country": "GB",
      "totalAmount": 5000,
      "currency": "GBP",
      "status": "Available",
      "productId": "ippd_01FCTS1XMKH9FF43CAFA4CXT3P",
      "createdTimestamp": 1470989538,
      "lastUpdatedTimestamp": 1470989538
    }
  ],
  "paginationToken": "ipsku_01FCTS1XMKH9FF43CAFA4CXT3P"
}