{"openapi":"3.0.3","x-stoplight":{"id":"zpdnec2dfzk6s"},"info":{"title":"Payment links","description":"Create a payment link by passing the required parameters. This link can then be passed on to the end consumer to direct them to a checkout page. Redirect URLs are not applicable for Payment Links. Do not use this field when creating Payment Link requests. The payment result is displayed directly on the checkout page.","version":"1.0.3","contact":{"email":"online@support.natwest-tyl.com","name":"NatWest Payments","url":"https://natwestpayments-api-docs.readme.io/docs/overview"}},"paths":{"/payment-links":{"post":{"summary":"Create a payment link","description":"Create a payment link by passing the required parameters. This link can then be passed on to the end consumer to direct them to a checkout page. Redirect URLs are not applicable for Payment Links. Do not use this field when creating Payment Link requests. The payment result is displayed directly on the checkout page.","parameters":[{"$ref":"#/components/parameters/Client-Request-Id"},{"$ref":"#/components/parameters/Message-Signature"},{"$ref":"#/components/parameters/Timestamp"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLinkRequest"},"examples":{"Payment link":{"value":{"storeId":"72305408","merchantTransactionId":"AB-1234","transactionOrigin":"ECOM","transactionType":"SALE","transactionAmount":{"total":130,"currency":"GBP","components":{"subtotal":98,"vatAmount":22,"shipping":10}},"order":{"shipping":{"person":{"firstName":"John","lastName":"Doe","dateOfBirth":"1975-01-31"},"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"}},"billing":{"person":{"firstName":"John","lastName":"Doe","dateOfBirth":"1975-01-31"},"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"}},"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}]}},"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"}}},"paymentLinkDetails":{"expiryDateTime":"2022-08-23T10:56:27.561Z"}}}}},"application/xml":{"schema":{"$ref":"#/components/schemas/PaymentLinkRequest"}}},"description":""},"responses":{"201":{"description":"Payment link is successfully created along with payment link id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLinkResponse"}}},"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"}},"operationId":"postPaymentLinks","security":[{"API-Key":[]}]},"parameters":[]},"/payment-links/{paymentLinkId}":{"get":{"summary":"Get payment link details","description":"Retrieve payment link details by sending the payment link id as a URI parameter to the endpoint. Payment link id is generated along with the payment link.","parameters":[{"name":"paymentLinkId","description":"The short identifier for the payment link. Example `dBpYUi`.","in":"path","required":true,"schema":{"type":"string"},"allowEmptyValue":false}],"responses":{"200":{"description":"Success response. Payment link details associated with the ID are in response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrievePaymentLinkResponse"}}},"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/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"}},"operationId":"getPaymentLinks","security":[{"API-Key":[]}]},"parameters":[{"schema":{"type":"string","example":"dBpYUi"},"name":"paymentLinkId","in":"path","required":true,"description":"The short identifier for the payment link.  "}]}},"components":{"schemas":{"ErrorObject":{"title":"ErrorObject","x-stoplight":{"id":"vy40z8dhns216"},"type":"object","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"]},"StoreId":{"title":"StoreId","x-stoplight":{"id":"6lvuigs388mzm"},"type":"string","description":"Unique identifier for the respective store","example":"72305408","maxLength":20},"MerchantTransactionId":{"title":"MerchantTransactionId","x-stoplight":{"id":"c6rpjs5upp6vx"},"type":"string","example":"AB-1234","description":"You can use this parameter to tag a unique identifier to this transaction for future reference.","maxLength":40,"nullable":true},"TransactionOrigin":{"title":"TransactionOrigin","x-stoplight":{"id":"0rq0r0x3u0anr"},"type":"string","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`.","enum":["ECOM","MAIL","PHONE"],"default":"ECOM","example":"ECOM"},"TransactionType":{"title":"TransactionType","x-stoplight":{"id":"2453dedfb6b46"},"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"},"TransactionAmount":{"title":"TransactionAmount","x-stoplight":{"id":"s858f2myyu6n7"},"type":"object","properties":{"total":{"type":"number","example":130,"description":"This denotes your total amount of the order which includes vat, shipping cost, etc."},"currency":{"type":"string","description":"The three letter ISO currency code of the transaction. Only 'GBP' is supported currently.","maxLength":3,"example":"GBP"},"components":{"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","description":"Subtotal amount denotes the total of all line items and the discount applied on top of the order.","example":98,"nullable":true},"vatAmount":{"type":"number","description":"Value-added tax charged as part of this order.","example":22,"nullable":true},"shipping":{"type":"number","description":"Shipping cost charged as part of this order.","example":10,"nullable":true}}}},"required":["total","currency"]},"OrderDetails":{"title":"OrderDetails","x-stoplight":{"id":"ew53l8a7ixv92"},"type":"object","description":"Object containing order details","nullable":true,"properties":{"customerId":{"type":"string","description":"Customer ID for billing purpose.","maxLength":32,"example":"1234567890","nullable":true},"dynamicMerchantName":{"type":"string","description":"This is the merchant's name that appears on the card statement of the end consumer for this specific transaction.","pattern":"^(?!\\s*$).+","example":"Merchant XYZ","nullable":true},"invoiceNumber":{"type":"string","description":"Invoice number created by merchant.\n","example":"96126098","maxLength":48,"nullable":true},"purchaseOrderNumber":{"type":"string","description":"Purchase order number released by merchant.","example":"123055342","maxLength":128,"nullable":true}}},"Basket":{"title":"Basket","x-stoplight":{"id":"02r6kbhswucd9"},"type":"object","description":"Object indicates basket of items.","nullable":true,"properties":{"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/LineItems"}}}},"LineItems":{"title":"LineItems","x-stoplight":{"id":"1k7edp0fsclgy"},"type":"object","description":"The list of items included in the order.","properties":{"itemIdentifier":{"type":"string","description":"The unique identifier for the item in the basket.","example":"Item001","nullable":true},"name":{"type":"string","description":"Name of the item in the basket.","example":"Mobile","nullable":true},"price":{"type":"number","description":"Price of the item.","example":98,"nullable":true},"quantity":{"type":"number","description":"Quantity of the item.","example":1,"nullable":true},"shippingCost":{"type":"number","description":"Shipping cost for the item.","example":10,"nullable":true},"valueAddedTax":{"type":"number","description":"Value added tax amount on the items.","example":22,"nullable":true},"miscellaneousFee":{"type":"number","description":"Miscellaneous charges.","example":0,"nullable":true},"total":{"type":"number","description":"Total amount including shipping cost, VAT, miscellaneous charges for this line item.","example":130,"nullable":true}}},"Address":{"title":"Address","type":"object","description":"Object contains the customer address details.","properties":{"address1":{"type":"string","example":"House No: 2, street -5","description":"First line of the street address.","maxLength":96,"nullable":true},"address2":{"type":"string","example":"The Hill","description":"Second line of the street address.","maxLength":96,"nullable":true},"city":{"type":"string","example":"London","description":"City or locality.","maxLength":96,"nullable":true},"company":{"type":"string","example":"Test company","description":"Company name associated with the address.","maxLength":96,"nullable":true},"country":{"type":"string","example":"United Kingdom","description":"Full country name.","nullable":true},"postalCode":{"type":"string","example":"SE12SX","description":"ZIP code or postal code.","maxLength":24,"nullable":true},"region":{"type":"string","example":"Greater London","description":"State or province.","maxLength":96,"nullable":true}}},"Person":{"title":"Person","type":"object","description":"Object contains customer name and date of birth information.","properties":{"firstName":{"type":"string","example":"John","description":"First name of the customer.","maxLength":48,"nullable":true},"lastName":{"type":"string","example":"Doe","description":"Last name of the customer.","maxLength":48,"nullable":true},"dateOfBirth":{"type":"string","example":"1975-01-31","description":"Date of birth of the customer. Format YYYY-MM-DD.","format":"date","nullable":true}}},"Contact":{"title":"Contact","type":"object","description":"Object contains the customer contact details.","properties":{"phone":{"type":"string","description":"Primary phone number.","example":"4567278956","maxLength":32,"nullable":true},"mobilePhone":{"type":"string","description":"Mobile phone number.","example":"7834561235","maxLength":32,"nullable":true},"email":{"type":"string","description":"Email address.","example":"john@testemail.com","maxLength":256,"nullable":true},"fax":{"type":"string","description":"Fax number.","example":"5555555767","maxLength":32,"nullable":true}}},"Billing":{"title":"Billing","x-stoplight":{"id":"sw18z7lfmwh2r"},"type":"object","description":"Object contains the customer billing details.","nullable":true,"properties":{"person":{"$ref":"#/components/schemas/Person"},"contact":{"$ref":"#/components/schemas/Contact"},"address":{"$ref":"#/components/schemas/Address"}}},"Shipping":{"title":"Shipping","x-stoplight":{"id":"46v1wv639xr0i"},"type":"object","description":"Object contains the customer shipping details.","nullable":true,"properties":{"person":{"$ref":"#/components/schemas/Person"},"contact":{"$ref":"#/components/schemas/Contact"},"address":{"$ref":"#/components/schemas/Address"}}},"Order":{"title":"Order","x-stoplight":{"id":"ks25yx52xkq4j"},"type":"object","description":"Object contais order related details.","properties":{"orderId":{"$ref":"#/components/schemas/OrderId"},"shipping":{"$ref":"#/components/schemas/Shipping"},"billing":{"$ref":"#/components/schemas/Billing"},"orderDetails":{"$ref":"#/components/schemas/OrderDetails"},"basket":{"$ref":"#/components/schemas/Basket"}}},"RedirectBackUrls":{"title":"RedirectBackUrls","x-stoplight":{"id":"tj3xhh2dy14dp"},"type":"object","description":"Redirect URLs are not applicable for Payment Links. Do not use this field while creating Payment Link requests. The payment result is displayed directly on the payment-link page.","properties":{"successUrl":{"type":"string","example":"https://www.successexample.com","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()@:%_\\+.~#?&\\/=]*)"},"failureUrl":{"type":"string","example":"https://www.failureexample.com","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()@:%_\\+.~#?&\\/=]*)"}}},"CheckoutSettings":{"title":"CheckoutSettings","x-stoplight":{"id":"ln49drtbu7fg8"},"type":"object","properties":{"locale":{"type":"string","example":"en_GB","default":"en_GB","description":"Use this parameter to specify the language of the payment page. Currently supported languages are English(en_US),German(en_GB) etc.","nullable":true},"preSelectedPaymentMethod":{"type":"string","example":"cards","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,"nullable":true},"webHooksUrl":{"type":"string","example":"https://yourapp.com/data","description":"The URL endpoint to post the real time notifcation in the form of JSON payload. This url is provided by receiver application.","nullable":true},"redirectBackUrls":{"$ref":"#/components/schemas/RedirectBackUrls"}}},"PaymentMethodDetails":{"title":"PaymentMethodDetails","x-stoplight":{"id":"nl258r15kcgh4"},"type":"object","description":"Object contains payment method details. ","nullable":true,"properties":{"cards":{"type":"object","description":"Object contains card payment method details.","properties":{"authenticationPreferences":{"$ref":"#/components/schemas/ThreeDSPayment"},"createToken":{"$ref":"#/components/schemas/ZeroAuthPayment"},"tokenBasedTransaction":{"$ref":"#/components/schemas/TokenBasedTransaction"}}}}},"ThreeDSPayment":{"title":"ThreeDSPayment","x-stoplight":{"id":"5555f399dabf6"},"type":"object","nullable":true,"properties":{"authenticateTransaction":{"description":"Whether to process this payment as a 3-D Secure payment. If you want to enable 3-D Secure, specify \"true\" else \"false\".","default":true,"type":"boolean","example":true},"challengeIndicator":{"type":"string","example":"01","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)","enum":["01","02","03","04"],"default":"01","nullable":true},"scaExemptionType":{"type":"string","enum":["LOW_VALUE_EXEMPTION","TRUSTED_MERCHANT_EXEMPTION"],"description":"Strong customer authentication exemption type indicator.\nAllowed values: `LOW_VALUE_EXEMPTION`, `TRUSTED_MERCHANT_EXEMPTION`.","nullable":true},"skipTra":{"type":"boolean","default":false,"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.","nullable":true}}},"ZeroAuthPayment":{"title":"ZeroAuthPayment","x-stoplight":{"id":"rzbhlhsvpnduf"},"type":"object","description":"Object contains payment token details.","nullable":true,"properties":{"customTokenValue":{"type":"string","example":"234ljl124l12","description":"Client-supplied payment token value.","nullable":true},"declineDuplicateToken":{"type":"boolean","default":false,"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.","nullable":true},"reusable":{"type":"boolean","default":true,"description":"If the token is reusable.","nullable":true},"toBeUsedFor":{"type":"string","enum":["UNSCHEDULED","RECURRING","INSTALLMENT"],"example":"UNSCHEDULED","description":"This parameter is used to specify the type of transactions the token would be used for."}},"required":["toBeUsedFor"]},"TokenBasedTransaction":{"title":"TokenBasedTransaction","x-stoplight":{"id":"psw9vntpbrly7"},"type":"object","properties":{"value":{"type":"string","example":"234ljl124l12","description":"Client-supplied payment token value.","nullable":true},"transactionSequence":{"type":"string","enum":["FIRST","SUBSEQUENT"],"description":"Indicates if the transaction is first or subsequent. Valid values are FIRST and SUBSEQUENT."},"schemeTransactionId":{"type":"string","example":"012243800355698","description":"The transaction ID received from schemes for the initial transaction. May be required if sequence is 'SUBSEQUENT'.","maxLength":50}},"required":["transactionSequence"]},"PaymentLinkDetails":{"title":"PaymentLinkDetails","x-stoplight":{"id":"7kyy0p95y4to8"},"type":"object","properties":{"expiryDateTime":{"$ref":"#/components/schemas/ExpiryDateTime"}}},"PaymentLinkRequest":{"title":"PaymentLinkRequest","x-stoplight":{"id":"uf0suu98ussse"},"type":"object","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":{"shipping":{"person":{"firstName":"John","lastName":"Doe","dateOfBirth":"1975-01-31"},"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"}},"billing":{"person":{"firstName":"John","lastName":"Doe","dateOfBirth":"1975-01-31"},"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"}},"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}]}},"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"}}},"paymentLinkDetails":{"expiryDateTime":"2022-08-23T10:56:27.561Z"}}},"properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"merchantTransactionId":{"$ref":"#/components/schemas/MerchantTransactionId"},"transactionOrigin":{"$ref":"#/components/schemas/TransactionOrigin"},"transactionType":{"$ref":"#/components/schemas/TransactionType"},"transactionAmount":{"$ref":"#/components/schemas/TransactionAmount"},"order":{"$ref":"#/components/schemas/Order"},"checkoutSettings":{"$ref":"#/components/schemas/CheckoutSettings"},"paymentMethodDetails":{"$ref":"#/components/schemas/PaymentMethodDetails"},"paymentLinkDetails":{"$ref":"#/components/schemas/PaymentLinkDetails"}},"required":["storeId","transactionType","transactionAmount"]},"PaymentLinkResponse":{"title":"PaymentLinkResponse","x-stoplight":{"id":"hbtuoqvrv73ql"},"type":"object","properties":{"paymentLink":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"orderId":{"$ref":"#/components/schemas/OrderId"},"paymentLinkId":{"$ref":"#/components/schemas/PaymentLinkId"},"paymentLinkUrl":{"$ref":"#/components/schemas/PaymentLinkUrl"},"expiryDateTime":{"$ref":"#/components/schemas/ExpiryDateTime"}},"required":["storeId","paymentLinkId","paymentLinkUrl","expiryDateTime"]}}},"PaymentLinkId":{"title":"PaymentLinkId","x-stoplight":{"id":"jjdhzorsg73a1"},"type":"string","description":"The unique payment link ID againist which you want to process your transaction.","example":"dBpYUi"},"OrderId":{"title":"OrderId","x-stoplight":{"id":"1bqkkgsj131uh"},"type":"string","example":"31da1addc129a","maxLength":30,"description":"Unique alphanumeric identifier of the order. In case where this is not provided, a random unique identifier will be generated and assigned to the order."},"ExpiryDateTime":{"title":"ExpiryDateTime","x-stoplight":{"id":"zpvu4g5vunlfc"},"type":"string","description":"Payment link expiry date and time in ISO date format.","format":"date-time","example":"2022-08-23T10:56:27.561Z"},"PaymentLinkUrl":{"title":"PaymentLinkUrl","x-stoplight":{"id":"wc66vmle96zip"},"type":"string","example":"https://www.checkout-lane.com/pl/dBpYUi","description":"The payment link URL againist which you want to process your transaction."},"RetrievePaymentLinkResponse":{"title":"RetrievePaymentLinkResponse","x-stoplight":{"id":"quav4kchfzcul"},"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"paymentLink":{"type":"object","required":["active","paymentLinkId","paymentLinkUrl"],"properties":{"active":{"type":"boolean","description":"This is true if the payment link is still active."},"paymentLinkId":{"$ref":"#/components/schemas/PaymentLinkId"},"paymentLinkUrl":{"$ref":"#/components/schemas/PaymentLinkUrl"},"expiryDateTime":{"$ref":"#/components/schemas/ExpiryDateTime"}}},"checkoutId":{"type":"string","example":"f2dd6a9e-4a1c-4c30-9a0e-4ead4f59e909","description":"The unique identifier for this checkout."},"orderId":{"$ref":"#/components/schemas/OrderId"},"approvedAmount":{"$ref":"#/components/schemas/TransactionAmount"},"transactionType":{"$ref":"#/components/schemas/TransactionType"},"transactionStatus":{"type":"string","description":"Indicates the transaction status","enum":["INITIATED","APPROVED","WAITING","PARTIAL","FAILED","DECLINED","FRAUD"]},"transactionFailure":{"type":"object","description":"Indicates the transaction failure details, if occurred.","properties":{"code":{"type":"string","example":"2303","description":"Uniquely identifies an error condition. Client applications need to read and handle errors based on this."},"reason":{"type":"string","example":"Invalid credit card number","description":"A generic description of the error condition."}},"required":["code","reason"]},"paymentMethodUsed":{"type":"object","description":"This object contains the payment method details used.","properties":{"cards":{"type":"object","properties":{"cardNumber":{"type":"string","example":"414746******0083","minLength":13,"maxLength":19,"description":"The masked card number"},"expiryDate":{"type":"object","description":"Expriration date of the card","properties":{"month":{"type":"string","example":"03","description":"Month of expiration"},"year":{"type":"string","example":"2031","description":"Year of expiration"}}},"brand":{"type":"string","description":"Brand of the card","example":"VISA"}}},"tokenBasedTransaction":{"type":"object","properties":{"value":{"type":"string","example":"234ljl124l12","description":"Object contains Card payment method details."},"reusable":{"type":"boolean","description":"If the token is reusable."},"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."},"cardNumber":{"type":"string","description":"The masked card number","example":"414746******0083"},"transactionSequence":{"type":"string","description":"Indicates if the transaction is first or subsequent. Valid values are FIRST and SUBSEQUENT.","enum":["FIRST","SUBSEQUENT"],"example":"FIRST"},"schemeTransactionId":{"type":"string","description":"The transaction ID received from schemes for the initial transaction. May be required if sequence is 'SUBSEQUENT'.","example":"012243800355698"}},"required":["transactionSequence"]},"paymentMethodType":{"type":"string","x-stoplight":{"id":"9w17291x7vz7n"},"description":"The payment type used for payment."}}},"ipgTransactionDetails":{"type":"object","properties":{"ipgTransactionId":{"type":"string","example":"8154886515","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)."},"transactionStatus":{"type":"string","description":"Gateway status of the transaction","enum":["INITIATED","APPROVED","WAITING","PARTIAL","FAILED","DECLINED","FRAUD"]},"approvalCode":{"type":"string","description":"Shows the transaction approval code.","example":"Y:OK2964:4606888027:YYYX:851934"}}},"requestSent":{"type":"object","description":"The payment link request resource, which gives the request details used while creating the pay.","properties":{"merchantTransactionId":{"$ref":"#/components/schemas/MerchantTransactionId"},"orderDetails":{"type":"object","description":"Object contains order related details.","properties":{"customerId":{"type":"string","example":"1234567890","description":"Customer ID for billing purpose. "},"invoiceNumber":{"type":"string","description":"Invoice number created by merchant. ","example":"96126098","maxLength":48},"dynamicMerchantName":{"type":"string","description":"Dynamic merchant name for the statement.","example":"Merchant XYZ"},"purchaseOrderNumber":{"type":"string","description":"Purchase order number released by merchant.","example":"123055342"},"basket":{"$ref":"#/components/schemas/Basket"},"billing":{"$ref":"#/components/schemas/Billing"},"shipping":{"$ref":"#/components/schemas/Shipping"}}},"checkoutSettings":{"$ref":"#/components/schemas/CheckoutSettings"},"paymentMethodDetails":{"$ref":"#/components/schemas/PaymentMethodDetails"}}}},"required":["storeId","paymentLink","checkoutId","orderId","transactionType","transactionStatus","paymentMethodUsed","requestSent"]}},"securitySchemes":{"API-Key":{"name":"API-Key","type":"apiKey","in":"header"}},"parameters":{"Client-Request-Id":{"name":"Client-Request-Id","in":"header","required":true,"schema":{"type":"string","format":"uuid"},"description":"A client-generated ID for message signature creation, unique per request."},"Message-Signature":{"name":"Message-Signature","in":"header","required":true,"schema":{"type":"string"},"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."},"Timestamp":{"name":"Timestamp","in":"header","required":true,"schema":{"type":"string"},"description":"Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins)."}},"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."}}},"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."}}},"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."}}},"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."}}},"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."}}},"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."}}}}},"servers":[{"url":"https://prod.emea.api.fiservapps.com/sandbox/exp/v1","description":"Sandbox"},{"url":"https://prod.emea.api.fiservapps.com/exp/v1","description":"Production"}],"security":[{"API-Key":[]}],"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}