Sign in

e628f892391a

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the saved credit/debit cards of a guest

This API helps you to retrieve the saved credit/debit cards of a guest at the specified center.

You must specify appropriate details for the parameters in the API request. For more information, refer to the Request Parameters table.

get/Guests/{GuestId}/CreditCardsOnFile?CenterId={CenterId}&TransactionFrom={TransactionFrom}

Path parameters

guestidstring required

Unique identifier of a guest.

Query parameters

CenterIdstring required

Mandatory Unique 32-character identifier of the center.

TransactionFrom''

Optional Indicates the source of the transaction: Web = 1, WebStore = 2, CheckWeb = 4, Mobile = 8, MobilePOS = 16.

Response

200

{"stackTrail":"paths:/Guests/{GuestId}/CreditCardsOnFile?CenterId={CenterId}&TransactionFrom={TransactionFrom}:get:responses:200:content:application/json:schema:properties:Error","oasType":"schema","type":"unknown"}
HasExpiredCardsboolean

Example response

{
  "CreditCardsOnFile": [
    {
      "Id": "bc88aeb5-5fb6-447d-9c3d-02d906fc2d90",
      "CardBrand": 3,
      "LastFour": "0002",
      "ExpirationMonth": 3,
      "ExpirationYear": 2030,
      "IsSupportedCardType": true,
      "ProcessorId": "Adyen",
      "ProcessorName": "Zenoti Payments"
    }
  ]
}