**Last updated**: 17 April 2026 | [**Change log**](/products/apms/changelog/) # Canada Electronic Funds Transfer (EFT) A direct debit for Canada based merchants. EFT allows your customers to pay by transferring funds directly from their bank account. details summary Product overview ### Processing Processing of EFT transactions happens overnight (or the next available working day at weekends and holidays). The handling bank issues regular reports outlining the successful and failed payments. Once the payment is successful, you can release the goods and services to the customer. ### Feature summary | Payment type | Countries | Currencies | Recurring | Reversals | Partial reversals | Chargebacks | | --- | --- | --- | --- | --- | --- | --- | | Direct Debit | CA | CAD | ❌ | ✅ | ❌ | ❌ | In some cases you may wish to cancel a sale request. You can do this using a [reversal request](/products/apms/openapi/payment-lifecycle/reverse). You must do this within three hours of the sale request, on the same Canada business day, or it will be processed as a refund. If your original reversal is not successful for any reason, you must re-send the reversal request after the three hour timeframe in order to make a refund request. Note Chargebacks and refunds can occur, and are managed directly at acquirer level. ## Get started Use our [API reference](/products/apms/openapi) and set your headers. ## Request `POST` `https://try.access.worldpay.com/apmPayments` ### Example requests ### Parameters ```json { "$ref": "#/components/schemas/ApmPaymentRequestV2", "components": { "schemas": { "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", "sepa": "#/components/schemas/SepaInstruction", "safetypay": "#/components/schemas/SafetypayInstruction", "swish": "#/components/schemas/SwishInstruction", "trustly": "#/components/schemas/TrustlyInstruction", "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/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/SwishInstruction" }, { "$ref": "#/components/schemas/TrustlyInstruction" }, { "$ref": "#/components/schemas/WeChatPayInstruction" }, { "$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" ] }, "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": "^[0-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 the 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": "The 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" ] }, "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" ] }, "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" ] }, "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" ] } }, "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": "The shopper'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" ] } }, "required": [ "country", "type" ] }, "ResultUrlsWithoutFailure": { "type": "object", "properties": { "cancel": { "type": "string", "description": "The URL where the shopper is redirected after payment cancellation.", "example": "https://worldpay.com/cancel", "minLength": 1 }, "pending": { "type": "string", "description": "The URL where the shopper is redirected after a pending payment", "example": "https://worldpay.com/pending", "minLength": 1 }, "success": { "type": "string", "description": "The URL where the shopper is redirected 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" ] }, "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": "The shopper'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" ] }, "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" ] }, "country": { "type": "string", "description": "The shopper'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" ] } }, "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" }, "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" ] }, "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 shopper 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)))." }, "totalDiscountsAmount": { "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" ] }, "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" ] }, "country": { "type": "string", "description": "The shopper'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" ] }, "country": { "type": "string", "description": "The shopper'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": "The shopper'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": "The shopper'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" ] } }, "required": [ "country", "type" ] }, "CustomerWithId": { "type": "object", "properties": { "customerId": { "type": "string", "description": "Your unique reference for the customer so that the 'pay faster next time' function can be used during checkout. This allows the shoppers chosen bank to be stored for their next payment.", "example": "44528abcd", "pattern": "^[a-zA-Z0-9]*$" }, "email": { "type": "string", "description": "The 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" ] }, "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": "The shopper'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" ] } }, "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" ] }, "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" ] }, "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" ] }, "SepaInstrumentV2": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of instruction", "enum": [ "direct", "token" ] }, "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" ] }, "SafetypayPaymentInstrumentV2": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of instrument.", "enum": [ "direct", "token" ] }, "country": { "type": "string", "description": "The shopper'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" ] }, "SwishPaymentInstrumentV2": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of instrument.", "enum": [ "direct", "token" ] }, "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, "minimum": 5, "maximum": 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" ] }, "country": { "type": "string", "description": "The shopper'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" ] }, "WeChatPayInstrumentV2": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of instruction", "enum": [ "direct" ] } }, "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 transaction 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" ] } } } } ``` ## Response ### Example response Successful ``` { "paymentInstrument": { "method": "eft", "type": "direct" }, "paymentId": "eyJrIjoiYXBtLXNlcnZpY2UtZGVmYXVsdCIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.BnnxxcMle38OazhwbF8J+4rtJi8CAq:Y3zUOn1dw6VWfvx:PHL5L0S+5ara5vz6ouV5yBmVUQCiSwQjs+1x5qJIJxAKWMWc2Mlb1doricEYlzsZIRIGCflvnYu1Ns8g1S0+66n6wCELiB9OHfX7cdDZM8QaH19DiFbmMAchPSTyxQUry+EjhI+4Av0FZgKybTQW8Eq5Lj6LFzcEh8YV9gKLyAJXKJwZGztDqfCZz9C54i7Qm6PznXY+lb8gjX08QbPuM7eN9CDfUDc8S4J3uauHV:lzKfpwhCpCj20XtN:AkTEXfvJEm8PKFuVlX10AbTZIsCMVbuMS1sIqrgbendo:b1Rfx8XquR8u:dBYr5a70wYkewsxOvrYXmLip3FvyJdzRzXf3LyUgHUqZh:ulvr2BwGjsfY6y32HN+osTE4dworCDzhGpsvEwJ:GRwLUNfeKBzVqK6WhJGqM+s8XpCA==", "lastEvent": "authorized", "_links": { "self": { "href": "https://try.access.worldpay.com/apmPayments/eyJrIjoiYXBtLXNlcnZpY2UtZGVmYXVsdCIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.BnnxxcMle38OazhwbF8J+4rtJi8CAq:Y3zUOn1dw6VWfvx:PHL5L0S+5ara5vz6ouV5yBmVUQCiSwQjs+1x5qJIJxAKWMWc2Mlb1doricEYlzsZIRIGCflvnYu1Ns8g1S0+66n6wCELiB9OHfX7cdDZM8QaH19DiFbmMAchPSTyxQUry+EjhI+4Av0FZgKybTQW8Eq5Lj6LFzcEh8YV9gKLyAJXKJwZGztDqfCZz9C54i7Qm6PznXY+lb8gjX08QbPuM7eN9CDfUDc8S4J3uauHV:lzKfpwhCpCj20XtN:AkTEXfvJEm8PKFuVlX10AbTZIsCMVbuMS1sIqrgbendo:b1Rfx8XquR8u:dBYr5a70wYkewsxOvrYXmLip3FvyJdzRzXf3LyUgHUqZh:ulvr2BwGjsfY6y32HN+osTE4dworCDzhGpsvEwJ:GRwLUNfeKBzVqK6WhJGqM+s8XpCA==" } }, "_actions": {}, "redirect": "", "commandId": "cmdSQBwMoFu3i2bNWmLGZLid0" } ``` Error response ```json { "errorName": "bodyDoesNotMatchSchema", "message": "The json body provided does not match the expected schema", "validationErrors": [ { "errorName": "fieldHasInvalidValue", "message": "Field is mandatory", "jsonPath": "$.instruction.value.amount" } ] } ``` ### Schema ```json { "$ref": "#/components/schemas/ApmPaymentResourceWithRedirectV2", "components": { "schemas": { "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 and add in the custom URL scheme: `swish://paymentrequest?token={token}&callbackurl={callbackURL}` as the token value. This will prompt the app to open where the customer can complete their payment.", "example": "IZQ3iUfePwiWiwldJlipl8NGVA7w5IUg" } } } } } } ``` #### Errors Check out our API reference for [more responses or error codes](/products/apms/openapi/other/payment#other/payment/response&c=400). **Next steps** [Manage your EFT payment](/products/apms/manage/).