{"templateId":"markdown","versions":[{"version":"20240701","label":"2024-07-01 (Latest)","link":"/products/apms/satispay","default":true,"active":true,"folderId":"c6e104b6"}],"sharedDataIds":{"sidebar":"sidebar-products/apms/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/apms/openapi","oas-products/apms/@20240701/openapi.yaml":"oas-products/apms/@20240701/openapi.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial","admonition","tabs","tab","openapi-code-sample","json-schema","code-snippet"]},"custom_product":"APMs","type":"markdown"},"seo":{"title":"Satispay","description":"Worldpay for Developers - docs, code examples, resources and tools. Everything you need to build your omnichannel payment solution.","siteUrl":"https://docs.worldpay.com/access","image":"/access/assets/worldpay-logo-light.21b7daf79984773a9fcd7d4fbcb07ae5289dfffd6023c4c3dca720c7058e53dc.33f780a6.svg","keywords":"documentation, api, openapi, sdks, developer, payments, json, payouts, 3ds","jsonLd":{"@context":"https://schema.org","@type":"Organization","url":"https://docs.worldpay.com/access","name":"Worldpay"},"meta":[{"name":"google-site-verification","content":"zjziIKaP3ImsqsfhYnEBnq1R85UabiSwl7HTXuwtZuo"},{"name":"doc_product","content":"Access"},{"name":"doc_category","content":"Documentation"}],"llmstxt":{"hide":false,"sections":[{"title":"Payments API","description":"Payment orchestration API combining fraud assessment, 3ds authentication, SCA exemptions, Worldpay Token creation and a card or wallet based payment.","includeFiles":["products/payments/@20240601/**/*"],"excludeFiles":[]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"],"excludeFiles":[]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"],"excludeFiles":[]},{"title":"3DS Authentication API","description":"Request 3DS authentication to protect against fraud, be SCA compliant and to shift liability using this standalone API.","includeFiles":["products/3ds/@v3/**/*"],"excludeFiles":[]},{"title":"FraudSight API","description":"Request a risk assessment and receive a response with an outcome (e.g. lowRisk) using this standalone API.","includeFiles":["products/fraudsight/@v1/**/*"],"excludeFiles":[]},{"title":"Checkout SDK","description":"Integrate using our clientside SDKs for both web and native devices. Benefit from SAQ-A/PCI-SSF compliance.","includeFiles":["products/checkout/web/@v2/**/*","products/checkout/ios/@v4/**/*","products/checkout/android/@v4/**/*","products/checkout/react-native/@v3/**/*","products/checkout/flutter/@v1/**/*"],"excludeFiles":[]},{"title":"Tokens API","description":"Minimizes the exposure of sensitive card details and increases the security of your customer's card details.","includeFiles":["products/tokens/@v3/**/*"],"excludeFiles":[]},{"title":"Card Payments API","description":"Request a card payment using this standalone API, requires separate requests for 3DS, Fraud assessment etc.","includeFiles":["products/card-payments/@v7/**/*"],"excludeFiles":[]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"],"excludeFiles":[]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"],"excludeFiles":[]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"],"excludeFiles":[]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"],"excludeFiles":[]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"],"excludeFiles":[]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"],"excludeFiles":[]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"],"excludeFiles":[]},{"title":"Hosted Payment Pages (HPP) API","description":"Our low-code option to take payments securely at the lowest PCI compliance level - SAQ A.","includeFiles":["products/hosted-payment-pages/@v1/**/*"],"excludeFiles":[]},{"title":"Money Transfers API","description":"Money Transfer OCTs (Original Credit Transaction) allow funds to be pushed to an eligible card in 30 minutes or less.","includeFiles":["products/money-transfers/@v1/**/*"],"excludeFiles":[]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"],"excludeFiles":[]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"],"excludeFiles":[]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"],"excludeFiles":[]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"],"excludeFiles":[]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"],"excludeFiles":[]},{"title":"Verified Tokens API","description":"Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.","includeFiles":["products/verified-tokens/@v3/**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last updated"]},": 26 June 2026 | ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/apms/changelog/"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Change log"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"satispay","__idx":0},"children":["Satispay"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Satispay is a digital wallet payment method that allows customers to pay for their online purchases using their phone number or via a QR code flow."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Make yourself familiar with our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/api-principles"},"children":["API principles"]}," to ensure a resilient integration."]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Product overview"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"feature-summary","__idx":1},"children":["Feature summary"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Payment type"},"children":["Payment type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Country"},"children":["Country"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Acceptance currency"},"children":["Acceptance currency"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Recurring"},"children":["Recurring"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Reversals"},"children":["Reversals"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Partial reversals"},"children":["Partial reversals"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Auth and settlement (sale)"},"children":["Auth and settlement (sale)"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["Digital wallet"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["Europe"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["EUR"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Refund - yes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Cancel - no"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Partial refund - yes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Partial cancel - no"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅ - after 15 minutes"]}]}]}]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Minimum transaction value: 1.00 EUR"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Maximum transaction value: 10,000 EUR equivalent"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"customer-journey","__idx":2},"children":["Customer journey"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/access/assets/satispay-shopper-experience.3a892cc0b0190b907f699e2521e556a6889d29b1981190aa4486feee9a182c82.05bf66c6.png","alt":"Customer journey in 5 steps"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your customer selects Satispay as their payment method on your checkout page. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["They are redirected to the Satispay payment page, which displays the Satispay QR code or, alternatively, your customer may enter their phone number. If your customer enters their phone number, their device receives a notification to authenticate and they skip to step 4.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your customer scans the QR code using the scan function within their Satispay mobile app and authenticates.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["They are presented with the transaction details and funding options. Your customer confirms the payment.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Satispay confirms that the payment is successful and returns your customer to your payment success page (defined by the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["successURL"]},")."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-started","__idx":3},"children":["Get started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/apms/openapi"},"children":["API reference"]}," and set your headers."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"request","__idx":4},"children":["Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/apmPayments"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request","__idx":5},"children":["Example request"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"API only","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Collect the APM details and send an API request with these details to create a payment."]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/apms/@20240701/openapi.yaml","operationId":"payment","exampleKey":"Satispay","parameters":{},"environments":{}},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters","__idx":6},"children":["Parameters"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"openapi.yaml#/components/schemas/ApmPaymentRequestV2"},"options":{"schemaExpansionLevel":0},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/ApmPaymentRequestV2"},"MerchantV2":{"type":"object","properties":{"entity":{"type":"string","description":"Used to route the request in Access Worldpay, created as part of on-boarding.","example":"default","maxLength":32,"minLength":3,"pattern":"^([a-zA-Z0-9\\- ]*)$"}},"required":["entity"]},"InstructionV2":{"type":"object","description":"Object that contains the payment type and details.","discriminator":{"mapping":{"ach":"#/components/schemas/AchInstruction","alipay_cn":"#/components/schemas/AlipayCnInstruction","alipay_hk":"#/components/schemas/AlipayHkInstruction","alipay_uni":"#/components/schemas/AlipayPlusInstruction","bancomat":"#/components/schemas/BancomatInstruction","bancontact":"#/components/schemas/BancontactInstruction","bizum":"#/components/schemas/BizumInstruction","blik":"#/components/schemas/BlikInstruction","eft":"#/components/schemas/EftInstruction","euteller":"#/components/schemas/EutellerInstruction","ideal":"#/components/schemas/IdealInstruction","klarna":"#/components/schemas/KlarnaNetworkInstruction","klarna_recurring":"#/components/schemas/KlarnaInstruction","konbini":"#/components/schemas/KonbiniInstruction","multibanco":"#/components/schemas/MultibancoInstruction","mybank":"#/components/schemas/MyBankInstruction","open_banking":"#/components/schemas/OpenBankingInstruction","paypal":"#/components/schemas/PayPalInstruction","paysafecard":"#/components/schemas/PaysafeCardInstruction","pix":"#/components/schemas/PixInstruction","przelewy":"#/components/schemas/PrzelewyInstruction","safetypay":"#/components/schemas/SafetypayInstruction","satispay":"#/components/schemas/SatispayInstruction","sepa":"#/components/schemas/SepaInstruction","swish":"#/components/schemas/SwishInstruction","trustly":"#/components/schemas/TrustlyInstruction","unionpay":"#/components/schemas/ChinaUnionPayInstruction","wechatpay":"#/components/schemas/WeChatPayInstruction"},"propertyName":"method"},"oneOf":[{"$ref":"#/components/schemas/PayPalInstruction"},{"$ref":"#/components/schemas/SepaInstruction"},{"$ref":"#/components/schemas/AlipayHkInstruction"},{"$ref":"#/components/schemas/AlipayCnInstruction"},{"$ref":"#/components/schemas/AlipayPlusInstruction"},{"$ref":"#/components/schemas/KlarnaInstruction"},{"$ref":"#/components/schemas/KlarnaNetworkInstruction"},{"$ref":"#/components/schemas/BancomatInstruction"},{"$ref":"#/components/schemas/BancontactInstruction"},{"$ref":"#/components/schemas/BizumInstruction"},{"$ref":"#/components/schemas/BlikInstruction"},{"$ref":"#/components/schemas/ChinaUnionPayInstruction"},{"$ref":"#/components/schemas/EutellerInstruction"},{"$ref":"#/components/schemas/IdealInstruction"},{"$ref":"#/components/schemas/KonbiniInstruction"},{"$ref":"#/components/schemas/MultibancoInstruction"},{"$ref":"#/components/schemas/MyBankInstruction"},{"$ref":"#/components/schemas/OpenBankingInstruction"},{"$ref":"#/components/schemas/PaysafeCardInstruction"},{"$ref":"#/components/schemas/PrzelewyInstruction"},{"$ref":"#/components/schemas/SafetypayInstruction"},{"$ref":"#/components/schemas/SatispayInstruction"},{"$ref":"#/components/schemas/SwishInstruction"},{"$ref":"#/components/schemas/TrustlyInstruction"},{"$ref":"#/components/schemas/WeChatPayInstruction"},{"$ref":"#/components/schemas/PixInstruction"},{"$ref":"#/components/schemas/AchInstruction"},{"$ref":"#/components/schemas/EftInstruction"}],"properties":{"method":{"type":"string","description":"Identifies the type of payment."}},"required":["method"]},"Value":{"type":"object","description":"The value of the payment.","properties":{"amount":{"type":"integer","format":"int64","description":"The amount in the lowest denomination of the currency e.g. pennies for GBP, cents for USD.","example":12,"minimum":1,"maximum":2147483647},"currency":{"type":"string","description":"The supported [ISO 4217 currency codes](/products/reference/supported-countries-currencies#iso-currency-codes).","enum":["AED","AFN","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLP","CNH","CNY","COP","CRC","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RWF","SAR","SBD","SCR","SEK","SGD","SHP","SLE","SLL","SOS","SRD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW"]}},"required":["amount","currency"]},"NarrativeBase":{"type":"object","properties":{"line1":{"type":"string","description":"The description shown on your customer's bank statement for the payment.","example":"MindPalace","maxLength":24,"minLength":1,"pattern":"^[a-zA-Z0-9-., ]*$"}},"required":["line1"]},"AchEftBillingAddress":{"type":"object","properties":{"address1":{"type":"string","maxLength":80,"minLength":1},"address2":{"type":"string","maxLength":80,"minLength":1},"address3":{"type":"string","maxLength":80,"minLength":1},"city":{"type":"string","description":"City.","maxLength":50,"minLength":1},"countryCode":{"type":"string","description":"The supported [ISO 3166-1 alpha-2 country codes](/products/reference/supported-countries-currencies#iso-country-codes).","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"postalCode":{"type":"string","description":"Postal code.","maxLength":15,"minLength":1},"state":{"type":"string","description":"State code of the billing address in ISO 3166-2 format.","example":"US-OH","maxLength":30,"minLength":1}}},"AchEftPaymentInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"The type of instrument.","enum":["direct","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"accountType":{"type":"string","description":"Account type.","enum":["checking","savings","corporate","corporateSavings"],"example":"checking"},"accountNumber":{"type":"string","description":"Account number of direct debit account.","maxLength":17,"minLength":1,"example":"123456789","pattern":"^[0-9]*$"},"routingNumber":{"type":"string","description":"Routing number of direct debit account.","maxLength":9,"minLength":9,"example":"123456789","pattern":"^[0-9]*$"},"checkNumber":{"type":"string","description":"Check number of the direct debit account.","maxLength":15,"minLength":1,"example":"123456789","pattern":"^[0-9]*$"},"companyName":{"type":"string","description":"Company name if a corporate account.","maxLength":40,"minLength":1,"example":"123456789","pattern":"^([a-zA-Z0-9 ]*)$"},"billingAddress":{"$ref":"#/components/schemas/AchEftBillingAddress"}},"required":["type","accountType","accountNumber","routingNumber","billingAddress"]},"CustomerDetailsAch":{"type":"object","properties":{"firstName":{"type":"string","description":"Your customer's first name.","maxLength":22,"minLength":1},"lastName":{"type":"string","description":"Your customer's last name.","maxLength":22,"minLength":1},"customerId":{"type":"string","description":"Your unique reference for your customer so that the 'pay faster next time' function can be used during checkout. This allows your customer's chosen bank to be stored for their next payment.","example":"44528abcd","maxLength":15,"pattern":"^[a-zA-Z0-9]*$"},"email":{"type":"string","description":"Your customer's e-mail address.","example":"customer@worldpay.com"}},"required":["firstName","lastName"]},"AchInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["ach"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/AchEftPaymentInstrumentV2"},"customer":{"$ref":"#/components/schemas/CustomerDetailsAch"}},"required":["value","narrative","paymentInstrument","customer"]},"AlipayCnInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"Type of instruction","enum":["direct","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"language":{"type":"string","description":"Your customer's language.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"required":["type"]},"ResultUrlsAlipay":{"type":"object","properties":{"cancel":{"type":"string","description":"The URL your customer is redirected to, after a cancelled payment outcome.","example":"https://worldpay.com/cancel"},"failure":{"type":"string","description":"The URL your customer is redirected to, after a failed payment outcome.","example":"https://worldpay.com/failure"},"pending":{"type":"string","description":"The URL your customer is redirected to, after a pending payment outcome.","example":"https://worldpay.com/pending"},"success":{"type":"string","description":"The URL your customer is redirected to, after a successful payment outcome.","example":"https://worldpay.com/success"}},"required":["failure","pending","success"]},"DeviceData":{"type":"object","properties":{"device":{"type":"string","description":"Device.","enum":["desktop","mobile"]},"operatingSystem":{"type":"string","description":"OS.","enum":["android","osx","windows","ios","linux","other"]}}},"CustomerWithName":{"type":"object","properties":{"firstName":{"type":"string","description":"Your customer's first name.","maxLength":22,"minLength":1},"lastName":{"type":"string","description":"Your customer's last name.","maxLength":22,"minLength":1},"email":{"type":"string","description":"Your customer's e-mail address.","maxLength":128,"minLength":1,"pattern":"^(.+@.+\\..+)?$","example":"moriarty@example.com"}}},"AlipayCnInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["alipay_cn"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/AlipayCnInstrumentV2"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsAlipay"},"deviceData":{"$ref":"#/components/schemas/DeviceData"},"customer":{"$ref":"#/components/schemas/CustomerWithName"}},"required":["value","narrative","paymentInstrument","resultUrls"]},"AlipayHkInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"Type of instruction","enum":["direct","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"country":{"type":"string","description":"The supported [ISO 3166-1 alpha-2 country codes](/products/reference/supported-countries-currencies#iso-country-codes).","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},"required":["type"]},"AlipayHkInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["alipay_hk"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/AlipayHkInstrumentV2"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsAlipay"},"deviceData":{"$ref":"#/components/schemas/DeviceData"},"customer":{"$ref":"#/components/schemas/CustomerWithName"}},"required":["value","narrative","paymentInstrument","resultUrls"]},"AlipayPlusInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"Type of instruction","enum":["direct","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"country":{"type":"string","description":"The supported [ISO 3166-1 alpha-2 country codes](/products/reference/supported-countries-currencies#iso-country-codes).","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},"required":["type"]},"AlipayPlusInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["alipay_uni"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/AlipayPlusInstrumentV2"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsAlipay"},"deviceData":{"$ref":"#/components/schemas/DeviceData"},"customer":{"$ref":"#/components/schemas/CustomerWithName"}},"required":["value","narrative","paymentInstrument","resultUrls"]},"BancomatPaymentInstrumentV2":{"type":"object","properties":{"country":{"type":"string","description":"Your customer's country, must be a supported ISO 3166-1 alpha-2 country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"GB"},"type":{"type":"string","description":"The type of instrument.","enum":["direct","token","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"}},"required":["country","type"]},"CustomerDetailsBancomat":{"type":"object","properties":{"firstName":{"type":"string","description":"Your customer's first name.","maxLength":22,"minLength":1},"lastName":{"type":"string","description":"Your customer's last name.","maxLength":22,"minLength":1},"phone":{"type":"string","description":"Phone number.","maxLength":20,"minLength":4,"pattern":"^[0-9]*$"},"email":{"type":"string","description":"Your customer's e-mail address.","maxLength":128,"minLength":1,"pattern":"^(.+@.+\\..+)?$","example":"moriarty@example.com"}},"required":["firstName","lastName","phone","email"]},"BancomatInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/BancomatPaymentInstrumentV2"},"customer":{"$ref":"#/components/schemas/CustomerDetailsBancomat"}}}],"required":["value","narrative","paymentInstrument","customer"]},"BancontactPaymentInstrumentV2":{"type":"object","properties":{"country":{"type":"string","description":"Your customer's country, must be a supported ISO 3166-1 alpha-2 country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"GB"},"type":{"type":"string","description":"The type of instrument.","enum":["direct","token","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"}},"required":["country","type"]},"ResultUrlsWithoutFailure":{"type":"object","properties":{"cancel":{"type":"string","description":"The URL your customer is redirected to, after a cancelled payment outcome.","example":"https://worldpay.com/cancel","minLength":1},"pending":{"type":"string","description":"The URL your customer is redirected to, after a pending payment outcome.","example":"https://worldpay.com/pending","minLength":1},"success":{"type":"string","description":"The URL your customer is redirected to, after a successful payment outcome.","example":"https://worldpay.com/success","minLength":1}},"required":["cancel","pending","success"]},"CustomerWithEmail":{"type":"object","properties":{"email":{"type":"string","description":"Your customer's e-mail address.","maxLength":128,"minLength":1,"pattern":"^(.+@.+\\..+)?$","example":"moriarty@example.com"}},"required":["email"]},"BancontactInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/BancontactPaymentInstrumentV2"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsWithoutFailure"},"customer":{"$ref":"#/components/schemas/CustomerWithEmail"}}}],"required":["value","narrative","paymentInstrument","resultUrls","customer"]},"BizumPaymentInstrument":{"type":"object","properties":{"type":{"type":"string","description":"The type of instrument.","enum":["direct","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},"required":["country","type"]},"CustomerWithPhone":{"type":"object","properties":{"phone":{"type":"string","description":"Your customer's phone number","example":"34700000001","minimum":5,"maximum":15,"pattern":"^[0-9]*$"}},"required":["phone"]},"BizumInstruction":{"allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object","properties":{"method":{"type":"string","description":"Type of payment method","enum":["bizum"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/BizumPaymentInstrument"},"customer":{"$ref":"#/components/schemas/CustomerWithPhone"}}}],"required":["value","narrative","customer","paymentInstrument"]},"BlikInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"Type of instruction","enum":["direct","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"country":{"type":"string","description":"The supported [ISO 3166-1 alpha-2 country codes](/products/reference/supported-countries-currencies#iso-country-codes).","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},"required":["type","country"]},"ResultUrlsBlik":{"type":"object","properties":{"success":{"type":"string","description":"The URL your customer is redirected to, after a successful payment outcome.","example":"https://worldpay.com/success"},"pending":{"type":"string","description":"The URL your customer is redirected to, after a pending payment outcome.","example":"https://worldpay.com/pending"},"cancel":{"type":"string","description":"The URL your customer is redirected to, after a cancelled payment outcome.","example":"https://worldpay.com/cancel"}},"required":["success","pending","cancel"]},"BlikInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["blik"]},"termsAccepted":{"type":"boolean","description":"You must collect your customer's consent to [Przelewy24's T&Cs](https://www.przelewy24.pl/regulamin) and pass the value as `true`. If the value is passed as `false`, your customer is redirected to a pending URL with an error appended."},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/BlikInstrumentV2"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsBlik"},"customer":{"$ref":"#/components/schemas/CustomerWithEmail"}},"required":["value","narrative","termsAccepted","paymentInstrument","resultUrls","customer"]},"EftInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["eft"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/AchEftPaymentInstrumentV2"},"customer":{"$ref":"#/components/schemas/CustomerDetailsAch"}},"required":["value","narrative","paymentInstrument","customer"]},"EutellerPaymentInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"The type of instrument.","enum":["direct","token","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"country":{"type":"string","description":"Your customer's country, must be a supported ISO 3166-1 alpha-2 country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"IT"}},"required":["type","country"]},"EutellerInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["euteller"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/EutellerPaymentInstrumentV2"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsWithoutFailure"},"customer":{"$ref":"#/components/schemas/CustomerWithEmail"}},"required":["value","narrative","paymentInstrument","resultUrls","customer"]},"IdealInstrument":{"type":"object","properties":{"type":{"type":"string","description":"Type of instruction","enum":["direct","token","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"}},"required":["type"]},"ResultUrlsIdeal":{"type":"object","properties":{"cancel":{"type":"string","description":"The URL your customer is redirected to, after a cancelled payment outcome.","example":"https://worldpay.com/cancel"},"failure":{"type":"string","description":"The URL your customer is redirected to, after a failed payment outcome.","example":"https://worldpay.com/failure"},"success":{"type":"string","description":"The URL your customer is redirected to, after a successful payment outcome.","example":"https://worldpay.com/success"}},"required":["success","failure","cancel"]},"CustomerWithEmailIdeal":{"type":"object","properties":{"email":{"type":"string","description":"E-mail address required for recurring.","maxLength":128,"minLength":1,"pattern":"^(.+@.+\\..+)?$","example":"moriarty@example.com"}}},"IdealMandate":{"type":"object","description":"Object that contains SEPA Direct Debit mandate information","properties":{"type":{"type":"string","description":"Field that contains the type of mandate.","enum":["recurring"]},"description":{"description":"Description why the recurring payment is being created.","type":"string","minLength":1,"maxLength":35}}},"CustomerAgreementIdeal":{"type":"object","description":"Object required for recurring payments.","properties":{"type":{"type":"string","description":"Field required for recurring payments.","enum":["recurring"]},"reference":{"type":"string","description":"A unique reference generated by you for recurring and token payments. This field must not have any spaces or start with \"_\".","minLength":1,"maxLength":64},"mandate":{"$ref":"#/components/schemas/IdealMandate"}}},"AddressV2":{"type":"object","properties":{"address1":{"type":"string","description":"Address.","maxLength":80,"minLength":1},"address2":{"type":"string","description":"Address.","maxLength":80,"minLength":1},"address3":{"type":"string","description":"Address.","maxLength":80,"minLength":1},"postalCode":{"type":"string","description":"Postal code.","maxLength":15,"minLength":1},"city":{"type":"string","description":"City.","maxLength":50,"minLength":1},"state":{"type":"string","description":"State.","maxLength":30,"minLength":1},"countryCode":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},"required":["address1","state","postalCode","city","countryCode"]},"ShippingRecurring":{"type":"object","description":"Object required for recurring payments.","properties":{"firstName":{"type":"string","description":"First name.","maxLength":22,"minLength":1},"lastName":{"type":"string","description":"Last name.","maxLength":22,"minLength":1},"address":{"$ref":"#/components/schemas/AddressV2"}}},"IdealInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["ideal"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/IdealInstrument"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsIdeal"},"customer":{"$ref":"#/components/schemas/CustomerWithEmailIdeal"},"customerAgreement":{"$ref":"#/components/schemas/CustomerAgreementIdeal"},"shipping":{"$ref":"#/components/schemas/ShippingRecurring"}},"required":["value","paymentInstrument","resultUrls"]},"KlarnaNetworkBillingAddress":{"type":"object","properties":{"firstName":{"type":"string","description":"First name.","maxLength":22,"minLength":1},"lastName":{"type":"string","description":"Last name.","maxLength":22,"minLength":1},"phone":{"type":"string","description":"Phone number.","maxLength":20,"minLength":4,"pattern":"^[0-9]*$"},"address1":{"type":"string","description":"Address.","maxLength":80,"minLength":1},"address2":{"type":"string","description":"Address.","maxLength":80,"minLength":1},"postalCode":{"type":"string","description":"Postal code.","maxLength":10,"minLength":1},"city":{"type":"string","description":"City.","maxLength":50,"minLength":1},"state":{"type":"string","description":"State.","maxLength":30,"minLength":1},"countryCode":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},"required":["address1","postalCode","city","countryCode"]},"KlarnaNetworkInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"Type of instruction","enum":["direct"]},"country":{"type":"string","description":"The supported [ISO 3166-1 alpha-2 country codes](/products/reference/supported-countries-currencies#iso-country-codes).","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"billingAddress":{"$ref":"#/components/schemas/KlarnaNetworkBillingAddress"}},"required":["type","language","country"]},"Settlement":{"description":"Indicates whether the transaction should be sent for settlement now = `true`, or later = `false` at a time of your choosing.","type":"object","properties":{"auto":{"type":"boolean","default":false}}},"ResultUrlsKlarnaNetwork":{"type":"object","properties":{"cancel":{"type":"string","description":"The URL your customer is redirected to, after a cancelled payment outcome.","minLength":1,"maxLength":1024,"example":"https://worldpay.com/cancel"},"failure":{"type":"string","description":"The URL your customer is redirected to, after a failed payment outcome.","minLength":1,"maxLength":1024,"example":"https://worldpay.com/failure"},"pending":{"type":"string","description":"The URL your customer is redirected to, after a pending payment outcome.","minLength":1,"maxLength":1024,"example":"https://worldpay.com/pending"},"success":{"type":"string","description":"The URL your customer is redirected to, after a successful payment outcome.","minLength":1,"maxLength":1024,"example":"https://worldpay.com/success"}},"required":["cancel","failure","pending","success"]},"AddressKlarnaNetworkShippingV2":{"type":"object","properties":{"address1":{"type":"string","description":"Address.","maxLength":80,"minLength":1},"address2":{"type":"string","description":"Address.","maxLength":80,"minLength":1},"postalCode":{"type":"string","description":"Postal code.","maxLength":10,"minLength":1},"city":{"type":"string","description":"City.","maxLength":50,"minLength":1},"state":{"type":"string","description":"State.","maxLength":30,"minLength":1},"countryCode":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},"required":["address1","postalCode","city","countryCode"]},"Courier":{"type":"object","properties":{"name":{"type":"string","description":"Name of the courier.","maxLength":255,"minLength":1},"preference":{"type":"string","enum":["contactlessDelivery","leaveAtDoor","leaveAtCurb","leaveWithNeighbor"]},"tracked":{"type":"boolean","description":"Whether the courier is tracked or not."},"identification":{"type":"boolean","description":"Indicates whether the courier requires identification for delivery."},"signatureRequired":{"type":"boolean","description":"Indicates whether the courier requires a signature for delivery."}}},"KlarnaNetworkShipping":{"type":"object","properties":{"firstName":{"type":"string","description":"First name.","maxLength":22,"minLength":1},"lastName":{"type":"string","description":"Last name.","maxLength":22,"minLength":1},"phone":{"type":"string","description":"Phone number.","maxLength":20,"minLength":4,"pattern":"^[0-9]*$"},"address":{"$ref":"#/components/schemas/AddressKlarnaNetworkShippingV2"},"timeFrame":{"type":"string","description":"Mandatory if being sent to an alternative non-residential address and must be sent together with `method`.","enum":["normal","express"]},"method":{"type":"string","description":"Mandatory if being sent to an alternative non-residential address. This is required for physical goods being sent to an address not specified by your customer.","enum":["physicalToDoor","physicalToCurb","physicalToMailbox","physicalPickupBox","physicalPickupPoint","physicalPickupStore","physicalPickupWarehouse","physicalOther","digitalEmail","digitalDownload","digitalOther"]},"courier":{"$ref":"#/components/schemas/Courier"}}},"KlarnaNetworkOrderItem":{"type":"object","description":"Object that contains details for one line of the order. There can be multiple object items.","properties":{"productCode":{"type":"string","description":"Your customer facing product code, e.g. SKU (Stock Keeping Unit) or similar.","maxLength":255,"minLength":1,"pattern":"^([a-zA-Z0-9]*)$"},"name":{"type":"string","description":"Description or name of item e.g., “Mobile Phone”.","maxLength":1024,"minLength":1,"pattern":"([a-zA-Z0-9 ]*)"},"quantity":{"type":"integer","description":"Number of items being purchased.","minimum":1},"unitCost":{"type":"integer","maximum":2147483648,"minimum":-2147483648,"description":"Cost for each unit of the item with tax included."},"totalTaxAmount":{"type":"integer","description":"How much of totalAmount is tax. If you need to work it out backwards the formula is: totalTaxAmount = totalAmount - (totalAmount / (1+(taxRate/10000))).","maximum":2147483648,"minimum":0},"totalAmount":{"type":"integer","description":"Sum of all chargeable elements on the line added together. Formula is: totalAmount = (unitCost x quantity) - totalDiscountAmount.","minimum":-2147483648,"maximum":2147483648},"productUrl":{"type":"string","description":"Link to the product page that can later be embedded in communications between Klarna and your customer.","maxLength":2048,"minLength":1},"imageUrl":{"type":"string","description":"Link to the product image that can later be embedded in communications between Klarna and your customer.\n\n Note: we recommend you submit this to improve the post-purchase customer experience.","minLength":1}},"required":["name","quantity","unitCost","totalTaxAmount","totalAmount"]},"KlarnaNetworkOrder":{"type":"object","description":"Object that contains the complete list of lines relating to the transaction.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/KlarnaNetworkOrderItem"}}},"required":["items","orderTotalTaxAmount","termsUrl"]},"KlarnaNetworkInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["klarna_network"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/KlarnaNetworkInstrumentV2"},"passthroughData":{"type":"string","description":"Passthrough field, we will treat the value you give here as an opaque string. Worldpay does not validate this field beyond checking length. Must contain escaped JSON ready for transmission.","maxLength":10240,"minLength":1},"providerToken":{"type":"string","description":"Provide Klarna’s “Klarna Network Session Token” here. This enables the continuation of your customer's journey when they start through Klarna's Web SDK or Klarna Boost features.","maxLength":8192,"minLength":1},"settlement":{"$ref":"#/components/schemas/Settlement"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsKlarnaNetwork"},"shipping":{"$ref":"#/components/schemas/KlarnaNetworkShipping"},"order":{"$ref":"#/components/schemas/KlarnaNetworkOrder"}},"required":["value","narrative","paymentInstrument","resultUrls"]},"KlarnaInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"Type of instruction","enum":["direct","token","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"country":{"type":"string","description":"The supported [ISO 3166-1 alpha-2 country codes](/products/reference/supported-countries-currencies#iso-country-codes).","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"language":{"type":"string","description":"Your customer's language.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"billingAddress":{"$ref":"#/components/schemas/AddressV2"}},"required":["type","language","country"]},"ResultUrlsKlarna":{"type":"object","properties":{"cancel":{"type":"string","description":"The URL your customer is redirected to, after a cancelled payment outcome.","example":"https://worldpay.com/cancel"},"failure":{"type":"string","description":"The URL your customer is redirected to, after a failed payment outcome.","example":"https://worldpay.com/failure"},"pending":{"type":"string","description":"The URL your customer is redirected to, after a pending payment outcome.","example":"https://worldpay.com/pending"},"success":{"type":"string","description":"The URL your customer is redirected to, after a successful payment outcome.","example":"https://worldpay.com/success"}},"required":["cancel","failure","pending","success"]},"KlarnaShipping":{"type":"object","properties":{"firstName":{"type":"string","description":"First name.","maxLength":22,"minLength":1},"lastName":{"type":"string","description":"Last name.","maxLength":22,"minLength":1},"phone":{"type":"string","description":"Phone number.","maxLength":20,"minLength":4,"pattern":"^[0-9]*$"},"email":{"type":"string","description":"Email address.","maxLength":128,"minLength":1,"pattern":"^(.+@.+\\..+)?$","example":"moriarty@example.com"},"address":{"$ref":"#/components/schemas/AddressV2"},"timeFrame":{"type":"string","description":"Mandatory if being sent to an alternative non-residential address and must be sent together with `method`.","enum":["normal","express"]},"method":{"type":"string","description":"Mandatory if being sent to an alternative non-residential address. This is required for physical goods being sent to an address not specified by your customer.","enum":["store pick up","pick up point","registered box","unregistered box"]}},"required":["firstName","lastName","phone","email","address"]},"CustomerAgreementKlarna":{"type":"object","description":"Object required for recurring payments that contains agreement information. Sending information in the object will create a Klarna token that can be used for token requests.","properties":{"type":{"type":"string","description":"Field required for recurring and token payments.","enum":["recurring"]},"description":{"type":"string","description":"Field required for recurring payments. Description of subscription, e.g. \"Monthly Lenses Plan\".","minLength":1,"maxLength":255},"agreementName":{"type":"string","description":"Name of the product on subscription, e.g. \"Contact lenses\" (displayed as it would be on a bill). The subscription name you send is accepted, regardless of whether it exists on your side.","minLength":1,"maxLength":255},"startDate":{"type":"string","description":"Field required for recurring payments. Start time for the billing period the payment is for.","format":"yyyy-mm-dd","pattern":"^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"},"endDate":{"type":"string","description":"Field required for recurring payments. End time for the billing period the payment is for.","format":"yyyy-mm-dd","pattern":"^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"},"affiliateName":{"type":"string","description":"Affiliate marketing name that makes the product memorable and impactful.","minLength":1,"maxLength":255}}},"CustomerWithAdditionalDetails":{"type":"object","properties":{"firstName":{"type":"string","description":"Your customer's first name.","maxLength":22,"minLength":1},"lastName":{"type":"string","description":"Your customer's last name.","maxLength":22,"minLength":1},"email":{"type":"string","description":"Your customer's e-mail address.","maxLength":128,"minLength":1,"pattern":"^(.+@.+\\..+)?$","example":"moriarty@example.com"},"phone":{"type":"string","description":"Phone number.","maxLength":20,"minLength":4,"pattern":"^[0-9]*$"},"dateOfBirth":{"type":"string","description":"Date of birth.","format":"yyyy-mm-dd","pattern":"^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"}}},"OrderItem":{"type":"object","description":"Object that contains details for one line of the order. There can be multiple object items.","properties":{"type":{"type":"string","description":"The type of item.","enum":["discount","digital","giftCard","physical","shippingFee","storeCredit","salesTaxType","surcharge"]},"productCode":{"type":"string","description":"Your customer-facing product code, e.g. SKU (Stock keeping unit) or similar.","maxLength":180,"minLength":1,"pattern":"^([a-zA-Z0-9]*)$"},"name":{"type":"string","description":"Description or Name of item e.g., “Mobile Phone”.","maxLength":260,"minLength":1,"pattern":"([a-zA-Z0-9 ]*)"},"quantity":{"type":"integer","description":"Number of items being purchased."},"unitOfMeasure":{"type":"string","description":"Free text field used to describe the unit of the item given, e.g. “kg”, “pcs”, “tickets”.","maxLength":8,"minLength":1,"pattern":"^([a-zA-Z0-9 ]*)$"},"unitCost":{"type":"integer","maximum":100000000,"minimum":1,"description":"Cost for each unit of the item with tax included."},"taxRate":{"type":"integer","maximum":10000,"minimum":0,"description":"Rate of tax as a percentage to be applied to the order line. Use the current tax rate on the date of order."},"totalTaxAmount":{"type":"integer","description":"How much of totalAmount is tax. If you need to work it out backwards the formula is: totalTaxAmount = totalAmount - (totalAmount / (1+(taxRate/10000)))."},"totalDiscountAmount":{"type":"integer","description":"Total line discount."},"totalAmount":{"type":"integer","description":"Sum of all chargeable elements on the line added together. Formula is: totalAmount = (unitCost x quantity) - totalDiscountAmount."},"productUrl":{"type":"string","description":"Link to the product page that can later be embedded in communications between Klarna and your customer.","maxLength":1024,"minLength":1},"imageUrl":{"type":"string","description":"Link to the product image that can later be embedded in communications between Klarna and your customer.\n\n Note: we recommend you submit this to improve the post-purchase customer experience.","maxLength":1024,"minLength":1}},"required":["type","name","quantity","unitCost","taxRate","totalTaxAmount","totalAmount","productCode"]},"Order":{"type":"object","description":"Object that contains the complete list of lines relating to the transaction.","properties":{"orderTotalTaxAmount":{"type":"integer","description":"Sum of all tax in the order. A validation mechanism is in place to verify the tax calculations provided are correct and match the line level tax amounts."},"termsUrl":{"type":"string","description":"Link to your “Terms and Conditions”.","maxLength":1024,"minLength":1},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}}},"required":["items","orderTotalTaxAmount","termsUrl"]},"KlarnaInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["klarna"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/KlarnaInstrumentV2"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsKlarna"},"shipping":{"$ref":"#/components/schemas/KlarnaShipping"},"customerAgreement":{"$ref":"#/components/schemas/CustomerAgreementKlarna"},"customer":{"$ref":"#/components/schemas/CustomerWithAdditionalDetails"},"order":{"$ref":"#/components/schemas/Order"}},"required":["value","narrative","paymentInstrument","resultUrls","order"]},"KonbiniInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"Type of instruction","enum":["direct","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"country":{"type":"string","description":"The supported [ISO 3166-1 alpha-2 country codes](/products/reference/supported-countries-currencies#iso-country-codes).","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},"required":["type","country"]},"ResultUrlsKonbini":{"type":"object","properties":{"pending":{"type":"string","description":"The URL your customer is redirected to, after a pending payment outcome.","example":"https://worldpay.com/pending"}},"required":["pending"]},"CustomerDetailsKonbini":{"type":"object","properties":{"lastName":{"type":"string","description":"Your customer's last name.","maxLength":10,"minLength":1},"phone":{"type":"string","description":"Phone number.","maxLength":11,"minLength":10,"pattern":"^[0-9]*$"},"email":{"type":"string","description":"Your customer's e-mail address.","maxLength":128,"minLength":1,"pattern":"^(.+@.+\\..+)?$","example":"moriarty@example.com"}},"required":["lastName","phone","email"]},"KonbiniInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["konbini"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/KonbiniInstrumentV2"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsKonbini"},"customer":{"$ref":"#/components/schemas/CustomerDetailsKonbini"}},"required":["value","narrative","paymentInstrument","resultUrls","customer"]},"MultibancoPaymentInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"The type of instrument.","enum":["direct","token","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"country":{"type":"string","description":"Your customer's country, must be a supported ISO 3166-1 alpha-2 country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"IT"}},"required":["type","country"]},"MultibancoInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["multibanco"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/MultibancoPaymentInstrumentV2"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsWithoutFailure"},"customer":{"$ref":"#/components/schemas/CustomerWithEmail"}},"required":["value","narrative","paymentInstrument","resultUrls","customer"]},"MyBankPaymentInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"The type of instrument.","enum":["direct","token","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"country":{"type":"string","description":"Your customer's country, must be a supported ISO 3166-1 alpha-2 country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"IT"}},"required":["type","country"]},"CustomerWithMandatoryName":{"type":"object","properties":{"firstName":{"type":"string","description":"Your customer's first name.","maxLength":22,"minLength":1},"lastName":{"type":"string","description":"Your customer's last name.","maxLength":22,"minLength":1},"email":{"type":"string","description":"Your customer's e-mail address.","maxLength":128,"minLength":1,"pattern":"^(.+@.+\\..+)?$","example":"moriarty@example.com"}},"required":["email","firstName","lastName"]},"MyBankInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["mybank"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/MyBankPaymentInstrumentV2"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsWithoutFailure"},"customer":{"$ref":"#/components/schemas/CustomerWithMandatoryName"}},"required":["value","narrative","paymentInstrument","resultUrls","customer"]},"OpenBankingPaymentInstrumentV2":{"type":"object","properties":{"bankCode":{"type":"string","description":"36-character bank GUID must be included to be considered an SDK request. This is a bank identifier from the bank selection step on the SDK.","maxLength":36,"minLength":0,"pattern":"^[a-zA-Z0-9]+$"},"country":{"type":"string","description":"Your customer's country, must be a supported ISO 3166-1 alpha-2 country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"GB"},"language":{"type":"string","description":"Your customer's language, must be a supported ISO 639-1 language code.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"type":{"type":"string","description":"The type of instrument.","enum":["direct","token","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"}},"required":["country","type"]},"CustomerWithId":{"type":"object","properties":{"customerId":{"type":"string","description":"Your unique reference for your customer so that the 'pay faster next time' function can be used during checkout. This allows your customer's chosen bank to be stored for their next payment.","example":"44528abcd","pattern":"^[a-zA-Z0-9]*$"},"email":{"type":"string","description":"Your customer's e-mail address.","example":"customer@worldpay.com"}},"required":["email"]},"ResultUrlsOpenBanking":{"type":"object","properties":{"success":{"type":"string","description":"The URL your customer is redirected to, after a successful payment outcome.","example":"https://worldpay.com/success"},"pending":{"type":"string","description":"The URL your customer is redirected to, after a pending payment outcome.","example":"https://worldpay.com/pending"},"cancel":{"type":"string","description":"The URL your customer is redirected to, after a cancelled payment outcome.","example":"https://worldpay.com/cancel"},"failure":{"type":"string","description":"The URL your customer is redirected to, after a failed payment outcome.","example":"https://worldpay.com/failure"}},"required":["success","pending","cancel","failure"]},"OpenBankingInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"expiryIn":{"type":"integer","format":"int32","description":"Field is used for Pay by Link request. This parameter controls how many minutes a payment link will be available.","minimum":30,"maximum":43200,"example":120},"paymentInstrument":{"$ref":"#/components/schemas/OpenBankingPaymentInstrumentV2"},"customer":{"$ref":"#/components/schemas/CustomerWithId"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsOpenBanking"}}}],"required":["value","narrative","paymentInstrument","customer","resultUrls"]},"PayPalBillingAddressV2":{"type":"object","properties":{"address1":{"type":"string","maxLength":80,"minLength":1},"address2":{"type":"string","maxLength":80,"minLength":1},"address3":{"type":"string","maxLength":80,"minLength":1},"city":{"type":"string","description":"Only optional for country code `SG` (Singapore).","maxLength":50,"minLength":1},"countryCode":{"type":"string","description":"The supported [ISO 3166-1 alpha-2 country codes](/products/reference/supported-countries-currencies#iso-country-codes).","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]},"postalCode":{"type":"string","description":"Only optional for country code IE (Ireland).","maxLength":15,"minLength":1},"state":{"type":"string","maxLength":30,"minLength":1}}},"PayPalInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"Type of instruction","enum":["direct","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"billingAddress":{"$ref":"#/components/schemas/PayPalBillingAddressV2"}},"required":["type"]},"ResultUrls":{"type":"object","properties":{"cancel":{"type":"string","description":"The URL your customer is redirected to, after a cancelled payment outcome.","example":"https://worldpay.com/cancel"},"failure":{"type":"string","description":"The URL your customer is redirected to, after a failed payment outcome.","example":"https://worldpay.com/failure"},"pending":{"type":"string","description":"The URL your customer is redirected to, after a pending payment outcome.","example":"https://worldpay.com/pending"},"success":{"type":"string","description":"The URL your customer is redirected to, after a successful payment outcome.","example":"https://worldpay.com/success"}}},"Shipping":{"type":"object","description":"The shipping address is required for recurring payments.","properties":{"firstName":{"type":"string","description":"First name.","maxLength":22,"minLength":1},"lastName":{"type":"string","description":"Last name.","maxLength":22,"minLength":1},"email":{"type":"string","description":"Email address.","maxLength":128,"minLength":1,"pattern":"^(.+@.+\\..+)?$","example":"moriarty@example.com"},"address":{"$ref":"#/components/schemas/AddressV2"}}},"Customer":{"type":"object","properties":{"email":{"type":"string","description":"Your customer's e-mail address.","maxLength":128,"minLength":1,"pattern":"^(.+@.+\\..+)?$","example":"moriarty@example.com"}}},"PayPalInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["paypal"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/PayPalInstrumentV2"},"settlement":{"$ref":"#/components/schemas/Settlement"},"resultUrls":{"$ref":"#/components/schemas/ResultUrls"},"shipping":{"$ref":"#/components/schemas/Shipping"},"customer":{"$ref":"#/components/schemas/Customer"}},"required":["value","narrative","paymentInstrument"]},"PaysafeCardPaymentInstrumentV2":{"type":"object","properties":{"country":{"type":"string","description":"Your customer's country, must be a supported ISO 3166-1 alpha-2 country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"GB"},"type":{"type":"string","description":"The type of instrument.","enum":["direct","token","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"}},"required":["country","type"]},"PaysafeCardInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/PaysafeCardPaymentInstrumentV2"},"customer":{"$ref":"#/components/schemas/CustomerWithEmail"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsWithoutFailure"}}}],"required":["value","narrative","paymentInstrument","customer","resultUrls"]},"PixInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"Type of instruction","enum":["direct","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"country":{"type":"string","description":"The supported [ISO 3166-1 alpha-2 country codes](/products/reference/supported-countries-currencies#iso-country-codes).","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},"required":["type","country"]},"IdentityDocuments":{"type":"object","description":"Object that contains identity document information.","properties":{"reference":{"type":"string","description":"Serial number of customer's identity document which is being sent for payment creation. This is a conditional field which, if sent, must be accompanied with serial number of the document and customer's first name and last name. Must be 11 chars for CPF and 14 chars in case of CNPJ."},"type":{"type":"string","description":"Type of customer's identity document which is being sent for payment creation. This is a conditional field which, if sent, must be accompanied with serial number of the document and customer's first name and last name. It can be either CPF or CNPJ.","enum":["CPF","CNPJ"]}}},"CustomerWithIdentity":{"type":"object","properties":{"firstName":{"type":"string","description":"Your customer's first name.","maxLength":22,"minLength":1},"lastName":{"type":"string","description":"Your customer's last name.","maxLength":22,"minLength":1},"identityDocuments":{"$ref":"#/components/schemas/IdentityDocuments"}}},"PixInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["pix"]},"expiryIn":{"type":"integer","format":"int64","description":"Time the QR code will remain valid, in seconds. If not provided, the default value of 86400 seconds is set."},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/PixInstrumentV2"},"customer":{"$ref":"#/components/schemas/CustomerWithIdentity"}},"required":["value","narrative","paymentInstrument"]},"PrzelewyInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"Type of instruction","enum":["direct","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"country":{"type":"string","description":"The supported [ISO 3166-1 alpha-2 country codes](/products/reference/supported-countries-currencies#iso-country-codes).","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},"required":["type","country"]},"ResultUrlsPrzelewy":{"type":"object","properties":{"success":{"type":"string","description":"The URL your customer is redirected to, after a successful payment outcome.","example":"https://worldpay.com/success"},"pending":{"type":"string","description":"The URL your customer is redirected to, after a pending payment outcome.","example":"https://worldpay.com/pending"},"cancel":{"type":"string","description":"The URL your customer is redirected to, after a cancelled payment outcome.","example":"https://worldpay.com/cancel"}},"required":["success","pending","cancel"]},"PrzelewyInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["przelewy"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/PrzelewyInstrumentV2"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsPrzelewy"},"customer":{"$ref":"#/components/schemas/CustomerWithEmail"}},"required":["value","narrative","paymentInstrument","resultUrls","customer"]},"SafetypayPaymentInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"The type of instrument.","enum":["direct","token","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"country":{"type":"string","description":"Your customer's country, must be a supported ISO 3166-1 alpha-2 country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"SE"}},"required":["type","country"]},"SafetypayInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["safetypay"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/SafetypayPaymentInstrumentV2"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsWithoutFailure"},"customer":{"$ref":"#/components/schemas/CustomerWithEmail"}},"required":["value","narrative","paymentInstrument","resultUrls","customer"]},"SatispayPaymentInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"The type of instrument.","enum":["direct"]},"country":{"type":"string","description":"Your customer's country, must be a supported ISO 3166-1 alpha-2 country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"IT"}},"required":["type","country"]},"SatispayInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["satispay"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/SatispayPaymentInstrumentV2"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsWithoutFailure"},"customer":{"$ref":"#/components/schemas/CustomerWithName"}},"required":["value","narrative","paymentInstrument","resultUrls","customer"]},"SepaInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"Type of instruction","enum":["direct","token","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"iban":{"type":"string","description":"IBAN (International Bank Account Number)."},"accountHolderName":{"type":"string","description":"Account holder name."},"language":{"type":"string","description":"Your customer's language.","enum":["de","en","es","fr","it","nl"]},"billingAddress":{"$ref":"#/components/schemas/AddressV2"},"swiftBic":{"type":"string","description":"SEPA Direct Debit transactions to non-EEA countries require a BIC code, in addition to an IBAN. This attribute is mandatory for the UK, Switzerland, Monaco, Andorra, San Marino, Vatican city and Gibraltar.","maxLength":11,"minLength":8,"pattern":"^[a-zA-Z0-9]+$"}},"required":["type","iban","accountHolderName","billingAddress"]},"Mandate":{"type":"object","description":"Object that contains SEPA Direct Debit mandate information","properties":{"type":{"description":"Field that contains the type of SEPA Direct Debit mandate. For SEPA  Direct Debit guest checkouts the value is `oneTime` and for a recurring payment the value is `recurring`.","enum":["oneTime","recurring"]},"mandateId":{"description":"Unique reference created by you which identifies each e-Mandate signed by your customer. See our [formatting requirements overview](/products/articles/sepa-emandate-and-best-practice#mandate-ids).","type":"string","minLength":1,"maxLength":35},"mandateSignatureDate":{"description":"ISO 8601 date-time (yyyy-mm-dd) when mandate has been signed.","type":"string"},"description":{"description":"Description why the recurring payment is being created.","type":"string","minLength":1,"maxLength":35}},"required":["type","mandateId"]},"CustomerAgreementSepa":{"type":"object","description":"Object that contains agreement information.","properties":{"type":{"type":"string","description":"Field required for oneTime and recurring payments.","enum":["oneTime","recurring"]},"mandate":{"$ref":"#/components/schemas/Mandate"}},"required":["mandate"]},"SepaInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["sepa"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/SepaInstrumentV2"},"customer":{"$ref":"#/components/schemas/Customer"},"customerAgreement":{"$ref":"#/components/schemas/CustomerAgreementSepa"}},"required":["value","narrative","paymentInstrument","customer","customerAgreement"]},"SwishPaymentInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"The type of instrument.","enum":["direct","token","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"country":{"type":"string","description":"The supported [ISO 3166-1 alpha-2 country codes](/products/reference/supported-countries-currencies#iso-country-codes).","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"SE"}},"required":["type","country"]},"CustomerWithOptionalPhone":{"type":"object","properties":{"phone":{"type":"string","description":"Your customer's phone number","example":"34700000001","minLength":5,"maxLength":15,"pattern":"^[0-9]*$"}}},"SwishInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["swish"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/SwishPaymentInstrumentV2"},"customer":{"$ref":"#/components/schemas/CustomerWithOptionalPhone"}},"required":["value","narrative","paymentInstrument"]},"TrustlyPaymentInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"The type of instrument.","enum":["direct","token","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"},"country":{"type":"string","description":"Your customer's country, must be a supported ISO 3166-1 alpha-2 country code.","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"example":"GB"}},"required":["type","country"]},"TrustlyInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["trustly"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/TrustlyPaymentInstrumentV2"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsWithoutFailure"},"customer":{"$ref":"#/components/schemas/CustomerWithEmail"}},"required":["value","narrative","paymentInstrument","resultUrls","customer"]},"ChinaUnionPayPaymentInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"The type of instrument.","enum":["direct"]},"language":{"type":"string","description":"Your customer's language.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"required":["type","language"]},"ResultUrlsChinaUnionPay":{"type":"object","properties":{"success":{"type":"string","description":"The URL your customer is redirected to, after a successful payment outcome.","example":"https://worldpay.com/success"},"pending":{"type":"string","description":"The URL your customer is redirected to, after a pending payment outcome.","example":"https://worldpay.com/pending"},"failure":{"type":"string","description":"The URL your customer is redirected to, after a failed payment outcome.","example":"https://worldpay.com/failure"}}},"ChinaUnionPayInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["unionpay"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"paymentInstrument":{"$ref":"#/components/schemas/ChinaUnionPayPaymentInstrumentV2"},"resultUrls":{"$ref":"#/components/schemas/ResultUrlsChinaUnionPay"}},"required":["value","narrative","paymentInstrument"]},"WeChatPayInstrumentV2":{"type":"object","properties":{"type":{"type":"string","description":"Type of instruction","enum":["direct","checkout"]},"sessionHref":{"type":"string","format":"uri","description":"URL of the session in which customer fields can be saved via Components SDK.\n\n**Note:** This field is **required** when making requests where the type is `checkout`.\n"}},"required":["type"]},"WeChatPayInstruction":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstructionV2"},{"type":"object"}],"properties":{"method":{"type":"string","description":"Type of payment method","enum":["wechatpay"]},"value":{"$ref":"#/components/schemas/Value"},"narrative":{"$ref":"#/components/schemas/NarrativeBase"},"expiryIn":{"type":"integer","format":"int64","description":"Payment expiration limit in minutes, with a value between 1 and 120","example":15,"minimum":1,"maximum":120},"paymentInstrument":{"$ref":"#/components/schemas/WeChatPayInstrumentV2"}},"required":["value","narrative","paymentInstrument"]},"ApmPaymentRequestV2":{"type":"object","properties":{"transactionReference":{"type":"string","maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_/!@#$%()*=.:;?\\[\\]{}~+]*$","description":"For Bizum transactions, please follow this extra regex [a-zA-Z0-9]{4,12}"},"orderReference":{"description":"A reference that you can apply to one or more payments according to your business needs. You may reuse the same reference across multiple payments, for example where:\n - the total amount for a single order is split across multiple payments\n - you use a single reference for each payment in a recurring agreement or split shipment scenario","type":"string","maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_/!@#$%()*=.:;?\\[\\]{}~+]*$"},"merchant":{"$ref":"#/components/schemas/MerchantV2"},"instruction":{"$ref":"#/components/schemas/InstructionV2"}},"required":["instruction","merchant","transactionReference"]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response","__idx":7},"children":["Response"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response","__idx":8},"children":["Example response"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Successful","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/satispay/response.json","header":{"controls":{"copy":{}}},"source":"{\n    \"paymentInstrument\": {\n        \"method\": \"satispay\",\n        \"type\": \"direct\"\n    },\n    \"paymentId\": \"eyJrIjoiYXBtLXNlcnZpY2UtbG9jYWwiLCJsaW5rVmVyc2lvbiI6IjYuMC4wIn0=.BnnxxcMle38OazhwbF8J+4rtJi8CAq:Y3zUOn1dw6VWfvx:PHL5L0S+5ara5vz6ouV5yBmVUQCiSwQjs+1x5qJIJxAKWMWc2Mlb1doricEYlzsZIRIGCflvnYu1Ns8g1S0+66n6wCELiB9OHfX7cdDZM8QaH19DiFbmMAchPSTy3YhKhjHb7eU81eSTnCsB+em66NOYspir3PJsMwGsI7DgQG6H8RA6ud004Gi7UbmmWuCYako2x2qLNAoCkV0HeDe9tVGUUJ8RPRm2jMHH20eHV:lzKfpwhCpCj20XtN:CPsSI2e:sopgZlkbmyvzDIeWSIThE3J1pPGsapqefRFo:b1Rfx8XquR8u:dBYr5a70wYkewsxOvrYXmLip3Fvy7rdfTE9SB:F5xmui5ij57ItzoUGQqmhdlJEFtZOvawnk19rQ8+2IHhZzeukzTZ41bET6DfydrjX20ywVxbq2Jw==\",\n    \"lastEvent\": \"pending\",\n    \"_links\": {\n        \"self\": {\n            \"href\": \"https://try.access.worldpay.com/apmPayments/eyJrIjoiYXBtLXNlcnZpY2UtbG9jYWwiLCJsaW5rVmVyc2lvbiI6IjYuMC4wIn0=.BnnxxcMle38OazhwbF8J+4rtJi8CAq:Y3zUOn1dw6VWfvx:PHL5L0S+5ara5vz6ouV5yBmVUQCiSwQjs+1x5qJIJxAKWMWc2Mlb1doricEYlzsZIRIGCflvnYu1Ns8g1S0+66n6wCELiB9OHfX7cdDZM8QaH19DiFbmMAchPSTy3YhKhjHb7eU81eSTnCsB+em66NOYspir3PJsMwGsI7DgQG6H8RA6ud004Gi7UbmmWuCYako2x2qLNAoCkV0HeDe9tVGUUJ8RPRm2jMHH20eHV:lzKfpwhCpCj20XtN:CPsSI2e:sopgZlkbmyvzDIeWSIThE3J1pPGsapqefRFo:b1Rfx8XquR8u:dBYr5a70wYkewsxOvrYXmLip3Fvy7rdfTE9SB:F5xmui5ij57ItzoUGQqmhdlJEFtZOvawnk19rQ8+2IHhZzeukzTZ41bET6DfydrjX20ywVxbq2Jw==\"\n        }\n    },\n    \"_actions\": {},\n    \"redirect\": \"http://secure-test.worldpay.com/redirect?tokenId=dc9c308b-d56b-4823-968e-0f94b20d6b73\",\n    \"commandId\": \"cmdOl8x_MaK4TxcF3exdl5cL0\"\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Error response","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/error.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n  \"errorName\": \"bodyDoesNotMatchSchema\",\n  \"message\": \"The json body provided does not match the expected schema\",\n  \"validationErrors\": [\n    {\n      \"errorName\": \"fieldHasInvalidValue\",\n      \"message\": \"Field is mandatory\",\n      \"jsonPath\": \"$.instruction.value.amount\"\n    }\n  ]\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"schema","__idx":9},"children":["Schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"openapi.yaml#/components/schemas/ApmPaymentResourceWithRedirectV2"},"options":{"schemaExpansionLevel":0},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/ApmPaymentResourceWithRedirectV2"},"SelfLink":{"type":"object","description":"The URL you can invoke to fetch the last event for the payment.","properties":{"href":{"type":"string"}}},"Links":{"type":"object","description":"Links to resources related to the request.","properties":{"self":{"$ref":"#/components/schemas/SelfLink"}}},"ActionLinkV2":{"type":"object","description":"Link to resources to reverse operation.","properties":{"href":{"type":"string"},"method":{"type":"string"}}},"Actions":{"type":"object","properties":{"reverse":{"$ref":"#/components/schemas/ActionLinkV2"},"partialReverse":{"$ref":"#/components/schemas/ActionLinkV2"},"settle":{"$ref":"#/components/schemas/ActionLinkV2"},"partialSettle":{"$ref":"#/components/schemas/ActionLinkV2"},"confirmPayment":{"$ref":"#/components/schemas/ActionLinkV2"}}},"PaymentInstrumentResponse":{"type":"object","properties":{"method":{"type":"string"},"type":{"type":"string"},"sdkReference":{"description":"SDK token used for PayPal Smart Button flow","type":"string"}}},"ApmPaymentResourceWithRedirectV2":{"type":"object","description":"A payment resource, with a URL for your customer to continue the payment.","properties":{"paymentId":{"type":"string","description":"The identifier of the payment resource."},"lastEvent":{"type":"string","enum":["authorized","cancelFailed","cancelled","cancelRequested","sentForSettlement","sentForAuthorization","settlementFailed","chargebackReversed","chargedBack","disputeExpired","disputeFundsHeld","disputeFundsReleased","disputeReserveReleased","error","expired","disputeInformationRequested","disputInformationSupplied","miscellaneous","pending","refunded","refundExpired","refundFailed","refundReversed","refused","refusedByIssuer","requestExpired","sentForRefund","settled","settlementReversed","cancelledByCustomer","signedFormReceived","unknown","manuallyAmended"]},"_links":{"$ref":"#/components/schemas/Links"},"_actions":{"$ref":"#/components/schemas/Actions"},"redirect":{"type":"string","description":"The URL to redirect your customer to, or a QR code in Base64 to show to your customer, in order to complete the transaction."},"paymentInstrument":{"$ref":"#/components/schemas/PaymentInstrumentResponse"},"commandId":{"type":"string","description":"An action ID generated by us identifying a single merchant interaction","example":"cmdYNdIHBPJwbkjLiykzTx0"},"transactionCode":{"type":"string","description":"For **Pix payments** - display to your customer for them to copy and paste in the Pix app.\n\n For **Swish payments** - use this value as the {token} in the custom URL scheme: `swish://paymentrequest?token={token}&callbackurl={callbackURL}`. This will prompt the app to open, allowing your customer to complete their payment.","example":"IZQ3iUfePwiWiwldJlipl8NGVA7w5IUg"}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"errors","__idx":10},"children":["Errors"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Check out our API reference for ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/apms/openapi/other/payment#other/payment/response&c=400"},"children":["more responses or error codes"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"simulation","__idx":11},"children":["Simulation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Simulate payment outcomes and trigger webhooks in our Try environment by sending a request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Upon sending a payment request, you receive the payment status ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]},". Follow the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redirect"]}," link to our simulator where you can choose between different payment outcomes:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Simulator outcome option"},"children":["Simulator outcome option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Payment status"},"children":["Payment status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pending"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pending payment response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorised"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payment authorized successfully. After 15 minutes, payment is captured automatically."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cancelled"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancelledByCustomer"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unsuccessful payment - your customer has cancelled the payment in the Satispay app."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Refused"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refused"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unsuccessful payment - failure response from the provider."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error in processing the payment or the session timed out."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/apms/openapi/payment-lifecycle/query"},"children":["Query the payment"]}," to receive the desired payment status."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To simulate a refund, first select the \"authorised\" simulator outcome. After 15 minutes the payment is automatically captured - with the status ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentForSettlement"]},". Query the payment after this time and call the next action reversal link to receive the status ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentForRefund"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Next steps"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/apms/manage/"},"children":["Manage your Satispay payment"]}]}]},"headings":[{"value":"Satispay","id":"satispay","depth":1},{"value":"Feature summary","id":"feature-summary","depth":3},{"value":"Customer journey","id":"customer-journey","depth":3},{"value":"Get started","id":"get-started","depth":2},{"value":"Request","id":"request","depth":2},{"value":"Example request","id":"example-request","depth":3},{"value":"Parameters","id":"parameters","depth":3},{"value":"Response","id":"response","depth":2},{"value":"Example response","id":"example-response","depth":3},{"value":"Schema","id":"schema","depth":3},{"value":"Errors","id":"errors","depth":4},{"value":"Simulation","id":"simulation","depth":2}],"frontmatter":{"seo":{"title":"Satispay"}},"lastModified":"2026-06-25T15:18:23.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/apms/satispay","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}