{"openapi":"3.0.3","info":{"version":"1.0.7","title":"Checkout Solution","description":"The Checkout API is the entry point of the checkout page. For any payments via the checkout page, first, you need to create the transaction. Your storeId, amount and currency are the critical parameters in a transaction API. You can also include order information, tax, shipping information, language preference, customer details, and other transaction-specific configurations."},"servers":[{"url":"https://prod.emea.api.fiservapps.com/sandbox/exp/v1","description":"Sandbox"},{"url":"https://prod.emea.api.fiservapps.com/exp/v1","description":"Production"}],"paths":{"/checkouts":{"post":{"summary":"Create a new checkout","description":"Initiate a payment request by passing all the required parameters. It creates a new payment transaction and returns the redirect URL that includes transaction ID.","operationId":"postCheckouts","parameters":[{"$ref":"#/components/parameters/Client-Request-Id"},{"$ref":"#/components/parameters/Message-Signature"},{"$ref":"#/components/parameters/Timestamp"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionRequestProperties"},"examples":{"New payment - consumer has no card registered":{"value":{"storeId":"72305408","merchantTransactionId":"TestTx01NewPayment","transactionType":"SALE","transactionAmount":{"total":5.98,"currency":"GBP","components":{"subtotal":4.94,"vatAmount":1.04}},"order":{"basket":{"lineItems":[{"itemIdentifier":"100","name":"Orange juice","price":2.99,"quantity":2,"total":5.98}]}},"checkoutSettings":{"locale":"en_GB","webHooksUrl":"https://webhook.site/47ae26ee-ac72-4ce1-b872-e1dec58c9817","redirectBackUrls":{"successUrl":"https://www.success.com/","failureUrl":"https://www.failure.com/"}},"paymentMethodDetails":null}},"Card registration during payments - consumer stores card while doing a payment":{"value":{"transactionType":"SALE","transactionAmount":{"total":25,"currency":"GBP","components":{"subtotal":20,"vatAmount":2,"shipping":3}},"storeId":"72305408","checkoutSettings":{"redirectBackUrls":{"successUrl":"https://www.success.com/","failureUrl":"https://www.failureexample.com"}},"paymentMethodDetails":{"cards":{"createToken":{"customTokenValue":"EMEADevloperPortalTest281122","reusable":false,"toBeUsedFor":"UNSCHEDULED"}}}}},"Card registration only - consumer registers their card in the app with no payment at that point":{"value":{"storeId":"72305408","merchantTransactionId":"TestTx01CardRegistration","transactionType":"ZERO-AUTH","transactionAmount":{"total":0,"currency":"GBP"},"checkoutSettings":{"locale":"en_GB","webHooksUrl":"https://webhook.site/47ae26ee-ac72-4ce1-b872-e1dec58c9817","redirectBackUrls":{"successUrl":"https://www.success.com/","failureUrl":"https://www.failure.com/"}},"paymentMethodDetails":{"cards":{"createToken":{"customTokenValue":"123ABC23","toBeUsedFor":"UNSCHEDULED"}}}}},"Payment with registered card - consumer has previously store their card, no card number entry required for payment":{"value":{"transactionType":"SALE","transactionAmount":{"total":25,"currency":"GBP","components":{"subtotal":20,"vatAmount":2,"shipping":3}},"storeId":"72305408","checkoutSettings":{"redirectBackUrls":{"successUrl":"https://www.success.com/","failureUrl":"https://www.failureexample.com"}},"paymentMethodDetails":{"cards":{"tokenBasedTransaction":{"value":"ApoorvaTest9thNov","transactionSequence":"SUBSEQUENT"}}}}}}}}},"responses":{"201":{"description":"Success response. A new transaction is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"},"examples":{"Checkout link response":{"value":{"checkout":{"storeId":"72305408","checkoutId":"IUBsFE","redirectionUrl":"https://checkout-lane.com/?checkoutId=IUBsFE"}}}}}},"headers":{"Trace-Id":{"schema":{"type":"string","format":"uuid"},"description":"An internal unique ID for this request which can be used for diagnosing issues and corresponding with support."}}},"400":{"$ref":"#/components/responses/POSTBadRequest"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AccessForbidden"},"404":{"$ref":"#/components/responses/ResourceNotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"}},"security":[{"API-Key":[]}],"servers":[{"url":"https://prod.emea.api.fiservapps.com/sandbox/exp/v1","description":"Sandbox"},{"url":"https://prod.emea.api.fiservapps.com/exp/v1","description":"Production"}]}},"/checkouts/{checkoutId}":{"get":{"summary":"Retrieve checkout details","description":"Retrieve details about a specific checkout using the identifier returned when it was created.","operationId":"get-checkouts-id","parameters":[{"name":"checkoutId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutsRetrievalModel"}}},"headers":{"Trace-Id":{"schema":{"type":"string"},"description":"An internal unique ID for this request which can be used for diagnosing issues and corresponding with support."}}},"400":{"$ref":"#/components/responses/GETBadRequest"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AccessForbidden"},"404":{"$ref":"#/components/responses/ResourceNotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"}},"security":[{"API-Key":[]}],"servers":[{"url":"https://prod.emea.api.fiservapps.com/sandbox/exp/v1","description":"Sandbox"},{"url":"https://prod.emea.api.fiservapps.com/exp/v1","description":"Production"}]}}},"components":{"parameters":{"Client-Request-Id":{"name":"Client-Request-Id","in":"header","description":"A client-generated ID for message signature creation, unique per request.","required":true,"schema":{"type":"string","format":"uuid"}},"Message-Signature":{"name":"Message-Signature","in":"header","description":"Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.","required":true,"schema":{"type":"string"}},"Timestamp":{"name":"Timestamp","in":"header","description":"Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).","required":true,"schema":{"type":"string"}}},"securitySchemes":{"API-Key":{"type":"apiKey","name":"Api-Key","in":"header"}},"responses":{"AccessForbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"},"examples":{"Forbidden":{"value":{"errors":[{"title":"Forbidden error","detail":"Access to the requested resource is forbidden."}]}}}}},"headers":{"Trace-Id":{"schema":{"type":"string","format":"uuid"},"description":"An internal unique ID for this request which can be used for diagnosing issues and corresponding with support."}}},"AuthenticationError":{"description":"Unauthorised","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"},"examples":{"Unauthorised":{"value":{"errors":[{"title":"Authentication Error","detail":"No valid API key or credential has been provided in the request."}]}}}}},"headers":{"Trace-Id":{"schema":{"type":"string","format":"uuid"},"description":"An internal unique ID for this request which can be used for diagnosing issues and corresponding with support."}}},"POSTBadRequest":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"},"examples":{"Bad request":{"value":{"errors":[{"title":"Bad Request - Incorrect or Missing field transactionType","detail":"There is a validation error with transactionType. Field in body is mandatory. Please fix and repeat your request","source":"transactionType"}]}}}}},"headers":{"Trace-Id":{"schema":{"type":"string","format":"uuid"},"description":"An internal unique ID for this request which can be used for diagnosing issues and corresponding with support."}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"},"examples":{"Internal server error":{"value":{"errors":[{"title":"Internal Server Error","detail":"Sorry, something has gone wrong at our end. If this persists please contact support and provide the value of your Trace-Id header."}]}}}}},"headers":{"Trace-Id":{"schema":{"type":"string","format":"uuid"},"description":"An internal unique ID for this request which can be used for diagnosing issues and corresponding with support."}}},"ResourceNotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"},"examples":{"Not found":{"value":{"errors":[{"title":"Resource Not Found","detail":"The requested resource cannot be found."}]}}}}},"headers":{"Trace-Id":{"schema":{"type":"string","format":"uuid"},"description":"An internal unique ID for this request which can be used for diagnosing issues and corresponding with support."}}},"GETBadRequest":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"},"examples":{"Bad request":{"value":{"errors":[{"title":"Bad Request - Incorrect or Missing Paramater/Header/Field","detail":"There is a validation error. Please fix and repeat your request."}]}}}}},"headers":{"Trace-Id":{"schema":{"type":"string","format":"uuid"},"description":"An internal unique ID for this request which can be used for diagnosing issues and corresponding with support."}}},"TooManyRequests":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"},"examples":{"Too many requests":{"value":{"errors":[{"title":"Too many requests","detail":"Too many requests have been received too quickly. Please back off your requests and try again."}]}}}}},"headers":{"Trace-Id":{"schema":{"type":"string","format":"uuid"},"description":"An internal unique ID for this request which can be used for diagnosing issues and corresponding with support."}}}},"schemas":{"TransactionRequestProperties":{"type":"object","properties":{"storeId":{"type":"string","description":"Store id to  be used for processing this payment. It also acts as an identifier for your store to load the checkout pages linked to it. If no checkout pages are found, default payment page will be rendered for that transaction.","maxLength":20,"example":"72305408"},"merchantTransactionId":{"type":"string","nullable":true,"description":"You can use this parameter to tag a unique identifier to this transaction for future reference.","maxLength":40,"example":"AB-1234"},"transactionOrigin":{"type":"string","enum":["ECOM","MAIL","PHONE"],"description":"This parameter is used to flag the transaction source correctly.  The possible values are `ECOM` (if the order was recieved from online shop), `MAIL` & `PHONE`.","default":"ECOM","example":"ECOM"},"transactionType":{"type":"string","enum":["SALE","PRE-AUTH","ZERO-AUTH"],"description":"You can use this parameter to specify the type of transaction you want to perform. Allowed values are:  `SALE`, `PRE-AUTH`, `ZERO-AUTH` ","example":"SALE"},"transactionAmount":{"$ref":"#/components/schemas/TransactionAmount"},"order":{"$ref":"#/components/schemas/Order"},"checkoutSettings":{"$ref":"#/components/schemas/IntegrationDetails"},"paymentMethodDetails":{"$ref":"#/components/schemas/PaymentMethodDetails"}},"required":["storeId","transactionType"],"x-examples":{"Example 1":{"storeId":"72305408","merchantTransactionId":"AB-1234","transactionOrigin":"ECOM","transactionType":"SALE","transactionAmount":{"total":130,"currency":"GBP","components":{"subtotal":98,"vatAmount":22,"shipping":10}},"order":{"orderId":"31da1addc129a","orderDetails":{"customerId":"1234567890","dynamicMerchantName":"Merchant XYZ","invoiceNumber":"96126098","purchaseOrderNumber":"123055342"},"basket":{"lineItems":[{"itemIdentifier":"Item001","name":"Mobile","price":98,"quantity":1,"shippingCost":10,"valueAddedTax":22,"miscellaneousFee":0,"total":130}]},"billing":{"person":{"firstName":"John","lastName":"Doe","dateOfBirth":"1975-01-31","name":"John Doe"},"contact":{"phone":"4567278956","mobilePhone":"7834561235","email":"john@testemail.com","fax":"5555555767"},"address":{"address1":"House No: 2, street -5","address2":"The Hill","city":"London ","company":"Test company","country":"United Kingdom","postalCode":"SE12SX ","region":"Greater London"}},"shipping":{"person":{"firstName":"John","lastName":"Doe","dateOfBirth":"1975-01-31","name":"John Doe"},"contact":{"phone":"4567278956","mobilePhone":"7834561235","email":"john@testemail.com","fax":"5555555767"},"address":{"address1":"House No: 2, street -5","address2":"The Hill","city":"London ","company":"Test company","country":"United Kingdom","postalCode":"SE12SX ","region":"Greater London"}}},"checkoutSettings":{"locale":"en_GB","preSelectedPaymentMethod":"cards","webHooksUrl":"https://yourapp.com/data","redirectBackUrls":{"successUrl":"https://www.successexample.com","failureUrl":"https://www.failureexample.com"}},"paymentMethodDetails":{"cards":{"authenticationPreferences":{"challengeIndicator":"01","scaExemptionType":"LOW_VALUE_EXEMPTION","skipTra":false},"createToken":{"customTokenValue":"234ljl124l12","declineDuplicateToken":false,"reusable":true,"toBeUsedFor":"UNSCHEDULED"},"tokenBasedTransaction":{"value":"234ljl124l12","transactionSequence":"FIRST","schemeTransactionId":"012243800355698"}}}}}},"TransactionAmount":{"type":"object","description":"Object contains total transaction amount, currency, tax and discount details. Example:\n`{\"total\":123,\"currency\":\"GBP\",\"components\":{\"subtotal\":115,\"vat\":3,\"shipping\":2.5}}`","properties":{"total":{"type":"number","description":"This denotes your total amount of the order which includes vat, shipping cost, etc.","example":130},"currency":{"type":"string","description":"The three letter ISO currency code of the transaction.","maxLength":3,"example":"GBP"},"components":{"$ref":"#/components/schemas/TransactionAmountComponents"}},"required":["total","currency"]},"TransactionAmountComponents":{"type":"object","description":"Object contains sub components of total transaction amount. Total transaction amount is equal to the sum of all subcomponents. ","properties":{"subtotal":{"type":"number","nullable":true,"description":"Subtotal amount denotes the total of all line items and the discount applied on top of the order.","example":115},"vatAmount":{"type":"number","nullable":true,"description":"Value-added tax charged as part of this order.","example":2},"shipping":{"type":"number","nullable":true,"description":"Shipping cost charged as part of this order.","example":2}}},"Order":{"type":"object","description":"Object contais order related details.","properties":{"orderId":{"type":"string","description":"Unique identifier of the order. In case where this is not provided, a random unique identifier will be generated and assigned to the order.","maxLength":30,"example":"31da1addc129a"},"merchant":{"$ref":"#/components/schemas/Merchant"},"orderDetails":{"$ref":"#/components/schemas/OrderDetails"},"basket":{"$ref":"#/components/schemas/Basket"},"billing":{"$ref":"#/components/schemas/Billing"},"shipping":{"$ref":"#/components/schemas/Shipping"}}},"Merchant":{"type":"object","title":"Merchant","description":"Object contains the merchant details.","properties":{"merchantStoreId":{"type":"string","description":"Unique identifier of the Merchant","maxLength":32},"address":{"type":"object","properties":{"company":{"type":"string","description":"Company name associated with the address","maxLength":96},"address1":{"type":"string","description":"First line of the street address.","maxLength":96,"example":"House No:2, street-5"},"address2":{"type":"string","description":"Second line of the street address.","maxLength":96,"example":"The Hill"},"city":{"type":"string","description":"City or locality.","maxLength":96,"example":"London"},"postalCode":{"type":"string","description":"ZIP code or postal code","maxLength":24,"example":"SE12SX"},"region":{"type":"string","description":"State or province.","maxLength":96,"example":"Greater London"},"country":{"type":"string","description":"Full country name.","maxLength":96,"example":"United Kingdom"}}}}},"OrderDetails":{"type":"object","nullable":true,"description":"Object contains order information such as invoice number, discount etc.","properties":{"customerId":{"type":"string","nullable":true,"description":"Customer ID for billing purpose.","maxLength":32,"example":"1234567890"},"dynamicMerchantName":{"type":"string","nullable":true,"description":"Dynamic merchant name for the statement.","pattern":"^(?!\\s*$).+","example":"Merchant XYZ"},"invoiceNumber":{"type":"string","nullable":true,"description":"Invoice number created by merchant.","maxLength":48,"example":"96126098"},"purchaseOrderNumber":{"type":"string","nullable":true,"description":"Purchase order number released by merchant.","maxLength":128,"example":"123055342"}}},"Basket":{"type":"object","nullable":true,"description":"Object indicates basket of items.","properties":{"lineItems":{"type":"array","description":"The list of items included in the order.","items":{"$ref":"#/components/schemas/LineItems"}}}},"LineItems":{"type":"object","description":"The list of items included in the order.","properties":{"itemIdentifier":{"type":"string","nullable":true,"description":"The unique identifier for the item in the basket.","example":"Item001"},"name":{"type":"string","nullable":true,"description":"Name of the item in the basket.","example":"Mobile"},"price":{"type":"number","nullable":true,"description":"Price of the item.","example":98},"quantity":{"type":"number","nullable":true,"description":"Quantity of the item.","example":1},"shippingCost":{"type":"number","nullable":true,"description":"Shipping cost for the item.","example":10},"valueAddedTax":{"type":"number","nullable":true,"description":"Value added tax amount on the items.","example":22},"miscellaneousFee":{"type":"number","nullable":true,"description":"Miscellaneous charges.","example":0},"total":{"type":"number","nullable":true,"description":"Total amount including shipping cost, VAT, miscellaneous charges for this line item.","example":130}}},"Billing":{"type":"object","nullable":true,"description":"Object contains the customer billing details.","properties":{"person":{"$ref":"#/components/schemas/Person"},"contact":{"$ref":"#/components/schemas/Contact"},"address":{"$ref":"#/components/schemas/Address"}}},"Person":{"type":"object","description":"Object contains customer name and date of birth information.","properties":{"firstName":{"type":"string","nullable":true,"description":"First name of the customer.","maxLength":48,"example":"John"},"lastName":{"type":"string","nullable":true,"description":"Last name of the customer.","maxLength":48,"example":"Doe"},"dateOfBirth":{"type":"string","nullable":true,"description":"Date of birth of the customer. Format YYYY-MM-DD.","format":"date","example":"1975-01-31"},"name":{"type":"string","nullable":true,"description":"Name of the customer.","maxLength":96,"example":"John Doe"}}},"Contact":{"type":"object","description":"Object contains the customer contact details.","properties":{"phone":{"type":"string","nullable":true,"description":"Primary phone number.","maxLength":32,"example":"4567278956"},"mobilePhone":{"type":"string","nullable":true,"description":"Mobile phone number.","maxLength":32,"example":"7834561235"},"email":{"type":"string","nullable":true,"description":"Email address.","maxLength":256,"example":"john@testemail.com"},"fax":{"type":"string","nullable":true,"description":"Fax number.","maxLength":32,"example":"5555555767"}}},"Address":{"type":"object","description":"Object contains the customer address details.","properties":{"address1":{"type":"string","nullable":true,"description":"First line of the street address.","maxLength":96,"example":"House No: 2, street -5"},"address2":{"type":"string","nullable":true,"description":"Second line of the street address.","maxLength":96,"example":"The Hill"},"city":{"type":"string","nullable":true,"description":"City or locality.","maxLength":96,"example":"London "},"company":{"type":"string","nullable":true,"description":"Company name associated with the address.","maxLength":96,"example":"Test company"},"country":{"type":"string","nullable":true,"description":"Full country name.","example":"United Kingdom"},"postalCode":{"type":"string","nullable":true,"description":"ZIP code or postal code.","maxLength":24,"example":"SE12SX "},"region":{"type":"string","nullable":true,"description":"State or province.","maxLength":96,"example":"Greater London"}}},"Shipping":{"type":"object","nullable":true,"description":"Object contains shipping details.","properties":{"person":{"$ref":"#/components/schemas/Person"},"contact":{"$ref":"#/components/schemas/Contact"},"address":{"$ref":"#/components/schemas/Address"}}},"IntegrationDetails":{"type":"object","properties":{"locale":{"type":"string","nullable":true,"description":"Use this parameter to specify the language of the payment page. Currently supported languages are English(en_US),German(en_GB) etc.","default":"en_GB","example":"en_GB"},"preSelectedPaymentMethod":{"type":"string","nullable":true,"description":"You can use this parameter to specify the preferred payment method. For example, if you pass `cards` as the preferred payment method, only Cards as a payment method will be displayed. If this parameter is not defined, we will display all the available payment methods for the store. \n","maxLength":35,"example":"cards"},"webHooksUrl":{"type":"string","nullable":true,"description":"The URL endpoint to post the real time notifcation in the form of JSON payload. This url is provided by receiver application.","example":"https://yourapp.com/data"},"fraud":{"$ref":"#/components/schemas/Fraud"},"redirectBackUrls":{"$ref":"#/components/schemas/RedirectBackUrls"}}},"Fraud":{"type":"object","title":"Fraud","description":"Object contains new FSL field details.","properties":{"host":{"type":"string","description":"Passed if the device object is not available.","maxLength":250,"example":"https://www.google.com"},"api-key":{"type":"string","description":"Passed if the device object is not available.","maxLength":250,"example":"apikey-01"},"transactionId":{"type":"string","description":"Passed if the device object is not available.","maxLength":250,"example":"trans-01"},"vendor":{"type":"string","description":"Passed if the device object is not available.","maxLength":250,"example":"RAVELIN"},"sessionId":{"type":"string","maxLength":250},"deviceUserAgent":{"type":"string","description":"Passed if the device object is not available.","maxLength":250,"example":"agent-01"},"deviceId":{"type":"string","description":"Passed if the device object is not available.","maxLength":250,"example":"device-01"},"deviceType":{"type":"string","description":"Passed if the device object is not available.","maxLength":250,"example":"device-type-01"},"deviceOS":{"type":"string","description":"Passed if the device object is not available.","maxLength":250,"example":"Android"},"deviceModel":{"type":"string","description":"Passed if the device object is not available.","maxLength":250,"example":"Samsung Galaxy"},"deviceManufacturer":{"type":"string","description":"Passed if the device object is not available.","maxLength":250,"example":"Samsung"}}},"RedirectBackUrls":{"type":"object","description":"Object contains redirect URL details.","properties":{"successUrl":{"type":"string","description":"If the payment is a success, the customer is directed to the specified success URL.","pattern":"https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b([-a-zA-Z0-9()@:%_\\+.~#?&\\/=]*)","example":"https://www.successexample.com"},"failureUrl":{"type":"string","description":"If the payment fails, the customer is directed to the specified failure URL.","pattern":"https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b([-a-zA-Z0-9()@:%_\\+.~#?&\\/=]*)","example":"https://www.failureexample.com"}}},"PaymentMethodDetails":{"type":"object","nullable":true,"description":"Object contains payment method details. \n","properties":{"cards":{"type":"object","description":"Object contains card payment method details.","properties":{"authenticationPreferences":{"$ref":"#/components/schemas/ThreeDS_Payment"},"createToken":{"$ref":"#/components/schemas/ZeroAuthPayment"},"tokenBasedTransaction":{"$ref":"#/components/schemas/TokenBasedTransaction"}}}}},"ThreeDS_Payment":{"type":"object","nullable":true,"properties":{"challengeIndicator":{"type":"string","nullable":true,"enum":["01","02","03","04",null],"description":"The 2 digit challenge indicator. For more information, refer [3-D Secure](../docs/use-cases) document. \nAllowed values:\n - `01` - No preference (set as default value)\n - `02` - No challenge requested\n - `03` - Challenge requested (3-D Secure requestor preference)\n - `04` - Challenge requested (mandate)\n","default":"01","example":"01"},"scaExemptionType":{"type":"string","nullable":true,"enum":["LOW_VALUE_EXEMPTION","TRUSTED_MERCHANT_EXEMPTION",null],"description":"Strong customer authentication exemption type indicator.\nAllowed values: `LOW_VALUE_EXEMPTION`, `TRUSTED_MERCHANT_EXEMPTION`.\n"},"skipTra":{"type":"boolean","nullable":true,"description":"This optional parameter allows you to use 3-D Secure even if the transaction has been evaluated as low risk and would be eligible for an exemption. Allowed  values:\n - `true`\n - `false`\nWhen your store has been set up with Transaction Risk Analysis (TRA) service, but you do want to force 3-D Secure authentication for a certain transaction, set ‘skipTRA’ to ‘true’. Note this parameter is relevant only for the European merchants impacted by the PSD2 requirements.","default":false}}},"ZeroAuthPayment":{"type":"object","nullable":true,"description":"Object contains payment token details.","properties":{"customTokenValue":{"type":"string","nullable":true,"description":"Client-supplied payment token value.","example":"234ljl124l12"},"declineDuplicateToken":{"type":"boolean","nullable":true,"description":"If this parameter is set to true, the transaction will be declined if the card number entered has already been stored with a different token.","default":false},"reusable":{"type":"boolean","nullable":true,"description":"If the token is reusable.","default":true},"toBeUsedFor":{"type":"string","enum":["UNSCHEDULED","RECURRING","INSTALLMENT"],"description":"This parameter is used to specify the type of transactions the token would be used for. ","example":"UNSCHEDULED"}},"required":["toBeUsedFor"]},"TokenBasedTransaction":{"type":"object","title":"TokenBasedTransaction","properties":{"value":{"type":"string","nullable":true,"description":"Client-supplied payment token value.","example":"234ljl124l12"},"transactionSequence":{"type":"string","enum":["FIRST","SUBSEQUENT"],"description":"Indicates if the transaction is first or subsequent. Valid values are FIRST and SUBSEQUENT."},"schemeTransactionId":{"type":"string","nullable":true,"description":"The transaction ID received from schemes for the initial transaction. May be required if sequence is 'SUBSEQUENT'.","maxLength":50,"example":"012243800355698"}},"required":["transactionSequence"]},"TransactionResponse":{"type":"object","properties":{"checkout":{"type":"object","properties":{"storeId":{"type":"string","description":"Store id to  be used for processing this payment. It also acts as an identifier for your store to load the checkout pages linked to it. If no checkout pages are found, default payment page will be rendered for that transaction.","minLength":1,"maxLength":20,"example":"72305408"},"checkoutId":{"type":"string","description":"The unique identifier tagged to the transaction.","example":"f2dd6a9e-4a1c-4c30-9a0e-4ead4f59e909"},"redirectionUrl":{"type":"string","description":"The merchant API uses this redirect URL to redirect user from merchant domain to the payment page.","example":"https://checkout-lane.com/?checkoutId=f2dd6a9e-4a1c-4c30-9a0e-4ead4f59e909"}},"required":["storeId","checkoutId","redirectionUrl"]}},"x-examples":{}},"CheckoutsRetrievalModel":{"type":"object","title":"CheckoutsRetrievalModel","properties":{"storeId":{"type":"string","description":"Store id to  be used for processing this payment. It also acts as an identifier for your store to load the checkout pages linked to it. If no checkout pages are found, default payment page will be rendered for that transaction.","maxLength":20,"example":"72305408"},"checkoutId":{"type":"string","description":"The unique identifier for this checkout.","example":"f2dd6a9e-4a1c-4c30-9a0e-4ead4f59e909"},"orderId":{"type":"string","description":"Unique identifier of the order. In case where this is not provided, a random unique identifier will be generated and assigned to the order. ","example":"31da1addc129a"},"transactionType":{"type":"string","enum":["SALE","PRE-AUTH","ZERO-AUTH"],"description":"You can use this parameter to specify the type of transaction you want to perform. Allowed values are:  `SALE`, `PRE-AUTH`, `ZERO-AUTH` "},"approvedAmount":{"$ref":"#/components/schemas/TransactionAmount"},"transactionStatus":{"type":"string","enum":["INITIATED","APPROVED","WAITING","PARTIAL","FAILED","DECLINED","FRAUD"],"description":"Indicates the transaction status"},"transactionFailure":{"type":"object","description":"Indicates the transaction failure details, if occurred","properties":{"code":{"type":"string","description":"Uniquely identifies an error condition. Client applications need to read and handle errors based on this.","example":"2303"},"reason":{"type":"string","description":"A generic description of the error condition.","example":"Invalid credit card number"}},"required":["code","reason"]},"paymentMethodUsed":{"type":"object","description":"This object contains the payment method details used","properties":{"cards":{"type":"object","description":"Object contains Card payment method details.","properties":{"cardNumber":{"type":"string","description":"The masked card number","minLength":13,"maxLength":19,"example":"414746******0083"},"expiryDate":{"type":"object","description":"Expriration date of the card","properties":{"month":{"type":"string","description":"Month of expiration","example":"03"},"year":{"type":"string","description":"Year of expiration","example":"2031"}}},"brand":{"type":"string","description":"Brand of the card","example":"VISA"}}},"tokenBasedTransaction":{"type":"object","properties":{"value":{"type":"string","description":"Object contains card payment method details.","example":"234ljl124l12"},"reusable":{"type":"boolean","description":"If the token is reusable.","default":true},"declinedDuplicates":{"type":"boolean","description":"If this parameter is set to true, the transaction will be declined if the card number entered has already been stored with a different token.","default":false},"cardNumber":{"type":"string","description":"The masked card number","example":"414746******0083"},"transactionSequence":{"type":"string","enum":["FIRST","SUBSEQUENT"],"description":"Indicates if the transaction is first or subsequent. Valid values are FIRST and SUBSEQUENT."},"schemeTransactionId":{"type":"string","description":"The transaction ID received from schemes for the initial transaction. May be required if sequence is 'SUBSEQUENT'.","maxLength":50,"example":"012243800355698"}},"required":["transactionSequence"]},"paymentMethodType":{"type":"string","description":"The payment type used for payment."}}},"ipgTransactionDetails":{"type":"object","properties":{"ipgTransactionId":{"type":"string","description":"The identifiers for this transaction on the various systems involved. Please use the ipgTransactionId on the payments inquiry service for further details. Please also note, that\ntransactionIdentfiers will depends on both previous requests (e.g. if no merchantTransactionId was provided, then we cannot return it later),\nbut also transaction process state (e.g. a processorReferenceNumber can and will only be returned, if the processor/authorisation system was successfully involved in processing).","example":"8154886515"},"transactionResult":{"type":"string","enum":["APPROVED","WAITING","PARTIAL","FAILED","DECLINED","FRAUD"],"description":"Gateway status of the transaction"},"approvalCode":{"type":"string","description":"Shows the transaction approval code.","example":"N:-30031:No terminal setup"}}},"requestSent":{"type":"object","description":"The checkout request resource, which gives the request details used while creating the checkout.","properties":{"merchantTransactionId":{"type":"string","description":"You can use this parameter to tag a unique identifier to this transaction for future reference.","maxLength":40,"example":"AB-1234"},"orderDetails":{"type":"object","description":"Object contains order related details.","properties":{"customerId":{"type":"string","description":"Customer ID for billing purpose. ","example":"1234567890"},"invoiceNumber":{"type":"string","description":"Invoice number created by merchant. ","maxLength":48,"example":"96126098"},"dynamicMerchantName":{"type":"string","description":"Dynamic merchant name for the statement.","pattern":"^(?!\\s*$).+","example":"Merchant XYZ"},"purchaseOrderNumber":{"type":"string","description":"Purchase order number released by merchant.","maxLength":128,"example":"123055342"},"basket":{"$ref":"#/components/schemas/Basket"},"billing":{"$ref":"#/components/schemas/Billing"},"shipping":{"$ref":"#/components/schemas/Shipping"}}},"checkoutSettings":{"$ref":"#/components/schemas/IntegrationDetails"},"paymentMethodDetails":{"$ref":"#/components/schemas/PaymentMethodDetails"}}}},"required":["storeId","checkoutId","transactionType","requestSent"]},"ErrorObject":{"type":"object","title":"ErrorObject","description":"This is the generic error response to be used for all errors sent back in responses.","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"Readable error message that could be displayed in a UI"},"detail":{"type":"string","description":"Further description provided to give wider context into the error"},"source":{"type":"string","description":"Optional: Known source of error such as missing or invalid field in a request"}},"required":["title","detail"]}}},"required":["errors"]}}},"security":[{"API-Key":[]}],"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}