{"openapi":"3.0.0","info":{"description":"3C Digital Rest API","version":"1.0.3","title":"3C Digital Rest API","termsOfService":"","contact":{"name":"Thomas Ospelt","email":"Thomas.Ospelt@3cpayment.com"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0"},"swagger":"2.0"},"servers":[{"url":"https://uat.3cint.com:8989/digital-gateway/","description":"UAT server for testing with external partners"},{"url":"https://uat.3cint.com:8090/digital-gateway","description":"DEV server for internal testing"},{"url":"https://services.3cint.com:8989/digital-gateway/","description":"Production Server (not live yet)"}],"tags":[{"name":"Card","description":"Card management related APIs"},{"name":"Device","description":"Device management related APIs"},{"name":"Profile","description":"Wallet Profile management releated APIs"},{"name":"Security","description":"Security management related APIs"},{"name":"Wallet","description":"Wallet management related APIs"},{"name":"Transaction","description":"Transaction management releated APIs"},{"name":"PayAtTable","description":"PayAtTable management related APIs"}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"parameters":{"UserAgent":{"in":"header","name":"User-Agent","description":"Identifies the application type that is calling the endpoint.\nThis is used to identify if the endpoint is called by a bowser, app or other application","required":true,"schema":{"type":"string"}},"RequestIdentifier":{"in":"header","name":"X-Request-ID","description":"Unique message identifier. If it is not sent in the request it is generated by the DGW and returned in the Response.","required":false,"schema":{"type":"string"}},"SessionHeader":{"in":"header","name":"Authorization","description":"The session token. For this call a \"Session\" is required to access this API. The Session key needs to be requested via\nthe corresponding API call, and then used for all calls.","required":true,"schema":{"type":"string"}},"ReturnDetails":{"in":"query","name":"returnDetails","description":"If this parameter is set, in the response the data sent in the request will be returned as well.","required":false,"allowEmptyValue":false,"schema":{"type":"boolean","default":false},"x-example":false},"WalletIdentifierQuery":{"in":"query","name":"walletIdentifier","description":"The unique WalletIdentifier generated by the DGW.","required":true,"allowEmptyValue":false,"schema":{"type":"string"}},"RequesterLocationIdentifier":{"in":"query","name":"requesterLocationIdentifier","description":"The Location ID that should be used for this call.","required":false,"allowEmptyValue":false,"schema":{"type":"string"}},"RevenueCenterIdentifier":{"in":"query","name":"revenueCenterIdentifier","description":"The RevenueCenter that should be used for this call. Only used in context of Pay@Table Calls","required":false,"allowEmptyValue":false,"schema":{"type":"string"}},"WalletIdentifier":{"in":"path","name":"walletIdentifier","description":"The unique Wallet Identifier generated by the DGW.","required":true,"schema":{"type":"string"}},"CardIdentifier":{"in":"path","name":"cardIdentifier","description":"The Unique Card Identifier generated by the DGW.","required":true,"schema":{"type":"string"}},"DeviceIdentifier":{"in":"path","name":"deviceIdentifier","description":"Unique device identifier","required":true,"schema":{"type":"string"}},"ProfileIdentifier":{"in":"path","name":"profileIdentifier","description":"Unique profile identifier","required":true,"schema":{"type":"string"}},"PreferenceIdentifier":{"in":"path","name":"preferenceIdentifier","description":"Unique profile prefrerence identifier","required":true,"schema":{"type":"string"}},"CardTypeIdentifier":{"in":"path","name":"cardTypeIdentifier","description":"The cardTypeId for the transaction","required":true,"schema":{"type":"string"}},"TransactionIdentifier":{"in":"path","name":"transactionIdentifier","description":"The transactionId for the transaction","required":true,"schema":{"type":"string"}},"PaTProtocolIdentifier":{"in":"path","name":"protocol","required":true,"schema":{"type":"string","enum":["OPI","3C"]},"description":"The Pay@Table Protocol to be used\n* OPI - The OPI Pay@Table protocol\n* 3C - The 3C proprietary Pay@Table protocol based on 3CXML"},"CheckIdentifier":{"in":"path","name":"checkNum","description":"The checkNum for which the checkInfo shall be retrieved","required":true,"style":"simple","schema":{"type":"string"}}},"schemas":{"RequestCreateSession":{"title":"createSession Request Model","description":"Data required for the createSession Call","allOf":[{"$ref":"#/components/schemas/LoginRequest"},{"type":"object","required":["identifierEntryType"],"properties":{"deviceIdentifier":{"type":"string","description":"Unique __deviceIdentifier__ for a device registered to this wallet. The session will then be created for this device.\nIf no __deviveIdentifier__ is provided, a default session will be generated."},"identifierEntryType":{"type":"string","enum":["M","S","P","R"],"x-enum-varnames":["Manual","Swipe","Proximity","RFID"],"description":"This parameter describes the way the __registratonIdentifier__ has been read from an external device\nPossible values are\n* M - Manual entry\n* S - Magnetic Stripe read\n* R - RFID Card read\n* P - Proximity Wallet read (e.g. Apple VAS)"},"sessionTimeout":{"type":"integer","format":"int32","description":"Time in seconds this session should be valid for. If no __sessionTimeout__ is provided a default timeout will be used.\nThe timeout in this case depends on the default settings defined for schema this wallet is linked to."}}}]},"RequestCreateWallet":{"title":"createWallet Request Model","description":"Data Object Model for a createWallet request","type":"object","allOf":[{"$ref":"#/components/schemas/Walletholder"},{"$ref":"#/components/schemas/Login"},{"$ref":"#/components/schemas/LoginRequest"},{"$ref":"#/components/schemas/Authentication"}]},"RequestCreateWalletAIO":{"title":"createWalletAIO Request Model","description":"Data Object Model for a createWalletAIO request","allOf":[{"$ref":"#/components/schemas/Walletholder"},{"$ref":"#/components/schemas/Login"},{"$ref":"#/components/schemas/LoginRequest"},{"$ref":"#/components/schemas/Authentication"},{"type":"object","required":["devices","profiles"],"properties":{"devices":{"type":"array","description":"List of devices that should be used with this wallet","items":{"$ref":"#/components/schemas/DeviceBase"},"minItems":1,"uniqueItems":true},"profiles":{"type":"array","description":"List of profiles that should be used with this wallet","items":{"$ref":"#/components/schemas/ProfileBase"},"minItems":1,"uniqueItems":true}}}]},"RequestRecoverPassword":{"title":"recoverPasswordRequestDTO","description":"Data Object Model for a recoverPassword request","type":"object","allOf":[{"$ref":"#/components/schemas/Login"},{"type":"object","required":["authenticationCode"],"properties":{"authenticationCode":{"type":"string","description":"Authentication code received by choosen type (email, sms,...)"},"newPassword":{"type":"string","description":"New password for wallet"}}}]},"RequestUpdateWallet":{"title":"updateWalletRequestDTO","description":"Data Object Model for a updateWallet request","type":"object","allOf":[{"$ref":"#/components/schemas/Walletholder"},{"$ref":"#/components/schemas/Authentication"}]},"RequestTransactionBase":{"title":"RequestTransactionBaseDTO Moodel","description":"Base data required for any transacton request","type":"object","required":["requesterLocationIdentifier"],"properties":{"requesterLocationIdentifier":{"description":"The Location for which this transaction has to be processed","type":"string"},"requesterTransactionReferenceNumber":{"description":"A transaction reference identifier provided by the requester","type":"string"},"timestamp":{"description":"Transaction creation timestamp in format \"YYYYMMDDHHMMSS\"","type":"string","pattern":"^(2\\d\\d\\d)(0\\d|1[0-2])([0-2]\\d|3[0-1])([0-1]\\d|2[0-4])([0-5]\\d)([0-5]\\d)$"}}},"RequestBasePaT":{"title":"PaTRequestBaseDTO Moodel","description":"Base data required for any PayAtTable request","allOf":[{"$ref":"#/components/schemas/RequestTransactionBase"},{"type":"object","required":["walletIdentifier"],"properties":{"walletIdentifier":{"description":"the ID of the wallet that should be linked to this transaction","type":"string"},"waiterIdentifier":{"description":"The WaiterId this operation should be triggered for. \nIf not definde the default WaiterId defined on the Wallet Scheme/Prodouct will be used","type":"string"},"revenueCenterIdentifier":{"description":"The RevenueCenterId on which this operation should be triggered on\nIf not definde the default RevenueCenterId defined on the Wallet Scheme/Prodouct will be used","type":"string"},"terminalIdentifier":{"description":"The TerminalId for which this operation should be triggered on\nIf not definde the default TerminalId defined on the Wallet Scheme/Prodouct will be used "}}}]},"RequestGenerateTransactionQR":{"title":"generateTransactionQrRequestDTO","description":"Data Object Model for a generateTransactionQr request","allOf":[{"$ref":"#/components/schemas/RequestTransactionBase"},{"$ref":"#/components/schemas/UserData"},{"$ref":"#/components/schemas/TransactionAmounts"}]},"RequestInitiateTransaction":{"title":"initiateTransactionRequestDTO","description":"Data Object Model for a initiateTransaction request","allOf":[{"$ref":"#/components/schemas/RequestTransactionBase"},{"$ref":"#/components/schemas/UserData"},{"$ref":"#/components/schemas/TransactionAmounts"},{"type":"object","properties":{"operationType":{"type":"string","description":"The operation to be performed for this transaction. Can be one of the following"},"callbackUrl":{"type":"string","description":"The callback url, where updates for this transaction will be sent to"}}}]},"RequestFindTransaction":{"title":"generateTransactionQrRequestDTO","description":"Data Object Model for a generateTransactionQr request","allOf":[{"$ref":"#/components/schemas/RequestTransactionBase"},{"$ref":"#/components/schemas/UserData"},{"$ref":"#/components/schemas/TransactionAmounts"}]},"RequestOpenCheck":{"title":"openCheckRequestDTO","description":"Data Object Model for a openCheck request","type":"object","allOf":[{"$ref":"#/components/schemas/RequestBasePaT"},{"type":"object","properties":{"guestCount":{"description":"Number of Guest present Table represented by this check","type":"integer","format":"int32"},"checkType":{"description":"Future Use - Identify the type of the check to be openend","type":"string","enum":["Dine In","Eat Out"]},"tableRef":{"description":"Number of the table of the check","type":"string"}}}]},"RequestPayAllChecks":{"title":"payAllChecksRequestDTO","description":"Data Object Model for a payAllChecks request","allOf":[{"$ref":"#/components/schemas/RequestBasePaT"},{"$ref":"#/components/schemas/TransactionAmounts"},{"type":"object","properties":{"cardIdentifier":{"description":"The cardIdentifier for the card that should be used to perform the payment.\nIf not provided the default card stored in the wallet will be used."}}}]},"ResponseGetCheck":{"title":"PaTCheckInfoResponseDTO","description":"a list of checks corresponding to the checks requested","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"type":"object","properties":{"checks":{"type":"array","items":{"$ref":"#/components/schemas/PaTCheck"},"minItems":1}}}]},"ResponseLinkCheck":{"title":"linkCheckResponseDTO","description":"Data Object Model for a linkCheck response","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"$ref":"#/components/schemas/PaTCheck"}]},"RequestPayCheck":{"title":"payCheckRequestDTO","description":"Data Object Model for a payCheck request","allOf":[{"$ref":"#/components/schemas/RequestBasePaT"},{"$ref":"#/components/schemas/TransactionAmounts"},{"type":"object","properties":{"cardIdentifier":{"type":"string","description":"The cardIdentifier for the card that should be used to perform the payment.\nIf not provided the default card stored in the wallet will be used."}}}]},"ResponseCreateSession":{"title":"CreateSessionResponse DTO Model","description":"Data Object Model for a createSession response","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"type":"object","required":["sessionTimeout"],"properties":{"sessionTimeout":{"type":"integer","format":"int32","description":"Session timeout that has been used to generate the session (in seconds)"},"walletIdentifier":{"type":"string","description":"The unique __walletIdentifier__ linked to the __registrationIdentifier__.\nThis value should be stored by the caller, as it needs to be used for all consecutive calls."}}}]},"ResponseCreateWallet":{"title":"CreateWalletResponse DTO Model","description":"Data Object Model for a createWallet response","type":"object","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"$ref":"#/components/schemas/Walletholder"},{"$ref":"#/components/schemas/Authentication"},{"$ref":"#/components/schemas/Login"},{"type":"object","required":["walletIdentifier","authenticationRequired"],"properties":{"walletIdentifier":{"type":"string","description":"Unique wallet identifier generated by the DGW"},"authenticationRequired":{"type":"boolean","description":"Flag telling if Authentication (step) is required."}}}]},"ResponseCreateWalletAIO":{"title":"createWalletAIOResponseDTO","description":"Data Object Model for a createWalletAIO response","type":"object","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"$ref":"#/components/schemas/Walletholder"},{"type":"object","properties":{"walletIdentifier":{"type":"string","description":"Unique wallet identifier generated by the DGW"},"authenticationRequired":{"type":"boolean","description":"Flag telling if Authentication (step) is required."},"devices":{"type":"array","description":"List of devices linked to that wallet","items":{"$ref":"#/components/schemas/Device"}},"profiles":{"type":"array","description":"List of Profiles linked to that wallet","items":{"$ref":"#/components/schemas/Profile"}}}}]},"ResponseGetWalletDetails":{"title":"getWalletDetailsResponseDTO","description":"Data Object Model for a getWalletDetails response","type":"object","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"$ref":"#/components/schemas/Walletholder"},{"type":"object","properties":{"authenticationRequired":{"type":"boolean","description":"Flag telling if Authentication (step) is required."},"registrationIdentifier":{"type":"string","description":"Unique registration identifier (provided by merchant/integrator/user)"},"devices":{"type":"array","description":"Devices List","items":{"$ref":"#/components/schemas/Device"}},"profiles":{"type":"array","description":"Profiles List","items":{"$ref":"#/components/schemas/Profile"}},"cards":{"type":"array","description":"Cards List","items":{"$ref":"#/components/schemas/CardMasked"}}}}]},"ResponseAuthenticateWallet":{"title":"authenticateWalletResponseDTO","description":"Data Object Model for a authenticateWallet response","type":"object","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"type":"object","properties":{"walletStatus":{"type":"string","enum":["C","A","I","T","L","D"],"description":"The current status of the wallet. Can be one of the following values\n* C - created\n* A - authenticated\n* I - initialized\n* T - transact\n* L - locked \n* D - deleted"}}}]},"ResponseAddCard":{"title":"addCardResponseDTO","description":"Data Object Model for a addCard response","type":"object","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"$ref":"#/components/schemas/CardMasked"}]},"ResponseGetCards":{"title":"GetCards response DTO","description":"Data Object Model for a getCards response","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"type":"object","properties":{"cards":{"type":"array","description":"List of cards linked to the wallet","items":{"$ref":"#/components/schemas/CardMasked"}}}}]},"ResponseGetCardDetails":{"title":"getCardDetailsResponseDTO","description":"Data Object Model for a getCardDetails response","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"$ref":"#/components/schemas/CardMasked"}]},"ResponseGetDevices":{"title":"getDevicesResponseDTO","description":"Data Object Model for a getDevices response","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"type":"object","properties":{"devices":{"type":"array","description":"Devices List","items":{"$ref":"#/components/schemas/Device"}}}}]},"ResponseGetDevice":{"title":"getDeviceResponseDTO","description":"Data Object Model for a getDevice response","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"$ref":"#/components/schemas/Device"}]},"ResponseGetProfile":{"title":"createProfileResponseDTO","description":"Data Object Model for a createProfile response","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"$ref":"#/components/schemas/Profile"}]},"ResponseGetProfiles":{"title":"getAllProfilesResponseDTO","description":"Data Object Model for a getAllProfiles response","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"type":"object","properties":{"profiles":{"type":"array","description":"All __Profiles__ that are linked to that wallet","items":{"$ref":"#/components/schemas/Profile"}}}}]},"ResponseGetProfilePreference":{"title":"addProfilePreferenceResponseDTO","description":"Data Object Model for a addProfilePreference response","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"$ref":"#/components/schemas/ProfilePreference"}]},"ResponseGetProfilePreferences":{"title":"createProfileResponseDTO","description":"Data Object Model for a createProfile response","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"type":"object","properties":{"profilePreferences":{"type":"array","description":"List of profile preferences linked to the profile specified","items":{"$ref":"#/components/schemas/ProfilePreference"}}}}]},"ResponseInitiateTransaction":{"title":"initiateTransactionResponseDTO","description":"Data Object Model for a initiateTransaction response","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"type":"object","required":["transactionIdentifier"],"properties":{"transactionIdentifier":{"type":"string","description":"Unique transaction Id generated by the DigitalGateway."}}}]},"ResponseGenerateTransactionQr":{"title":"generateTransactionQrResponseDTO","description":"Data Object Model for a generateTransactionQr response","allOf":[{"$ref":"#/components/schemas/ResponseInitiateTransaction"},{"type":"object","required":["transactionQrRaw"],"properties":{"transactionQrRaw":{"type":"string","description":"Raw Data to generate a QR code for this transaction."},"transactionQrLow":{"type":"string","description":"URL that points to a low res image of the QR code for this transaction"},"transactionQrMed":{"type":"string","description":"URL that points to a medium res image of the QR code for this transaction"},"transactionQrHi":{"type":"string","description":"URL that points to a high res image of the QR code for this transaction"}}}]},"ResponseOpenCheck":{"title":"openCheckResponseDTO","description":"Data Object Model for a openCheck response","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"$ref":"#/components/schemas/PaTCheck"}]},"ResponseGetAllChecks":{"title":"getAllChecksResponseDTO","description":"Data Object Model for a getAllChecks response","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"type":"object","properties":{"checks":{"type":"array","items":{"$ref":"#/components/schemas/PaTCheck"}}}}]},"ResponsePayAllChecks":{"title":"payAllChecksResponseDTO","description":"Data Object Model for a payAllChecks response","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"type":"object","properties":{"transactionResponses":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ResponseTransactionBase"}]}},"checkBalance":{"$ref":"#/components/schemas/Amount"}}}]},"ResponsePayCheck":{"title":"payCheckResponseDTO","description":"Data Object Model for a payCheck response","allOf":[{"$ref":"#/components/schemas/ResponseTransactionBase"},{"$ref":"#/components/schemas/PaTCheck"},{"type":"object","properties":{"checkAmountDue":{"$ref":"#/components/schemas/Amount"},"checkOperation":{"$ref":"#/components/schemas/ResponseBase"}}}]},"ResponseBase":{"title":"BaseResponseDTO Model","description":"DataSent that is returned in every Response by the digital Gateway","type":"object","required":["resultCode"],"properties":{"resultCode":{"type":"string","description":"Result code of the operation. The result code us usually a 2 character Code.\n\n| resultCode | Description   |\n| ---------- | ------------- |\n| 00         | OK / Approved |\n| 05         | Declined      |\n| XE         | Internal Error |"},"resultMessage":{"type":"string","description":"Text further describing the result of the operation"},"errors":{"type":"array","description":"List of Strings further describing issues in case of Error","items":{"type":"string"}}}},"ResponseTransactionBase":{"title":"BaseTransactionResponseDTO Model","description":"DataSent that is returned in every Response by the digital Gateway","allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"$ref":"#/components/schemas/PrintData"},{"$ref":"#/components/schemas/TransactionAmounts"},{"$ref":"#/components/schemas/CardMasked"},{"type":"object","properties":{"transactionIdentifier":{"type":"string","description":"Unique transaction Id generated by the DigitalGateway."},"requesterLocationIdentifier":{"type":"string","description":"The Location for which this transaction has to be processed."},"requesterTransactionReferenceNumber":{"type":"string","description":"A transaction reference identifier provided by the requester."},"amountAuthorized":{"$ref":"#/components/schemas/Amount"},"bankAuthCode":{"type":"string","description":"The Authorization Code for the transaction received by the Bank"},"bankResultCode":{"type":"string","description":"The Result code received by the bank for this transaction"},"bankResultMessage":{"type":"string","description":"A message received from the bank describing the transaction result"},"transactionResult":{"type":"string","enum":["A","R","W"],"x-enum-varnames":["Approved","Rejected","Warning"],"description":"Result of the transaction."},"transactionDate":{"type":"string","description":"Date of transaction."},"transactionType":{"type":"string","description":"Type of transaction."},"isReversed":{"type":"boolean","description":"Flag that indicates if the transaction was reversed."}}}]},"Walletholder":{"title":"WalletholderDetails Model","description":"UpdateWalletRequestDTO representation","type":"object","properties":{"email":{"type":"string","description":"Wallet holder's email address"},"telNo":{"type":"string","description":"Wallet holder's phone number"},"walletHolderBirthdate":{"type":"string","description":"Wallet holder's birthdate"},"walletHolderCity":{"type":"string","description":"Wallet holder's address - city"},"walletHolderCountryCode":{"type":"string","description":"Wallet holder's address - country code"},"walletHolderForename":{"type":"string","description":"Wallet holder's first name"},"walletHolderGender":{"type":"string","description":"Wallet holder's gender","enum":["M","F","U"],"x-enum-varnames":["MALE","FEMALE","UNKNOWN"]},"walletHolderPostCode":{"type":"string","description":"Wallet holder's address - post code"},"walletHolderStateCode":{"type":"string","description":"User's address - state code"},"walletHolderStreet":{"type":"string","description":"Wallet holder's address - street"},"walletHolderSurname":{"type":"string","description":"Wallet holder's last name"}}},"Amount":{"title":"Amount DTO Model","description":"Amount representation for transactions","type":"object","required":["amount","currency"],"properties":{"amount":{"type":"integer","format":"int64","description":"Transacton Amount in minor unit"},"currency":{"type":"string","description":"Currency Code (ISO 4217)"},"exponent":{"type":"integer","description":"Currency Exponent. If not present default value from ISO 4217 will be used"}}},"TransactionAmounts":{"title":"Request Amounts DTO Model","description":"Combination of the different Amount types for a transaction request","type":"object","required":["amountTransaction"],"properties":{"amountTransaction":{"$ref":"#/components/schemas/Amount"},"amountTip":{"$ref":"#/components/schemas/Amount"},"amountDonation":{"$ref":"#/components/schemas/Amount"}}},"DeviceBase":{"title":"DeviceDTO Model","description":"DeviceDTO representation","type":"object","properties":{"appVersionNo":{"type":"string","description":"Application version number"},"deviceExternalIdentifier":{"type":"string","description":"Device external Identifier"},"manufacturer":{"type":"string","description":"Device manufacturer"},"model":{"type":"string","description":"Device model"},"operatingSystem":{"type":"string","description":"Device operating system version"},"serialNo":{"type":"string","description":"Device serial number"}}},"Device":{"title":"Device Response DTO Model","description":"Device Object sent in a Response","allOf":[{"$ref":"#/components/schemas/DeviceBase"},{"type":"object","required":["deviceIdentifier"],"properties":{"deviceIdentifier":{"type":"string","description":"the unique DeviceIdentifier generated by the DGW"}}}]},"ProfileBase":{"title":"ProfileDetailsRequestDTO Model","description":"ProfileDetailsRequestDTO representation","type":"object","required":["productIdentifier"],"properties":{"loyaltyIdentifier":{"type":"string","description":"Loyalty identifier"},"productIdentifier":{"type":"string","description":"Product the Profile will be linked against"},"walletBalance":{"allOf":[{"$ref":"#/components/schemas/Amount"}],"description":"Wallet balance"}}},"Profile":{"title":"ProfileDetailsRequestDTO Model","description":"ProfileDetailsRequestDTO representation","allOf":[{"$ref":"#/components/schemas/ProfileBase"},{"type":"object","required":["profileIdentifier"],"properties":{"profileIdentifier":{"type":"string","description":"the unique ProfileIdentifier generated by the DGW"},"cards":{"type":"array","description":"List of cards linked to that profile.","items":{"$ref":"#/components/schemas/CardMasked"}},"preferences":{"type":"array","description":"Profile preferences","items":{"$ref":"#/components/schemas/ProfilePreference"}}}}]},"ProfilePreferenceBase":{"title":"ProfilePreferencesDetailsDTO Model","description":"ProfilePreferencesDetailsDTO representation","type":"object","properties":{"preferenceName":{"type":"string","description":"Preference's name"},"preferenceValue":{"type":"string","description":"Preference's value"}}},"ProfilePreference":{"title":"ProfilePreferencesDetailsDTO Model","description":"ProfilePreferencesDetailsDTO representation","allOf":[{"$ref":"#/components/schemas/ProfilePreferenceBase"},{"type":"object","required":["profilePreferenceIdentifier"],"properties":{"profilePreferenceIdentifier":{"type":"string","description":"Unique ProfilePreferenceIdentifier generated by the DGW"}}}]},"CardBase":{"title":"Card Details DTO Model","description":"Details for a Card / Card Token","type":"object","properties":{"cardExpiryDate":{"type":"string","minLength":4,"maxLength":4,"pattern":"^(\\d\\d)(0[0-9]|1[1-2])$","description":"Card expiry date as YYMM"},"cardToken":{"type":"string","description":"Card token generated for the provided card. Format for the Token is currently being defined."},"cardTokenExpiryDate":{"type":"string","minLength":4,"maxLength":4,"pattern":"^(\\d\\d)(0[0-9]|1[1-2])$","description":"Card token expiry date as YYMM"},"cardTypeIdentifier":{"type":"string","description":"2 digit alphanumeric representation of the card type.\n\nExmple Types:\n| CardType | Description |\n| -------- | ----------- |\n| AX       | American Express |\n| AP       | Alipay      |\n| WP       | WeChatPay   |\n| 3D       | 3CDigital Pay |\n| MC       | MasterCard |\n| VS       | Visa       |"}}},"CardMasked":{"title":"Card Details DTO Model","description":"Details for a Card / Card Token","allOf":[{"$ref":"#/components/schemas/CardBase"},{"type":"object","properties":{"cardMaskedNumber":{"type":"string","minLength":12,"maxLength":19,"pattern":"^(\\d{6}\\*{2,9}\\d{4})$","description":"Card masked number. Masking will be done with a \"*\"."},"cardIdentifier":{"type":"string","description":"Unique card identifier generated by the DGW"}}}]},"CardClear":{"title":"Card Details DTO Model","description":"Details for a Card / Card Token","allOf":[{"$ref":"#/components/schemas/CardBase"},{"type":"object","properties":{"cardNumberClear":{"type":"string","minLength":12,"maxLength":19,"pattern":"^(\\d{12,19})$","description":"Clear card number. Only used in request to generate a token. Will never be retruned by the DGW.\n "}}}]},"PaTCheck":{"title":"Pay@Table Check DTO Model","description":"Data for a single Pay@Table Check","type":"object","properties":{"checkIdentifier":{"type":"string","description":"The identifier for this check as provided by the Pay@Table System"},"checkSequenceNumber":{"type":"string","description":"The sequence number for this check as provided by the Pay@Table System"},"checkRawData":{"type":"string","description":"Raw check data for this check as provided by the Pay@Table System"}}},"Login":{"title":"Login DTO Model","description":"Data required for a user to log on to their wallet account","type":"object","required":["schemeIdentifier","registrationIdentifier"],"properties":{"schemeIdentifier":{"type":"string","description":"the Identifier provided by 3C for the scheme this wallet is registered to."},"registrationIdentifier":{"type":"string","description":"the Identifier provided by the user during the registration process. This can be any string, but is has\nto be unique for the sheme it is applied to"}}},"LoginRequest":{"title":"Login Request DTO Model","description":"Data required to process a LoginRequest","allOf":[{"$ref":"#/components/schemas/Login"},{"type":"object","properties":{"password":{"type":"string","description":"The password linked to the registrationIdentifier on this scheme.","format":"password"}}}]},"Authentication":{"title":"Authentication DTO Model","description":"Parameters for Authenticating the user","type":"object","properties":{"authenticationIdentifier":{"type":"string","description":"Where to send the authenticationCode to (Mail address, Phone Number, etc.)"},"authenticationType":{"type":"string","description":"Type of authentication method used. How does the user gets authenticated (EMAIL or SMS).","enum":["E","S"],"x-enum-varnames":["EMAIL","SMS"]}}},"UserData":{"title":"UserData DTO Model","description":"Data sent by the integrator that should be forwared to the Aquirer. This data is not evaulated nor manipulated.","type":"object","properties":{"userData1":{"type":"string","description":"UserData Field 1"},"userData2":{"type":"string","description":"UserData Field 2"},"userData3":{"type":"string","description":"UserData Field 3"},"userData4":{"type":"string","description":"UserData Field 4"}}},"PrintData":{"title":"PrintData DTO Model","description":"Printer related data to be sent to the integrator. This usually is the receipts for a transaction, but it can be other data","type":"object","properties":{"cardholderReceipt":{"type":"string","description":"The generated receipt for the cardholder"},"merchantReceipt":{"type":"string","description":"The generated receipt for the merchant"}}}}},"paths":{"/v1/security/session/create":{"post":{"tags":["Security"],"summary":"Create Security Session","description":"Creates a session for a specific wallet and device. A session is required to be able to use any secure call.\nIf a session for that wallet/device combination already exists, the Gateway will revoke current session and generate a new one.","operationId":"createSession","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"}],"requestBody":{"description":"Request Body for createSession","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestCreateSession"}}}},"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCreateSession"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/security/session/remove":{"post":{"tags":["Security"],"summary":"Remove Security Session","description":"Removes a session for a specific wallet on the given device. This call should be used to invalidate an active\nsession that is not expired but is not used any more.\nIf __deviceIdentifier__ parameter is not provided, __all__ sessions active for this wallet and all devices will be removed.","operationId":"removeSession","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"}],"requestBody":{"description":"Request Body for removeSession","required":true,"content":{"application/json":{"schema":{"title":"removeSessionRequest","description":"Data Object Model for a removeSession request","type":"object","required":["walletIdentifier"],"properties":{"deviceIdentifier":{"type":"string","description":"Unique device identifier generated by the DGW"},"walletIdentifier":{"type":"string","description":"Unique wallet identifier generated by the DGW"}}}}}},"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBase"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/wallet/create-all":{"post":{"tags":["Wallet"],"summary":"Creates a Wallet, Profile(s) and Device(s) in one call","description":"This call should be used to \"migrate\" an existing wallet from an external partner to the 3C system. \nThis will create the Wallet, Profile and Device structure in one shot. \nAfter that only adding a card and linking it to a profile is required","operationId":"createWalletAIO","deprecated":false,"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/ReturnDetails"}],"requestBody":{"description":"Request Body for createWalletAIO","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestCreateWalletAIO"}}}},"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCreateWalletAIO"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/wallet/{walletIdentifier}":{"get":{"tags":["Wallet"],"summary":"Get wallet details","description":"Retrieves the details for a specific wallet.","operationId":"getWalletDetails","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"in":"query","name":"returnCardDetails","description":"If this parameter is set, this call will also return all the __cards__ and their details, that are linked to this wallet","required":false,"schema":{"type":"boolean","default":false},"allowEmptyValue":false,"x-example":false},{"in":"query","name":"returnDeviceDetails","description":"If this parameter is set, this call will also return all the __devices__ and their details, that are linked to this wallet","required":false,"schema":{"type":"boolean","default":false},"allowEmptyValue":false,"x-example":false},{"in":"query","name":"returnProfileDetails","description":"If this parameter is set, this call will also return all the __profiles__ and their details, that are linked to this wallet","required":false,"schema":{"type":"boolean","default":false},"allowEmptyValue":false,"x-example":false}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetWalletDetails"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["Wallet"],"summary":"Remove Wallet","description":"Removes a specific wallet from a specific profile.","operationId":"deleteWallet","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBase"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["Wallet"],"summary":"Update Wallet","description":"Updates a specific wallet data.","operationId":"updateWallet","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"}],"requestBody":{"description":"Request Body for updateWallet","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestUpdateWallet"}}}},"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBase"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/wallet/{walletIdentifier}/card":{"post":{"tags":["Card"],"summary":"Add card to wallet","description":"Adds a new card to specific wallet. Adding the card will create a card token for this card,\nbut the card will not be usable until it is linked to a profile. This has to be done in a seperate call","operationId":"addCard","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/ReturnDetails"}],"requestBody":{"description":"Request Body for addCard","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardClear"}}}},"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseAddCard"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"get":{"tags":["Card"],"summary":"Retrieve Cards","description":"Retrieves a list of cards linked to the specified wallet","operationId":"getCards","parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetCards"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/wallet/{walletIdentifier}/card/{cardIdentifier}":{"get":{"tags":["Card"],"summary":"Retrieve Card Details","description":"Retrieves the details of specified card from the specified wallet.","operationId":"getCardDetails","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/CardIdentifier"}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetCardDetails"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["Card"],"summary":"Remove Card","description":"Removes a specific card from a specific wallet.","operationId":"deleteCard","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/CardIdentifier"}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBase"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/wallet/{walletIdentifier}/card/{cardIdentifier}/link":{"patch":{"tags":["Card"],"summary":"Link card to profile","description":"Link a specific card to a specific profile.","operationId":"linkCard","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/CardIdentifier"}],"requestBody":{"description":"Request Body for linkCard","required":true,"content":{"application/json":{"schema":{"title":"RequestLinkCard","description":"Data Object Model for a linkCard request","type":"object","required":["profileIdentifier"],"properties":{"profileIdentifier":{"description":"the unique profileIdentifier to link the card to","type":"string"}}}}}},"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBase"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/wallet/{walletIdentifier}/card/{cardIdentifier}/unlink":{"patch":{"tags":["Card"],"summary":"Unlink Card","description":"Unlink a specific card from a specific profile.","operationId":"unlinkCard","parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/CardIdentifier"}],"requestBody":{"description":"Request Body for unlinkCard","required":true,"content":{"application/json":{"schema":{"title":"RequestUnlinkCard","description":"Data Object Model for a unlinkCard request","type":"object","required":["profileIdentifier"],"properties":{"profileIdentifier":{"description":"the unique profileIdentifier to link the card to","type":"string"}}}}}},"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBase"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/wallet/{walletIdentifier}/device":{"get":{"tags":["Device"],"summary":"Retrieve Devices","description":"Retrieves the list of devices that are currently linked to the specified wallet","operationId":"getDeviceList","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetDevices"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/wallet/{walletIdentifier}/device/{deviceIdentifier}":{"get":{"tags":["Device"],"summary":"Retrieve Device","description":"Retrieves the details of the sepecified device from the specified wallet.","operationId":"getDevice","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/DeviceIdentifier"}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetDevice"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["Device"],"summary":"Remove Device","description":"Removes a specific device from a specific wallet.","operationId":"deleteDevice","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/DeviceIdentifier"}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBase"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["Device"],"summary":"Update Device","description":"Updates a specific device of a specific wallet.","operationId":"updateDevice","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/DeviceIdentifier"},{"$ref":"#/components/parameters/ReturnDetails"}],"requestBody":{"description":"Request Body for updateDevice","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceBase"}}}},"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetDevice"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/wallet/{walletIdentifier}/profile":{"get":{"tags":["Profile"],"summary":"Retrieve Profiles","description":"Retrieves all profiles from a specific wallet.","operationId":"getAllProfiles","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetProfiles"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/wallet/{walletIdentifier}/profile/{profileIdentifier}":{"get":{"tags":["Profile"],"summary":"Retrieve Profile","description":"Retrieves the details for a specific profile.","operationId":"getProfile","parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/ProfileIdentifier"}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetProfile"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"delete":{"tags":["Profile"],"summary":"Remove Profile","description":"Removes a profile from a specific wallet.","operationId":"deleteProfile","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/ProfileIdentifier"}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBase"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["Profile"],"summary":"Update Profile","description":"Updates a profile from a specific wallet.","operationId":"updateProfile","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/ProfileIdentifier"},{"$ref":"#/components/parameters/ReturnDetails"}],"requestBody":{"description":"Request Body for updateProfile","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileBase"}}}},"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetProfile"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/wallet/{walletIdentifier}/profile/{profileIdentifier}/preference":{"post":{"tags":["Profile"],"summary":"Add Profile Preference","description":"Add a profile preference to a specific profile.","operationId":"addProfilePreference","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/ProfileIdentifier"},{"$ref":"#/components/parameters/ReturnDetails"}],"requestBody":{"description":"Request Body for addProfilePreference","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilePreferenceBase"}}}},"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetProfilePreference"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"get":{"tags":["Profile"],"summary":"Get all profile preferences","description":"Retrieves a list of all  profile preference linked to the specified profile on the specified wallet","operationId":"getAllProfilePreferences","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/ProfileIdentifier"}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetProfilePreferences"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/wallet/{walletIdentifier}/profile/{profileIdentifier}/preference/{preferenceIdentifier}":{"get":{"tags":["Profile"],"summary":"Get Profile Preference","description":"Retrieves a profile preference from a specific profile.","operationId":"getProfilePreference","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/ProfileIdentifier"},{"$ref":"#/components/parameters/PreferenceIdentifier"}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetProfilePreferences"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["Profile"],"summary":"Removes Profile Preference","description":"Removes a profile preference from a specific profile.","operationId":"removeProfilePreference","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/ProfileIdentifier"},{"$ref":"#/components/parameters/PreferenceIdentifier"}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBase"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["Profile"],"summary":"Update Profile Preference","description":"Updates a profile preference from a specific profile.","operationId":"updateProfilePreference","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/WalletIdentifier"},{"$ref":"#/components/parameters/ProfileIdentifier"},{"$ref":"#/components/parameters/PreferenceIdentifier"}],"requestBody":{"description":"Request Body for updateProfilePreference","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilePreferenceBase"}}}},"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBase"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/pat/{protocol}/check":{"post":{"tags":["PayAtTable"],"summary":"Opens a Check","description":"Opens a single check on the CAPS server","operationId":"openCheck","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/PaTProtocolIdentifier"}],"requestBody":{"description":"Request Body for openCheck","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestOpenCheck"}}}},"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseOpenCheck"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"get":{"tags":["PayAtTable"],"summary":"Retrieves all checks for a wallet","description":"This call returns all checks that are linked against the specified wallet.\nThere is the option to filter the checks by Location and/or RevenueCenter.","operationId":"getAllChecks","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/PaTProtocolIdentifier"},{"$ref":"#/components/parameters/WalletIdentifierQuery"},{"$ref":"#/components/parameters/RequesterLocationIdentifier"},{"$ref":"#/components/parameters/RevenueCenterIdentifier"}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetAllChecks"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/pat/{protocol}/check/pay":{"post":{"tags":["PayAtTable"],"summary":"Posts the payments all Checks linked to the wallet","description":"Posts the payments for multiple Checks linked to the wallet from the CAPS server.","operationId":"payAllChecks","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/PaTProtocolIdentifier"}],"requestBody":{"description":"Request Body for payAllChecks","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPayAllChecks"}}}},"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePayAllChecks"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/pat/{protocol}/check/{checkNum}":{"get":{"tags":["PayAtTable"],"summary":"gets a check to a specified wallet","description":"retrieves the info for a single check on the CAPS server","operationId":"getCheck","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/PaTProtocolIdentifier"},{"$ref":"#/components/parameters/CheckIdentifier"},{"$ref":"#/components/parameters/WalletIdentifierQuery"},{"$ref":"#/components/parameters/RequesterLocationIdentifier"},{"$ref":"#/components/parameters/RevenueCenterIdentifier"}],"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetCheck"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/pat/{protocol}/check/{checkNum}/pay":{"post":{"tags":["PayAtTable"],"summary":"Post the payment to a specific checkNum","description":"Post the payment for given checkNum throught received wallet","operationId":"payCheck","deprecated":false,"parameters":[{"$ref":"#/components/parameters/UserAgent"},{"$ref":"#/components/parameters/RequestIdentifier"},{"$ref":"#/components/parameters/SessionHeader"},{"$ref":"#/components/parameters/PaTProtocolIdentifier"},{"$ref":"#/components/parameters/CheckIdentifier"}],"requestBody":{"description":"Request Body for payCheck","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPayCheck"}}}},"responses":{"200":{"description":"OK","headers":{"X-Request-ID":{"description":"Unique message identifier","schema":{"type":"string"}},"Authorization":{"description":"Session token","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePayCheck"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}}}}