{"items":[{"type":"link","label":"APM API","link":"/products/apms/20230601/openapi","routeSlug":"/products/apms/20230601/openapi","content":{"contentType":"overview","meta":{"name":"APM API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/access/_bundle/products/apms/@20230601/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/apms/@20230601/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"go","title":"Go","lang":"Go"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"csharp","title":"C#","lang":"C#"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"description":"Try","url":"https://try.access.worldpay-bsh.securedataplatform.co.uk"},{"description":"Live","url":"https://access.worldpay-bsh.securedataplatform.co.uk"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"APM API (2023-06-01)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set your headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"    Authorization: {your_credentials}\n    Content-Type: application/json\n    WP-Api-Version: 2023-06-01\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"    Authorization: {your_credentials}\n    Content-Type: application/json\n    WP-Api-Version: 2023-06-01\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replace "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{your_credentials}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with your base64-encoded Basic Auth username and password."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNS whitelisting"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whitelist the following URLs:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://try.access.worldpay-bsh.securedataplatform.co.uk/"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://access.worldpay-bsh.securedataplatform.co.uk/"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please ensure you use DNS whitelisting, not explicit IP whitelisting."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you make a request within Access Worldpay, you should always cache the response returned."},"children":[]}]}]}]}],"sectionId":"/products/apms/20230601/openapi"}],"sectionId":"/products/apms/20230601/openapi"}]}]}},{"label":"Create an APM payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/apms/20230601/openapi/other/payment","routeSlug":"/products/apms/20230601/openapi/other/payment","metadata":{"seo":{"title":"Create an APM payment","description":"Perform a sale."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payment","name":"Create an APM payment","isWebhook":false,"pointer":"/paths/~1apmPayments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an APM payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Perform a sale."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_305","description":"The content type of the request body.","required":true},{"name":"WP-Api-Version","in":"header","schemaId":"schema_306","description":"The API version.","required":true}],"pointer":"/paths/~1apmPayments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApmPaymentRequest","exampleIds":["paths/~1apmPayments/post/requestBody/content/application~1json/examples/PayPal","paths/~1apmPayments/post/requestBody/content/application~1json/examples/iDEAL","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Alipay","paths/~1apmPayments/post/requestBody/content/application~1json/examples/AlipayHK","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Bancontact","paths/~1apmPayments/post/requestBody/content/application~1json/examples/BLIK","paths/~1apmPayments/post/requestBody/content/application~1json/examples/China UnionPay","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Euteller","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Konbini","paths/~1apmPayments/post/requestBody/content/application~1json/examples/MyBank","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Open Banking","paths/~1apmPayments/post/requestBody/content/application~1json/examples/paysafecard","paths/~1apmPayments/post/requestBody/content/application~1json/examples/POLi NZ","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Przelewy24","paths/~1apmPayments/post/requestBody/content/application~1json/examples/SafetyPay","paths/~1apmPayments/post/requestBody/content/application~1json/examples/SEPA Direct Debit","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Trustly"]}},"schemaId":"components/schemas/ApmPaymentRequest","exampleIds":["paths/~1apmPayments/post/requestBody/content/application~1json/examples/PayPal","paths/~1apmPayments/post/requestBody/content/application~1json/examples/iDEAL","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Alipay","paths/~1apmPayments/post/requestBody/content/application~1json/examples/AlipayHK","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Bancontact","paths/~1apmPayments/post/requestBody/content/application~1json/examples/BLIK","paths/~1apmPayments/post/requestBody/content/application~1json/examples/China UnionPay","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Euteller","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Konbini","paths/~1apmPayments/post/requestBody/content/application~1json/examples/MyBank","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Open Banking","paths/~1apmPayments/post/requestBody/content/application~1json/examples/paysafecard","paths/~1apmPayments/post/requestBody/content/application~1json/examples/POLi NZ","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Przelewy24","paths/~1apmPayments/post/requestBody/content/application~1json/examples/SafetyPay","paths/~1apmPayments/post/requestBody/content/application~1json/examples/SEPA Direct Debit","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Trustly"],"pointer":"/paths/~1apmPayments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/apmPayments","servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Try"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_305"},{"name":"WP-Api-Version","in":"header","required":true,"schemaId":"schema_306"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApmPaymentRequest","exampleIds":["paths/~1apmPayments/post/requestBody/content/application~1json/examples/PayPal","paths/~1apmPayments/post/requestBody/content/application~1json/examples/iDEAL","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Alipay","paths/~1apmPayments/post/requestBody/content/application~1json/examples/AlipayHK","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Bancontact","paths/~1apmPayments/post/requestBody/content/application~1json/examples/BLIK","paths/~1apmPayments/post/requestBody/content/application~1json/examples/China UnionPay","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Euteller","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Konbini","paths/~1apmPayments/post/requestBody/content/application~1json/examples/MyBank","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Open Banking","paths/~1apmPayments/post/requestBody/content/application~1json/examples/paysafecard","paths/~1apmPayments/post/requestBody/content/application~1json/examples/POLi NZ","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Przelewy24","paths/~1apmPayments/post/requestBody/content/application~1json/examples/SafetyPay","paths/~1apmPayments/post/requestBody/content/application~1json/examples/SEPA Direct Debit","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Trustly"]}},"responseCodes":["201","400","401","415","500"],"pointer":"/apmPayments","href":"other/payment","openApiOperationId":"payment","summary":"Create an APM payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Try"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"schemaId":"components/schemas/ApmPaymentRequest","exampleIds":["paths/~1apmPayments/post/requestBody/content/application~1json/examples/PayPal","paths/~1apmPayments/post/requestBody/content/application~1json/examples/iDEAL","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Alipay","paths/~1apmPayments/post/requestBody/content/application~1json/examples/AlipayHK","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Bancontact","paths/~1apmPayments/post/requestBody/content/application~1json/examples/BLIK","paths/~1apmPayments/post/requestBody/content/application~1json/examples/China UnionPay","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Euteller","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Konbini","paths/~1apmPayments/post/requestBody/content/application~1json/examples/MyBank","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Open Banking","paths/~1apmPayments/post/requestBody/content/application~1json/examples/paysafecard","paths/~1apmPayments/post/requestBody/content/application~1json/examples/POLi NZ","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Przelewy24","paths/~1apmPayments/post/requestBody/content/application~1json/examples/SafetyPay","paths/~1apmPayments/post/requestBody/content/application~1json/examples/SEPA Direct Debit","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Trustly"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApmPaymentRequest","exampleIds":["paths/~1apmPayments/post/requestBody/content/application~1json/examples/PayPal","paths/~1apmPayments/post/requestBody/content/application~1json/examples/iDEAL","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Alipay","paths/~1apmPayments/post/requestBody/content/application~1json/examples/AlipayHK","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Bancontact","paths/~1apmPayments/post/requestBody/content/application~1json/examples/BLIK","paths/~1apmPayments/post/requestBody/content/application~1json/examples/China UnionPay","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Euteller","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Konbini","paths/~1apmPayments/post/requestBody/content/application~1json/examples/MyBank","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Open Banking","paths/~1apmPayments/post/requestBody/content/application~1json/examples/paysafecard","paths/~1apmPayments/post/requestBody/content/application~1json/examples/POLi NZ","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Przelewy24","paths/~1apmPayments/post/requestBody/content/application~1json/examples/SafetyPay","paths/~1apmPayments/post/requestBody/content/application~1json/examples/SEPA Direct Debit","paths/~1apmPayments/post/requestBody/content/application~1json/examples/Trustly"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Request successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_307","exampleIds":["paths/~1apmPayments/post/responses/201/content/application~1json/examples/Full example"]}},"schemaId":"schema_307","exampleIds":["paths/~1apmPayments/post/responses/201/content/application~1json/examples/Full example"]},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/400/content/application~1json/examples/Example"]},{"code":"401","description":"Client is not authorized due to missing or invalid Authorization header.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/401/content/application~1json/examples/Example"]},{"code":"415","description":"Invalid content-type HTTP header.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/415/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/415/content/application~1json/examples/Example"]},{"code":"500","description":"A problem occurred processing the request on our side.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1apmPayments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_307","exampleIds":["paths/~1apmPayments/post/responses/201/content/application~1json/examples/Full example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_307","exampleIds":["paths/~1apmPayments/post/responses/201/content/application~1json/examples/Full example"]}}},{"code":"400","schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/401/content/application~1json/examples/Example"]}}},{"code":"415","schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/415/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/415/content/application~1json/examples/Example"]}}},{"code":"500","schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments/post/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/payment"}],"panels":[]}]},"httpPath":"/apmPayments"},{"type":"group","label":"Payment lifecycle","link":"/products/apms/20230601/openapi/payment-lifecycle","routeSlug":"/products/apms/20230601/openapi/payment-lifecycle","items":[{"label":"Get the last event for an APM payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/apms/20230601/openapi/payment-lifecycle/query","routeSlug":"/products/apms/20230601/openapi/payment-lifecycle/query","metadata":{"seo":{"title":"Get the last event for an APM payment","description":"Lookup the state of a payment, including the available action that can be performed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"query","name":"Get the last event for an APM payment","isWebhook":false,"pointer":"/paths/~1apmPayments~1{paymentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the last event for an APM payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lookup the state of a payment, including the available action that can be performed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentId","in":"path","schemaId":"schema_308","description":"The identifier of the payment resource.","required":true}],"pointer":"/paths/~1apmPayments~1{paymentId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-Api-Version","in":"header","schemaId":"schema_306","description":"The API version","required":true}],"pointer":"/paths/~1apmPayments~1{paymentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/apmPayments/{paymentId}","servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Try"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"parameters":{"path":[{"name":"paymentId","in":"path","required":true,"schemaId":"schema_308"}],"query":[],"querystring":[],"header":[{"name":"WP-Api-Version","in":"header","required":true,"schemaId":"schema_306"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404","415","500"],"pointer":"/apmPayments/{paymentId}","href":"payment-lifecycle/query","openApiOperationId":"query","summary":"Get the last event for an APM payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Try"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApmPaymentResource","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/authorized","paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/pending","paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/sentForRefund","paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/sentForSettlement"]}},"schemaId":"components/schemas/ApmPaymentResource","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/authorized","paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/pending","paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/sentForRefund","paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/sentForSettlement"]},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/400/content/application~1json/examples/Example"]},{"code":"401","description":"Client is not authorized due to missing or invalid Authorization header.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"Payment resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/404/content/application~1json/examples/Example"]},{"code":"415","description":"Invalid content-type HTTP header.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/415/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/415/content/application~1json/examples/Example"]},{"code":"500","description":"A problem occurred processing the request on our side.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1apmPayments~1{paymentId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApmPaymentResource","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/authorized","paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/pending","paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/sentForRefund","paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/sentForSettlement"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApmPaymentResource","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/authorized","paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/pending","paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/sentForRefund","paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/sentForSettlement"]}}},{"code":"400","schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/400/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/404/content/application~1json/examples/Example"]}}},{"code":"415","schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/415/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/415/content/application~1json/examples/Example"]}}},{"code":"500","schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}/get/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-lifecycle/query"}],"panels":[]}]},"httpPath":"/apmPayments/{paymentId}"},{"label":"Reverse an APM payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/apms/20230601/openapi/payment-lifecycle/partialreverse","routeSlug":"/products/apms/20230601/openapi/payment-lifecycle/partialreverse","metadata":{"seo":{"title":"Reverse an APM payment","description":"Perform a reversal on the funds taken from a sale."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"partialReverse","name":"Reverse an APM payment","isWebhook":false,"pointer":"/paths/~1apmPayments~1{paymentId}~1reversals/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reverse an APM payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Perform a reversal on the funds taken from a sale."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentId","in":"path","schemaId":"schema_308","description":"The identifier of the payment resource.","required":true}],"pointer":"/paths/~1apmPayments~1{paymentId}~1reversals/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_305","description":"The content type of the request body.","required":true},{"name":"WP-Api-Version","in":"header","schemaId":"schema_306","description":"The API version.","required":true}],"pointer":"/paths/~1apmPayments~1{paymentId}~1reversals/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_309"}},"schemaId":"schema_309","pointer":"/paths/~1apmPayments~1{paymentId}~1reversals/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/apmPayments/{paymentId}/reversals","servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Try"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"parameters":{"path":[{"name":"paymentId","in":"path","required":true,"schemaId":"schema_308"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_305"},{"name":"WP-Api-Version","in":"header","required":true,"schemaId":"schema_306"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_309"}},"responseCodes":["202","400","401","404","500"],"pointer":"/apmPayments/{paymentId}/reversals","href":"payment-lifecycle/partialreverse","openApiOperationId":"partialReverse","summary":"Reverse an APM payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Try"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"schemaId":"schema_309","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_309"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Request successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApmPaymentResource","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/202/content/application~1json/examples/Full example"]}},"schemaId":"components/schemas/ApmPaymentResource","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/202/content/application~1json/examples/Full example"]},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/400/content/application~1json/examples/Example"]},{"code":"401","description":"Client is not authorized due to missing or invalid Authorization header.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"Payment resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/404/content/application~1json/examples/Example"]},{"code":"500","description":"A problem occurred processing the request on our side.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1apmPayments~1{paymentId}~1reversals/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/ApmPaymentResource","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/202/content/application~1json/examples/Full example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApmPaymentResource","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/202/content/application~1json/examples/Full example"]}}},{"code":"400","schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/404/content/application~1json/examples/Example"]}}},{"code":"500","schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1reversals/post/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-lifecycle/partialreverse"}],"panels":[]}]},"httpPath":"/apmPayments/{paymentId}/reversals"},{"label":"Settle an APM payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/apms/20230601/openapi/payment-lifecycle/settle","routeSlug":"/products/apms/20230601/openapi/payment-lifecycle/settle","metadata":{"seo":{"title":"Settle an APM payment","description":"Perform a settlement on authorized funds. Not all APMs support this, please check the links returned from querying a payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"settle","name":"Settle an APM payment","isWebhook":false,"pointer":"/paths/~1apmPayments~1{paymentId}~1settlements/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settle an APM payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Perform a settlement on authorized funds. Not all APMs support this, please check the links returned from querying a payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentId","in":"path","schemaId":"schema_308","description":"The identifier of the payment resource.","required":true}],"pointer":"/paths/~1apmPayments~1{paymentId}~1settlements/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_305","description":"The content type of the request body.","required":true},{"name":"WP-Api-Version","in":"header","schemaId":"schema_306","description":"The API version.","required":true}],"pointer":"/paths/~1apmPayments~1{paymentId}~1settlements/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_310"}},"schemaId":"schema_310","pointer":"/paths/~1apmPayments~1{paymentId}~1settlements/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/apmPayments/{paymentId}/settlements","servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Try"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"parameters":{"path":[{"name":"paymentId","in":"path","required":true,"schemaId":"schema_308"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_305"},{"name":"WP-Api-Version","in":"header","required":true,"schemaId":"schema_306"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_310"}},"responseCodes":["202","400","401","404","500"],"pointer":"/apmPayments/{paymentId}/settlements","href":"payment-lifecycle/settle","openApiOperationId":"settle","summary":"Settle an APM payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Try"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"schemaId":"schema_310","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_310"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Request successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApmPaymentResourceWithRedirect","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/202/content/application~1json/examples/Full example"]}},"schemaId":"components/schemas/ApmPaymentResourceWithRedirect","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/202/content/application~1json/examples/Full example"]},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/400/content/application~1json/examples/Example"]},{"code":"401","description":"Client is not authorized due to missing or invalid Authorization header.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/401/content/application~1json/examples/Example"]},{"code":"404","description":"Payment resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/404/content/application~1json/examples/Example"]},{"code":"500","description":"A problem occurred processing the request on our side.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1apmPayments~1{paymentId}~1settlements/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/ApmPaymentResourceWithRedirect","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/202/content/application~1json/examples/Full example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApmPaymentResourceWithRedirect","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/202/content/application~1json/examples/Full example"]}}},{"code":"400","schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/400/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/401/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiValidationErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/404/content/application~1json/examples/Example"]}}},{"code":"500","schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessApiErrorResponse","exampleIds":["paths/~1apmPayments~1{paymentId}~1settlements/post/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-lifecycle/settle"}],"panels":[]}]},"httpPath":"/apmPayments/{paymentId}/settlements"}],"content":{"contentType":"group","meta":{"name":"Payment lifecycle"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment lifecycle","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/apmPayments/{paymentId}","summary":"Get the last event for an APM payment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-lifecycle/query","deprecated":false},{"title":"/apmPayments/{paymentId}/reversals","summary":"Reverse an APM payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-lifecycle/partialreverse","deprecated":false},{"title":"/apmPayments/{paymentId}/settlements","summary":"Settle an APM payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-lifecycle/settle","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AccessApiErrorResponse":{"id":"components/schemas/AccessApiErrorResponse","kind":"json-schema","title":"AccessApiErrorResponse","data":{"type":"object","properties":{"errorName":{"type":"string"},"message":{"type":"string"}}}},"components/schemas/AccessApiValidationError":{"id":"components/schemas/AccessApiValidationError","kind":"json-schema","title":"AccessApiValidationError","data":{"type":"object"}},"components/schemas/AccessApiValidationErrorResponse":{"id":"components/schemas/AccessApiValidationErrorResponse","kind":"json-schema","title":"AccessApiValidationErrorResponse","data":{"type":"object","properties":{"errorName":{"type":"string"},"message":{"type":"string"},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/AccessApiValidationError"}}}}},"components/schemas/Actions":{"id":"components/schemas/Actions","kind":"json-schema","title":"Actions","data":{"type":"object","description":"Actions that can be performed on the payment resource. These are dynamic based on factors such as the payment instrument and state of the payment.","properties":{"partialReverse":{"$ref":"#/components/schemas/PartialReverseLink"},"reverse":{"$ref":"#/components/schemas/ReverseLink"},"settle":{"$ref":"#/components/schemas/SettleLink"}}}},"components/schemas/AlipayHkPaymentInstrument":{"id":"components/schemas/AlipayHkPaymentInstrument","kind":"json-schema","title":"AlipayHkPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"deviceType":{"type":"string","description":"The type of device used by your customer","enum":["DESKTOP","MOBILE","CONSOLE","TABLET"],"example":"DESKTOP"},"failureURL":{"type":"string","description":"The URL where your customer is redirected after a failed payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/failure"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":"The type of instrument.","enum":["alipay_hk"]}}}],"required":["failureURL","pendingURL","successURL","type"]}},"components/schemas/AlipayMobilePaymentInstrument":{"id":"components/schemas/AlipayMobilePaymentInstrument","kind":"json-schema","title":"AlipayMobilePaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"shopperEmailAddress":{"type":"string","description":"Your customer's e-mail address.","example":"shopper@worldpay.com"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":"The type of instrument.","enum":["alipay_mobile"]}}}],"required":["cancelURL","country","pendingURL","shopperEmailAddress","successURL","type"]}},"components/schemas/AlipayPaymentInstrument":{"id":"components/schemas/AlipayPaymentInstrument","kind":"json-schema","title":"AlipayPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"shopperEmailAddress":{"type":"string","description":"Your customer's e-mail address.","example":"shopper@worldpay.com"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":"The type of instrument.","enum":["alipay"]}}}],"required":["cancelURL","country","pendingURL","shopperEmailAddress","successURL","type"]}},"components/schemas/ApmPaymentRequest":{"id":"components/schemas/ApmPaymentRequest","kind":"json-schema","title":"ApmPaymentRequest","data":{"type":"object","properties":{"instruction":{"$ref":"#/components/schemas/Instruction"},"merchant":{"$ref":"#/components/schemas/Merchant"},"transactionReference":{"type":"string","maxLength":64,"minLength":0,"pattern":"^[a-zA-Z0-9-_/!@#$%()*=.:;?[]{}~\\+]*$"}},"required":["instruction","merchant","transactionReference"]}},"components/schemas/ApmPaymentResource":{"id":"components/schemas/ApmPaymentResource","kind":"json-schema","title":"ApmPaymentResource","data":{"type":"object","description":"A payment resource.","properties":{"_actions":{"$ref":"#/components/schemas/Actions"},"_links":{"$ref":"#/components/schemas/Links"},"lastEvent":{"type":"string","enum":["authorized","cancelFailed","cancelled","cancelRequested","sentForSettlement","settlementFailed","chargebackReversed","chargedBack","disputeExpired","disputeFundsHeld","disputeFundsReleased","disputeReserveReleased","error","expired","disputeInformationRequested","disputInformationSupplied","miscellaneous","pending","refunded","refundExpired","refundFailed","refundReversed","refused","refusedByIssuer","sentForRefund","settled","settlementReversed","cancelledByCustomer","signedFormReceived","unknown","manuallyAmended"]},"paymentId":{"type":"string","description":"The identifier of the payment resource."}}}},"components/schemas/ApmPaymentResourceWithRedirect":{"id":"components/schemas/ApmPaymentResourceWithRedirect","kind":"json-schema","title":"ApmPaymentResourceWithRedirect","data":{"type":"object","description":"A payment resource, with a URL for your customer to continue the payment.","properties":{"_actions":{"$ref":"#/components/schemas/Actions"},"_links":{"$ref":"#/components/schemas/Links"},"lastEvent":{"type":"string","enum":["authorized","cancelFailed","cancelled","cancelRequested","sentForSettlement","settlementFailed","chargebackReversed","chargedBack","disputeExpired","disputeFundsHeld","disputeFundsReleased","disputeReserveReleased","error","expired","disputeInformationRequested","disputInformationSupplied","miscellaneous","pending","refunded","refundExpired","refundFailed","refundReversed","refused","refusedByIssuer","sentForRefund","settled","settlementReversed","cancelledByCustomer","signedFormReceived","unknown","manuallyAmended"]},"paymentId":{"type":"string","description":"The identifier of the payment resource."},"url":{"type":"string","description":"The URL of where to redirect tyour customer."}}}},"components/schemas/BancontactPaymentInstrument":{"id":"components/schemas/BancontactPaymentInstrument","kind":"json-schema","title":"BancontactPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"shopperEmailAddress":{"type":"string","description":"Your customer's e-mail address.","example":"shopper@worldpay.com"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":"The type of instrument.","enum":["bancontact"]}}}],"required":["cancelURL","country","pendingURL","shopperEmailAddress","successURL","type"]}},"components/schemas/BlikPaymentInstrument":{"id":"components/schemas/BlikPaymentInstrument","kind":"json-schema","title":"BlikPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"shopperEmailAddress":{"type":"string","description":"Your customer's e-mail address.","example":"shopper@worldpay.com"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"termsAccepted":{"type":"boolean","default":false,"description":"Indicates whether your customer has accepted Blik's terms and conditions. If not provided or false, your customer will be prompted to accept them.","example":true},"type":{"type":"string","description":"The type of instrument.","enum":["blik"]}}}],"required":["cancelURL","country","pendingURL","shopperEmailAddress","successURL","type"]}},"components/schemas/ChinaUnionPayPaymentInstrument":{"id":"components/schemas/ChinaUnionPayPaymentInstrument","kind":"json-schema","title":"ChinaUnionPayPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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"},"failureURL":{"type":"string","description":"The URL where your customer is redirected after a failed payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/failure"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: For China UnionPay Express payments (card flow), see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/card-payments/openapi"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Payments API documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["chinaunionpay"]}}}],"required":["type"]}},"components/schemas/EutellerPaymentInstrument":{"id":"components/schemas/EutellerPaymentInstrument","kind":"json-schema","title":"EutellerPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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":"FI"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"shopperEmailAddress":{"type":"string","description":"Your customer's e-mail address.","example":"shopper@worldpay.com"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":"The type of instrument.","enum":["euteller"]}}}],"required":["cancelURL","country","pendingURL","shopperEmailAddress","successURL","type"]}},"components/schemas/Full_reversal":{"id":"components/schemas/Full_reversal","kind":"json-schema","title":"Full_reversal","data":{"type":"object","description":"Full reversal request (no body)"}},"components/schemas/Full_settlement":{"id":"components/schemas/Full_settlement","kind":"json-schema","title":"Full_settlement","data":{"type":"object","description":"Full settlement request (no body)","example":null}},"components/schemas/GiropayPaymentInstrument":{"id":"components/schemas/GiropayPaymentInstrument","kind":"json-schema","title":"GiropayPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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"},"failureURL":{"type":"string","description":"The URL where your customer is redirected after a failed payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/failure"},"shopperEmailAddress":{"type":"string","description":"Your customer's e-mail address.","example":"shopper@worldpay.com"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"swiftCode":{"type":"string","description":"The BIC/Swift code of your customer's bank. When it's not provided, your customer will be asked to select their bank.","example":"PBNKDEFF","pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"type":{"type":"string","description":"The type of instrument.","enum":["giropay"]}}}],"required":["cancelURL","country","failureURL","shopperEmailAddress","successURL","type"]}},"components/schemas/IdealPaymentInstrument":{"id":"components/schemas/IdealPaymentInstrument","kind":"json-schema","title":"IdealPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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"},"failureURL":{"type":"string","description":"The URL where your customer is redirected after a failed payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/failure"},"language":{"type":"string","description":"Your customer's language, must be a supported ISO 639-1 language code.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":"The type of instrument.","enum":["ideal"]}}}],"required":["type"]}},"components/schemas/Instruction":{"id":"components/schemas/Instruction","kind":"json-schema","title":"Instruction","data":{"type":"object","properties":{"narrative":{"$ref":"#/components/schemas/Narrative"},"paymentInstrument":{"$ref":"#/components/schemas/PaymentInstrument"},"value":{"$ref":"#/components/schemas/Value"}},"required":["narrative","paymentInstrument","value"]}},"components/schemas/KonbiniPaymentInstrument":{"id":"components/schemas/KonbiniPaymentInstrument","kind":"json-schema","title":"KonbiniPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"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"},"lastName":{"type":"string","description":"Your customer's last name.","example":"姓","maxLength":10,"minLength":0,"pattern":"^[a-zA-Z0-9- \\p{InCJK_Radicals_Supplement}\\p{InCJK_Symbols_and_Punctuation}\\p{InHiragana}\\p{InKatakana}\\p{InKatakana_Phonetic_Extensions}\\p{InEnclosed_CJK_Letters_and_Months}\\p{InCJK_Compatibility}\\p{InCJK_Unified_Ideographs_Extension_A}\\p{InCJK_Unified_Ideographs_Extension_B}\\p{InCJK_Unified_Ideographs}\\p{InCJK_Compatibility_Ideographs}\\p{InCJK_Compatibility_Ideographs_Supplement}\\p{InCJK_Compatibility_Forms}]*$"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"shopperEmailAddress":{"type":"string","description":"Your customer's e-mail address.","example":"shopper@worldpay.com"},"telephoneNumber":{"type":"string","description":"Your customer's last name.","example":"1234567890","maxLength":11,"minLength":10,"pattern":"^([0-9]*)$"},"type":{"type":"string","description":"The type of instrument.","enum":["konbini"]}}}],"description":"Konbini","required":["country","lastName","pendingURL","shopperEmailAddress","telephoneNumber","type"]}},"components/schemas/Links":{"id":"components/schemas/Links","kind":"json-schema","title":"Links","data":{"type":"object","description":"Links to resources related to the request.","properties":{"self":{"$ref":"#/components/schemas/SelfLink"}}}},"components/schemas/Merchant":{"id":"components/schemas/Merchant","kind":"json-schema","title":"Merchant","data":{"type":"object","properties":{"entity":{"type":"string","description":"The Access Entity entityReference.","example":"MindPalaceLtd","maxLength":32,"minLength":3,"pattern":"^([a-zA-Z0-9\\- ]*)$"}},"required":["entity"]}},"components/schemas/MultibancoPaymentInstrument":{"id":"components/schemas/MultibancoPaymentInstrument","kind":"json-schema","title":"MultibancoPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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"},"failureURL":{"type":"string","description":"The URL where your customer is redirected after a failed payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/failure"},"language":{"type":"string","description":"Your customer's language, must be a supported ISO 639-1 language code.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"shopperEmailAddress":{"type":"string","description":"Your customer's e-mail address.","example":"shopper@worldpay.com"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":"The type of instrument.","enum":["multibanco"]}}}],"required":["type"]}},"components/schemas/Narrative":{"id":"components/schemas/Narrative","kind":"json-schema","title":"Narrative","data":{"type":"object","description":"Details about the payment.","properties":{"line1":{"type":"string","description":"The description shown on your customer's bank statement for the payment.","example":"Mind Palace","maxLength":24,"minLength":0,"pattern":"^[a-zA-Z0-9\\-\\.\\,\\ ]*$"}},"required":["line1"]}},"components/schemas/OpenBankingPaymentInstrument":{"id":"components/schemas/OpenBankingPaymentInstrument","kind":"json-schema","title":"OpenBankingPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"shopperEmailAddress":{"type":"string","description":"Your customer's e-mail address.","example":"shopper@worldpay.com"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":"The type of instrument.","enum":["open_banking"]}}}],"required":["cancelURL","country","pendingURL","shopperEmailAddress","successURL","type"]}},"components/schemas/Partial_reversal":{"id":"components/schemas/Partial_reversal","kind":"json-schema","title":"Partial_reversal","data":{"type":"object","description":"Partial reversal request","properties":{"reference":{"type":"string","maxLength":128,"minLength":0,"pattern":"^[a-zA-Z0-9\\-]*$"},"value":{"$ref":"#/components/schemas/Value"}},"required":["value"]}},"components/schemas/Partial_settlement":{"id":"components/schemas/Partial_settlement","kind":"json-schema","title":"Partial_settlement","data":{"type":"object","description":"Partial settlement request","properties":{"reference":{"type":"string","maxLength":128,"minLength":0,"pattern":"^[a-zA-Z0-9\\-]*$"},"value":{"$ref":"#/components/schemas/Value"}},"required":["value"]}},"components/schemas/PartialReverseLink":{"id":"components/schemas/PartialReverseLink","kind":"json-schema","title":"PartialReverseLink","data":{"type":"object","description":"The URL you can invoke to partially reverse the payment. Make sure to check it's present, not always present.","properties":{"href":{"type":"string"}}}},"components/schemas/PayPalBillingAddress":{"id":"components/schemas/PayPalBillingAddress","kind":"json-schema","title":"PayPalBillingAddress","data":{"type":"object","properties":{"address1":{"type":"string","maxLength":85,"minLength":0},"address2":{"type":"string","maxLength":85,"minLength":0},"address3":{"type":"string","maxLength":85,"minLength":0},"city":{"type":"string","description":"Only optional for country code SG (Singapore).","maxLength":50,"minLength":0},"countryCode":{"type":"string","description":"The supported ISO 3166-1 alpha-2 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":0},"state":{"type":"string","maxLength":50,"minLength":0}},"required":["address1","countryCode"]}},"components/schemas/PayPalInstrument":{"id":"components/schemas/PayPalInstrument","kind":"json-schema","title":"PayPalInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"billingAddress":{"$ref":"#/components/schemas/PayPalBillingAddress"},"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"failureURL":{"type":"string","description":"The URL where your customer is redirected after a failed payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/failure"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"requestAutoSettlement":{"$ref":"#/components/schemas/RequestAutoSettlement"},"shippingAddress":{"$ref":"#/components/schemas/PayPalShippingAddress"},"shopperEmailAddress":{"type":"string","description":"Your customer's e-mail address.","example":"shopper@worldpay.com"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":"The type of instrument.","enum":["paypal"]}}}],"required":["type"]}},"components/schemas/PayPalShippingAddress":{"id":"components/schemas/PayPalShippingAddress","kind":"json-schema","title":"PayPalShippingAddress","data":{"type":"object","properties":{"address1":{"type":"string","maxLength":85,"minLength":0},"address2":{"type":"string","maxLength":85,"minLength":0},"address3":{"type":"string","maxLength":85,"minLength":0},"city":{"type":"string","description":"Only optional for country code SG (Singapore).","maxLength":50,"minLength":0},"countryCode":{"type":"string","description":"The supported ISO 3166-1 alpha-2 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":0},"state":{"type":"string","maxLength":50,"minLength":0}},"required":["address1","countryCode"]}},"components/schemas/PaySafeCardPaymentInstrument":{"id":"components/schemas/PaySafeCardPaymentInstrument","kind":"json-schema","title":"PaySafeCardPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"shopperEmailAddress":{"type":"string","description":"Your customer's e-mail address.","example":"shopper@worldpay.com"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":"The type of instrument.","enum":["paysafecard"]}}}],"required":["cancelURL","country","pendingURL","shopperEmailAddress","successURL","type"]}},"components/schemas/PaymentInstrument":{"id":"components/schemas/PaymentInstrument","kind":"json-schema","title":"PaymentInstrument","data":{"type":"object","description":"The instrument used to take the payment","discriminator":{"mapping":{"alipay":"#/components/schemas/AlipayPaymentInstrument","alipay_hk":"#/components/schemas/AlipayHkPaymentInstrument","alipay_mobile":"#/components/schemas/AlipayMobilePaymentInstrument","bancontact":"#/components/schemas/BancontactPaymentInstrument","blik":"#/components/schemas/BlikPaymentInstrument","chinaunionpay":"#/components/schemas/ChinaUnionPayPaymentInstrument","euteller":"#/components/schemas/EutellerPaymentInstrument","giropay":"#/components/schemas/GiropayPaymentInstrument","ideal":"#/components/schemas/IdealPaymentInstrument","konbini":"#/components/schemas/KonbiniPaymentInstrument","multibanco":"#/components/schemas/MultibancoPaymentInstrument","open_banking":"#/components/schemas/OpenBankingPaymentInstrument","paypal":"#/components/schemas/PayPalInstrument","paysafecard":"#/components/schemas/PaySafeCardPaymentInstrument","poli_nz":"#/components/schemas/PoliNZPaymentInstrument","przelewy":"#/components/schemas/PrzelewyPaymentInstrument","safetypay":"#/components/schemas/SafetyPayPaymentInstrument","sepa":"#/components/schemas/SepaPaymentInstrument","trustly":"#/components/schemas/TrustlyPaymentInstrument"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AlipayHkPaymentInstrument"},{"$ref":"#/components/schemas/AlipayMobilePaymentInstrument"},{"$ref":"#/components/schemas/AlipayPaymentInstrument"},{"$ref":"#/components/schemas/BancontactPaymentInstrument"},{"$ref":"#/components/schemas/BlikPaymentInstrument"},{"$ref":"#/components/schemas/ChinaUnionPayPaymentInstrument"},{"$ref":"#/components/schemas/EutellerPaymentInstrument"},{"$ref":"#/components/schemas/GiropayPaymentInstrument"},{"$ref":"#/components/schemas/IdealPaymentInstrument"},{"$ref":"#/components/schemas/KonbiniPaymentInstrument"},{"$ref":"#/components/schemas/MultibancoPaymentInstrument"},{"$ref":"#/components/schemas/OpenBankingPaymentInstrument"},{"$ref":"#/components/schemas/PaySafeCardPaymentInstrument"},{"$ref":"#/components/schemas/PayPalInstrument"},{"$ref":"#/components/schemas/PoliNZPaymentInstrument"},{"$ref":"#/components/schemas/PrzelewyPaymentInstrument"},{"$ref":"#/components/schemas/SafetyPayPaymentInstrument"},{"$ref":"#/components/schemas/SepaPaymentInstrument"},{"$ref":"#/components/schemas/TrustlyPaymentInstrument"}],"properties":{"type":{"type":"string","description":"The type of instrument."}},"required":["type"]}},"components/schemas/PoliNZPaymentInstrument":{"id":"components/schemas/PoliNZPaymentInstrument","kind":"json-schema","title":"PoliNZPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"shopperEmailAddress":{"type":"string","description":"Your customer's e-mail address.","example":"shopper@worldpay.com"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":"The type of instrument.","enum":["poli_nz"]}}}],"required":["cancelURL","country","pendingURL","shopperEmailAddress","successURL","type"]}},"components/schemas/PrzelewyPaymentInstrument":{"id":"components/schemas/PrzelewyPaymentInstrument","kind":"json-schema","title":"PrzelewyPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"shopperEmailAddress":{"type":"string","description":"Your customer's e-mail address.","example":"shopper@worldpay.com"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":"The type of instrument.","enum":["przelewy"]}}}],"required":["cancelURL","country","pendingURL","shopperEmailAddress","successURL","type"]}},"components/schemas/RequestAutoSettlement":{"id":"components/schemas/RequestAutoSettlement","kind":"json-schema","title":"RequestAutoSettlement","data":{"type":"object","description":"Configuration for requesting automatic settlement (when supported by a payment instrument).","properties":{"enabled":{"type":"boolean","default":false,"description":"Enables automatic settlement"}}}},"components/schemas/ReverseLink":{"id":"components/schemas/ReverseLink","kind":"json-schema","title":"ReverseLink","data":{"type":"object","description":"The URL you can invoke to reverse the payment. Make sure to check it's present, not always present.","properties":{"href":{"type":"string"}}}},"components/schemas/SafetyPayPaymentInstrument":{"id":"components/schemas/SafetyPayPaymentInstrument","kind":"json-schema","title":"SafetyPayPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"shopperEmailAddress":{"type":"string","description":"Your customer's e-mail address.","example":"shopper@worldpay.com"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":"The type of instrument.","enum":["safetypay"]}}}],"required":["cancelURL","country","pendingURL","shopperEmailAddress","successURL","type"]}},"components/schemas/SelfLink":{"id":"components/schemas/SelfLink","kind":"json-schema","title":"SelfLink","data":{"type":"object","description":"The URL you can invoke to fetch the last event for the payment.","properties":{"href":{"type":"string"}}}},"components/schemas/SepaPaymentInstrument":{"id":"components/schemas/SepaPaymentInstrument","kind":"json-schema","title":"SepaPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a cancelled payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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"},"failureURL":{"type":"string","description":"The URL where your customer is redirected after a failed payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/failure"},"language":{"type":"string","description":"Your customer's language, must be a supported ISO 639-1 language code.","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"mandateType":{"type":"string","description":"The type of mandate.","enum":["oneTime"],"example":"oneTime"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"shopperEmailAddress":{"type":"string","description":"Your customer's e-mail address.","example":"shopper@worldpay.com"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":"The type of instrument.","enum":["sepa"]}}}],"required":["mandateType","shopperEmailAddress","type"]}},"components/schemas/SettleLink":{"id":"components/schemas/SettleLink","kind":"json-schema","title":"SettleLink","data":{"type":"object","description":"The URL you can invoke to settle the payment. Make sure to check it's present, not always present.","properties":{"href":{"type":"string"}}}},"components/schemas/TrustlyPaymentInstrument":{"id":"components/schemas/TrustlyPaymentInstrument","kind":"json-schema","title":"TrustlyPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"cancelURL":{"type":"string","description":"The URL where your customer is redirected after a payment cancel outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/cancel"},"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"},"pendingURL":{"type":"string","description":"The URL where your customer is redirected after a pending payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/pending"},"shopperEmailAddress":{"type":"string","description":"The shopper's e-mail address","example":"shopper@worldpay.com"},"successURL":{"type":"string","description":"The URL where your customer is redirected after a successful payment outcome.","example":"https://worldpay-bsh.securedataplatform.co.uk/success"},"type":{"type":"string","description":"The type of instrument.","enum":["trustly"]}}}],"required":["cancelURL","country","pendingURL","shopperEmailAddress","successURL","type"]}},"components/schemas/Value":{"id":"components/schemas/Value","kind":"json-schema","title":"Value","data":{"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":1234,"minimum":1},"currency":{"type":"string","description":"The supported ISO 4217 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"]}},"schema_305":{"kind":"json-schema","data":{"type":"string","enum":["application/json"]},"id":"schema_305"},"schema_306":{"kind":"json-schema","data":{"type":"string","enum":["2023-06-01"]},"id":"schema_306"},"schema_307":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ApmPaymentResource"},{"$ref":"#/components/schemas/ApmPaymentResourceWithRedirect"}]},"id":"schema_307"},"schema_308":{"kind":"json-schema","data":{"type":"string"},"id":"schema_308"},"schema_309":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/Full_reversal"},{"$ref":"#/components/schemas/Partial_reversal"}]},"id":"schema_309"},"schema_310":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/Full_settlement"},{"$ref":"#/components/schemas/Partial_settlement"}]},"id":"schema_310"}},"exampleStore":{"components/examples/payment-paypal":{"id":"components/examples/payment-paypal","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"MindPalace"},"value":{"amount":35,"currency":"GBP"},"paymentInstrument":{"type":"paypal","requestAutoSettlement":{"enabled":true},"shopperEmailAddress":"shopper@example.com","billingAddress":{"address1":"221B Baker Street","address2":"Marylebone","address3":"Westminster","postalCode":"NW1 6XE","city":"London","state":"Greater London","countryCode":"GB"},"shippingAddress":{"address1":"The Palatine Centre","postalCode":"DH1 3LE","city":"Durham","state":"County Durham","countryCode":"GB"},"successURL":"https://example.com/success","pendingURL":"https://example.com/pending","failureURL":"https://example.com/failure","cancelURL":"https://example.com/cancel"}}}},"components/examples/payment-ideal":{"id":"components/examples/payment-ideal","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":1234,"currency":"EUR"},"paymentInstrument":{"type":"ideal","language":"en","successURL":"https://example.com/success","pendingURL":"https://example.com/pending","failureURL":"https://example.com/failure","cancelURL":"https://example.com/cancel"}}}},"components/examples/payment-alipay":{"id":"components/examples/payment-alipay","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":1234,"currency":"CNY"},"paymentInstrument":{"type":"alipay","country":"CN","shopperEmailAddress":"email@example.com","successURL":"https://example.com/success","pendingURL":"https://example.com/pending","failureURL":"https://example.com/failure","cancelURL":"https://example.com/cancel"}}}},"components/examples/payment-alipayhk":{"id":"components/examples/payment-alipayhk","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":1234,"currency":"HKD"},"paymentInstrument":{"type":"alipay_hk","successURL":"http://httpbin.org/anything/success","pendingURL":"http://httpbin.org/anything/pending","failureURL":"http://httpbin.org/anything/failure","deviceType":"MOBILE"}}}},"components/examples/payment-bancontact":{"id":"components/examples/payment-bancontact","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":50,"currency":"EUR"},"paymentInstrument":{"type":"bancontact","country":"BE","shopperEmailAddress":"email@example.com","cancelURL":"https://worldpay-bsh.securedataplatform.co.uk/cancel","pendingURL":"http://example.com/pending","successURL":"http://example.com/success"}}}},"components/examples/payment-blik":{"id":"components/examples/payment-blik","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":1000,"currency":"PLN"},"paymentInstrument":{"type":"blik","country":"PL","shopperEmailAddress":"example@gmail.com","termsAccepted":true,"successURL":"http://httpbin.org/anything/success","pendingURL":"http://httpbin.org/anything/pending","cancelURL":"http://httpbin.org/anything/cancel"}}}},"components/examples/payment-cup":{"id":"components/examples/payment-cup","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":50,"currency":"CNY"},"paymentInstrument":{"type":"chinaunionpay","successURL":"https://example.com/success","pendingURL":"https://example.com/pending","failureURL":"https://example.com/failure","cancelURL":"https://example.com/cancel"}}}},"components/examples/payment-euteller":{"id":"components/examples/payment-euteller","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":20,"currency":"EUR"},"paymentInstrument":{"type":"euteller","country":"FI","shopperEmailAddress":"example@gmail.com","successURL":"http://httpbin.org/anything/success","pendingURL":"http://httpbin.org/anything/pending","cancelURL":"http://httpbin.org/anything/cancel"}}}},"components/examples/payment-konbini":{"id":"components/examples/payment-konbini","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":50,"currency":"JPY"},"paymentInstrument":{"type":"konbini","country":"JP","lastName":"姓","telephoneNumber":"1234567890","shopperEmailAddress":"email@example.com","pendingURL":"https://example.com/pending"}}}},"components/examples/payment-mybank":{"id":"components/examples/payment-mybank","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":1000,"currency":"EUR"},"paymentInstrument":{"type":"mybank","country":"IT","shopperEmailAddress":"example@gmail.com","shippingAddress":{"firstName":"xxx","lastName":"yyy","address1":"The Palatine Centre","address2":"foo","address3":"bar","postalCode":"DH1 3LE","city":"Durham","state":"County Durham","countryCode":"GB"},"successURL":"http://httpbin.org/anything/success","pendingURL":"http://httpbin.org/anything/pending","cancelURL":"http://httpbin.org/anything/cancel"}}}},"components/examples/payment-openbanking":{"id":"components/examples/payment-openbanking","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"MindPalaceLtd"},"value":{"amount":100,"currency":"GBP"},"paymentInstrument":{"type":"open_banking","country":"GB","shopperEmailAddress":"email@example.com","successURL":"http://https://example.com/success","pendingURL":"http://https://example.com/pending","cancelURL":"http://https://example.com/cancel"}}}},"components/examples/payment-paysafecard":{"id":"components/examples/payment-paysafecard","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":1234,"currency":"GBP"},"paymentInstrument":{"type":"paysafecard","country":"GB","shopperEmailAddress":"example@gmail.com","successURL":"http://httpbin.org/anything/success","pendingURL":"http://httpbin.org/anything/pending","cancelURL":"http://httpbin.org/anything/cancel"}}}},"components/examples/payment-polinz":{"id":"components/examples/payment-polinz","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":1234,"currency":"NZD"},"paymentInstrument":{"type":"poli_nz","country":"NZ","shopperEmailAddress":"example@gmail.com","successURL":"http://httpbin.org/anything/success","pendingURL":"http://httpbin.org/anything/pending","cancelURL":"http://httpbin.org/anything/cancel"}}}},"components/examples/payment-przelewy24":{"id":"components/examples/payment-przelewy24","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":50,"currency":"PLN"},"paymentInstrument":{"type":"przelewy","country":"PL","shopperEmailAddress":"email@example.com","cancelURL":"https://example.com/cancel","pendingURL":"https://example.com/pending","successURL":"https://example.com/success"}}}},"components/examples/payment-safetypay":{"id":"components/examples/payment-safetypay","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":50,"currency":"USD"},"paymentInstrument":{"type":"safetypay","country":"BR","shopperEmailAddress":"example@gmail.com","successURL":"http://httpbin.org/anything/success","pendingURL":"http://httpbin.org/anything/pending","cancelURL":"http://httpbin.org/anything/cancel"}}}},"components/examples/payment-sepa":{"id":"components/examples/payment-sepa","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace LTD"},"value":{"amount":1234,"currency":"EUR"},"paymentInstrument":{"type":"sepa","country":"DE","language":"de","shopperEmailAddress":"email@example.com","mandateType":"onetime","successURL":"https://example.com/success","pendingURL":"https://example.com/pending","failureURL":"https://example.com/failure","cancelURL":"https://example.com/cancel"}}}},"components/examples/payment-trustly":{"id":"components/examples/payment-trustly","value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":50,"currency":"EUR"},"paymentInstrument":{"type":"trustly","country":"FI","shopperEmailAddress":"email@example.com","cancelURL":"https://worldpay-bsh.securedataplatform.co.uk/cancel","pendingURL":"https://example.com/pending","successURL":"https://example.com/success"}}}},"components/examples/payment-201":{"id":"components/examples/payment-201","value":{"paymentId":"3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f","lastEvent":"pending","url":"https://mock.hpp.worldpay-bsh.securedataplatform.co.uk/app/hpp/xyz/integration/wpg?Ticket=12345678&OrderKey=blah","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"}},"_actions":{}}},"components/examples/response-400":{"id":"components/examples/response-400","value":{"errorName":"bodyDoesNotMatchSchema","message":"The json body provided does not match the expected schema","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Field is mandatory","jsonPath":"$.instruction.value.amount"}]}},"components/examples/response-401":{"id":"components/examples/response-401","value":{"errorName":"unauthorized","message":"Invalid authentication"}},"components/examples/response-415":{"id":"components/examples/response-415","value":{"errorName":"headerHasInvalidValue","message":"Bad content type."}},"components/examples/response-500":{"id":"components/examples/response-500","value":{"errorName":"internalErrorOccurred","message":"An internal problem occurred with your request, please try again."}},"components/examples/query-202-authorized":{"id":"components/examples/query-202-authorized","value":{"paymentId":"3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f","lastEvent":"authorized","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"}},"_actions":{"reverse":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f/reversals"},"partialReverse":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f/reversals"}}}},"components/examples/query-202-pending":{"id":"components/examples/query-202-pending","value":{"paymentId":"3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f","lastEvent":"pending","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"}},"_actions":{}}},"components/examples/query-202-sentForRefund":{"id":"components/examples/query-202-sentForRefund","value":{"paymentId":"3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f","lastEvent":"sentForRefund","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"}},"_actions":{}}},"components/examples/query-202-sentForSettlement":{"id":"components/examples/query-202-sentForSettlement","value":{"id":"3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f","lastEvent":"sentForSettlement","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"}},"_actions":{"reverse":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f/reversals"},"partialReverse":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f/reversals"}}}},"components/examples/response-404":{"id":"components/examples/response-404","value":{"errorName":"paymentNotFound","message":"Payment resource not found."}},"components/examples/reverse-202":{"id":"components/examples/reverse-202","value":{"id":"3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f","lastEvent":"sentForRefund","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"}},"_actions":{}}},"components/examples/settlement-202":{"id":"components/examples/settlement-202","value":{"id":"3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f","lastEvent":"sentForSettlement","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"}},"_actions":{}}},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/PayPal":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"MindPalace"},"value":{"amount":35,"currency":"GBP"},"paymentInstrument":{"type":"paypal","requestAutoSettlement":{"enabled":true},"shopperEmailAddress":"shopper@example.com","billingAddress":{"address1":"221B Baker Street","address2":"Marylebone","address3":"Westminster","postalCode":"NW1 6XE","city":"London","state":"Greater London","countryCode":"GB"},"shippingAddress":{"address1":"The Palatine Centre","postalCode":"DH1 3LE","city":"Durham","state":"County Durham","countryCode":"GB"},"successURL":"https://example.com/success","pendingURL":"https://example.com/pending","failureURL":"https://example.com/failure","cancelURL":"https://example.com/cancel"}}},"key":"PayPal","summary":"PayPal","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/PayPal"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/iDEAL":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":1234,"currency":"EUR"},"paymentInstrument":{"type":"ideal","language":"en","successURL":"https://example.com/success","pendingURL":"https://example.com/pending","failureURL":"https://example.com/failure","cancelURL":"https://example.com/cancel"}}},"key":"iDEAL","summary":"iDEAL","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/iDEAL"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/Alipay":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":1234,"currency":"CNY"},"paymentInstrument":{"type":"alipay","country":"CN","shopperEmailAddress":"email@example.com","successURL":"https://example.com/success","pendingURL":"https://example.com/pending","failureURL":"https://example.com/failure","cancelURL":"https://example.com/cancel"}}},"key":"Alipay","summary":"Alipay","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/Alipay"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/AlipayHK":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":1234,"currency":"HKD"},"paymentInstrument":{"type":"alipay_hk","successURL":"http://httpbin.org/anything/success","pendingURL":"http://httpbin.org/anything/pending","failureURL":"http://httpbin.org/anything/failure","deviceType":"MOBILE"}}},"key":"AlipayHK","summary":"AlipayHK","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/AlipayHK"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/Bancontact":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":50,"currency":"EUR"},"paymentInstrument":{"type":"bancontact","country":"BE","shopperEmailAddress":"email@example.com","cancelURL":"https://worldpay-bsh.securedataplatform.co.uk/cancel","pendingURL":"http://example.com/pending","successURL":"http://example.com/success"}}},"key":"Bancontact","summary":"Bancontact","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/Bancontact"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/BLIK":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":1000,"currency":"PLN"},"paymentInstrument":{"type":"blik","country":"PL","shopperEmailAddress":"example@gmail.com","termsAccepted":true,"successURL":"http://httpbin.org/anything/success","pendingURL":"http://httpbin.org/anything/pending","cancelURL":"http://httpbin.org/anything/cancel"}}},"key":"BLIK","summary":"BLIK","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/BLIK"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/China UnionPay":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":50,"currency":"CNY"},"paymentInstrument":{"type":"chinaunionpay","successURL":"https://example.com/success","pendingURL":"https://example.com/pending","failureURL":"https://example.com/failure","cancelURL":"https://example.com/cancel"}}},"key":"China UnionPay","summary":"China UnionPay","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/China UnionPay"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/Euteller":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":20,"currency":"EUR"},"paymentInstrument":{"type":"euteller","country":"FI","shopperEmailAddress":"example@gmail.com","successURL":"http://httpbin.org/anything/success","pendingURL":"http://httpbin.org/anything/pending","cancelURL":"http://httpbin.org/anything/cancel"}}},"key":"Euteller","summary":"Euteller","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/Euteller"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/Konbini":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":50,"currency":"JPY"},"paymentInstrument":{"type":"konbini","country":"JP","lastName":"姓","telephoneNumber":"1234567890","shopperEmailAddress":"email@example.com","pendingURL":"https://example.com/pending"}}},"key":"Konbini","summary":"Konbini","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/Konbini"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/MyBank":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":1000,"currency":"EUR"},"paymentInstrument":{"type":"mybank","country":"IT","shopperEmailAddress":"example@gmail.com","shippingAddress":{"firstName":"xxx","lastName":"yyy","address1":"The Palatine Centre","address2":"foo","address3":"bar","postalCode":"DH1 3LE","city":"Durham","state":"County Durham","countryCode":"GB"},"successURL":"http://httpbin.org/anything/success","pendingURL":"http://httpbin.org/anything/pending","cancelURL":"http://httpbin.org/anything/cancel"}}},"key":"MyBank","summary":"MyBank","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/MyBank"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/Open Banking":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"MindPalaceLtd"},"value":{"amount":100,"currency":"GBP"},"paymentInstrument":{"type":"open_banking","country":"GB","shopperEmailAddress":"email@example.com","successURL":"http://https://example.com/success","pendingURL":"http://https://example.com/pending","cancelURL":"http://https://example.com/cancel"}}},"key":"Open Banking","summary":"Open Banking","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/Open Banking"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/paysafecard":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":1234,"currency":"GBP"},"paymentInstrument":{"type":"paysafecard","country":"GB","shopperEmailAddress":"example@gmail.com","successURL":"http://httpbin.org/anything/success","pendingURL":"http://httpbin.org/anything/pending","cancelURL":"http://httpbin.org/anything/cancel"}}},"key":"paysafecard","summary":"paysafecard","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/paysafecard"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/POLi NZ":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":1234,"currency":"NZD"},"paymentInstrument":{"type":"poli_nz","country":"NZ","shopperEmailAddress":"example@gmail.com","successURL":"http://httpbin.org/anything/success","pendingURL":"http://httpbin.org/anything/pending","cancelURL":"http://httpbin.org/anything/cancel"}}},"key":"POLi NZ","summary":"POLi NZ","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/POLi NZ"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/Przelewy24":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":50,"currency":"PLN"},"paymentInstrument":{"type":"przelewy","country":"PL","shopperEmailAddress":"email@example.com","cancelURL":"https://example.com/cancel","pendingURL":"https://example.com/pending","successURL":"https://example.com/success"}}},"key":"Przelewy24","summary":"Przelewy24","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/Przelewy24"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/SafetyPay":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":50,"currency":"USD"},"paymentInstrument":{"type":"safetypay","country":"BR","shopperEmailAddress":"example@gmail.com","successURL":"http://httpbin.org/anything/success","pendingURL":"http://httpbin.org/anything/pending","cancelURL":"http://httpbin.org/anything/cancel"}}},"key":"SafetyPay","summary":"SafetyPay","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/SafetyPay"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/SEPA Direct Debit":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace LTD"},"value":{"amount":1234,"currency":"EUR"},"paymentInstrument":{"type":"sepa","country":"DE","language":"de","shopperEmailAddress":"email@example.com","mandateType":"onetime","successURL":"https://example.com/success","pendingURL":"https://example.com/pending","failureURL":"https://example.com/failure","cancelURL":"https://example.com/cancel"}}},"key":"SEPA Direct Debit","summary":"SEPA Direct Debit","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/SEPA Direct Debit"},"paths/~1apmPayments/post/requestBody/content/application~1json/examples/Trustly":{"value":{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"default"},"instruction":{"narrative":{"line1":"Mind Palace Ltd"},"value":{"amount":50,"currency":"EUR"},"paymentInstrument":{"type":"trustly","country":"FI","shopperEmailAddress":"email@example.com","cancelURL":"https://worldpay-bsh.securedataplatform.co.uk/cancel","pendingURL":"https://example.com/pending","successURL":"https://example.com/success"}}},"key":"Trustly","summary":"Trustly","id":"paths/~1apmPayments/post/requestBody/content/application~1json/examples/Trustly"},"paths/~1apmPayments/post/responses/201/content/application~1json/examples/Full example":{"value":{"paymentId":"3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f","lastEvent":"pending","url":"https://mock.hpp.worldpay-bsh.securedataplatform.co.uk/app/hpp/xyz/integration/wpg?Ticket=12345678&OrderKey=blah","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"}},"_actions":{}},"key":"Full example","summary":"Full example","id":"paths/~1apmPayments/post/responses/201/content/application~1json/examples/Full example"},"paths/~1apmPayments/post/responses/400/content/application~1json/examples/Example":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"The json body provided does not match the expected schema","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Field is mandatory","jsonPath":"$.instruction.value.amount"}]},"key":"Example","summary":"Example","id":"paths/~1apmPayments/post/responses/400/content/application~1json/examples/Example"},"paths/~1apmPayments/post/responses/401/content/application~1json/examples/Example":{"value":{"errorName":"unauthorized","message":"Invalid authentication"},"key":"Example","summary":"Example","id":"paths/~1apmPayments/post/responses/401/content/application~1json/examples/Example"},"paths/~1apmPayments/post/responses/415/content/application~1json/examples/Example":{"value":{"errorName":"headerHasInvalidValue","message":"Bad content type."},"key":"Example","summary":"Example","id":"paths/~1apmPayments/post/responses/415/content/application~1json/examples/Example"},"paths/~1apmPayments/post/responses/500/content/application~1json/examples/Example":{"value":{"errorName":"internalErrorOccurred","message":"An internal problem occurred with your request, please try again."},"key":"Example","summary":"Example","id":"paths/~1apmPayments/post/responses/500/content/application~1json/examples/Example"},"paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/authorized":{"value":{"paymentId":"3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f","lastEvent":"authorized","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"}},"_actions":{"reverse":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f/reversals"},"partialReverse":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f/reversals"}}},"key":"authorized","summary":"authorized","id":"paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/authorized"},"paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/pending":{"value":{"paymentId":"3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f","lastEvent":"pending","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"}},"_actions":{}},"key":"pending","summary":"pending","id":"paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/pending"},"paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/sentForRefund":{"value":{"paymentId":"3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f","lastEvent":"sentForRefund","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"}},"_actions":{}},"key":"sentForRefund","summary":"sentForRefund","id":"paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/sentForRefund"},"paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/sentForSettlement":{"value":{"id":"3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f","lastEvent":"sentForSettlement","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"}},"_actions":{"reverse":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f/reversals"},"partialReverse":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f/reversals"}}},"key":"sentForSettlement","summary":"sentForSettlement","id":"paths/~1apmPayments~1{paymentId}/get/responses/200/content/application~1json/examples/sentForSettlement"},"paths/~1apmPayments~1{paymentId}/get/responses/400/content/application~1json/examples/Example":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"The json body provided does not match the expected schema","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Field is mandatory","jsonPath":"$.instruction.value.amount"}]},"key":"Example","summary":"Example","id":"paths/~1apmPayments~1{paymentId}/get/responses/400/content/application~1json/examples/Example"},"paths/~1apmPayments~1{paymentId}/get/responses/401/content/application~1json/examples/Example":{"value":{"errorName":"unauthorized","message":"Invalid authentication"},"key":"Example","summary":"Example","id":"paths/~1apmPayments~1{paymentId}/get/responses/401/content/application~1json/examples/Example"},"paths/~1apmPayments~1{paymentId}/get/responses/404/content/application~1json/examples/Example":{"value":{"errorName":"paymentNotFound","message":"Payment resource not found."},"key":"Example","summary":"Example","id":"paths/~1apmPayments~1{paymentId}/get/responses/404/content/application~1json/examples/Example"},"paths/~1apmPayments~1{paymentId}/get/responses/415/content/application~1json/examples/Example":{"value":{"errorName":"headerHasInvalidValue","message":"Bad content type."},"key":"Example","summary":"Example","id":"paths/~1apmPayments~1{paymentId}/get/responses/415/content/application~1json/examples/Example"},"paths/~1apmPayments~1{paymentId}/get/responses/500/content/application~1json/examples/Example":{"value":{"errorName":"internalErrorOccurred","message":"An internal problem occurred with your request, please try again."},"key":"Example","summary":"Example","id":"paths/~1apmPayments~1{paymentId}/get/responses/500/content/application~1json/examples/Example"},"paths/~1apmPayments~1{paymentId}~1reversals/post/responses/202/content/application~1json/examples/Full example":{"value":{"id":"3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f","lastEvent":"sentForRefund","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"}},"_actions":{}},"key":"Full example","summary":"Full example","id":"paths/~1apmPayments~1{paymentId}~1reversals/post/responses/202/content/application~1json/examples/Full example"},"paths/~1apmPayments~1{paymentId}~1reversals/post/responses/400/content/application~1json/examples/Example":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"The json body provided does not match the expected schema","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Field is mandatory","jsonPath":"$.instruction.value.amount"}]},"key":"Example","summary":"Example","id":"paths/~1apmPayments~1{paymentId}~1reversals/post/responses/400/content/application~1json/examples/Example"},"paths/~1apmPayments~1{paymentId}~1reversals/post/responses/401/content/application~1json/examples/Example":{"value":{"errorName":"unauthorized","message":"Invalid authentication"},"key":"Example","summary":"Example","id":"paths/~1apmPayments~1{paymentId}~1reversals/post/responses/401/content/application~1json/examples/Example"},"paths/~1apmPayments~1{paymentId}~1reversals/post/responses/404/content/application~1json/examples/Example":{"value":{"errorName":"paymentNotFound","message":"Payment resource not found."},"key":"Example","summary":"Example","id":"paths/~1apmPayments~1{paymentId}~1reversals/post/responses/404/content/application~1json/examples/Example"},"paths/~1apmPayments~1{paymentId}~1reversals/post/responses/500/content/application~1json/examples/Example":{"value":{"errorName":"internalErrorOccurred","message":"An internal problem occurred with your request, please try again."},"key":"Example","summary":"Example","id":"paths/~1apmPayments~1{paymentId}~1reversals/post/responses/500/content/application~1json/examples/Example"},"paths/~1apmPayments~1{paymentId}~1settlements/post/responses/202/content/application~1json/examples/Full example":{"value":{"id":"3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f","lastEvent":"sentForSettlement","_links":{"self":{"href":"https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"}},"_actions":{}},"key":"Full example","summary":"Full example","id":"paths/~1apmPayments~1{paymentId}~1settlements/post/responses/202/content/application~1json/examples/Full example"},"paths/~1apmPayments~1{paymentId}~1settlements/post/responses/400/content/application~1json/examples/Example":{"value":{"errorName":"bodyDoesNotMatchSchema","message":"The json body provided does not match the expected schema","validationErrors":[{"errorName":"fieldHasInvalidValue","message":"Field is mandatory","jsonPath":"$.instruction.value.amount"}]},"key":"Example","summary":"Example","id":"paths/~1apmPayments~1{paymentId}~1settlements/post/responses/400/content/application~1json/examples/Example"},"paths/~1apmPayments~1{paymentId}~1settlements/post/responses/401/content/application~1json/examples/Example":{"value":{"errorName":"unauthorized","message":"Invalid authentication"},"key":"Example","summary":"Example","id":"paths/~1apmPayments~1{paymentId}~1settlements/post/responses/401/content/application~1json/examples/Example"},"paths/~1apmPayments~1{paymentId}~1settlements/post/responses/404/content/application~1json/examples/Example":{"value":{"errorName":"paymentNotFound","message":"Payment resource not found."},"key":"Example","summary":"Example","id":"paths/~1apmPayments~1{paymentId}~1settlements/post/responses/404/content/application~1json/examples/Example"},"paths/~1apmPayments~1{paymentId}~1settlements/post/responses/500/content/application~1json/examples/Example":{"value":{"errorName":"internalErrorOccurred","message":"An internal problem occurred with your request, please try again."},"key":"Example","summary":"Example","id":"paths/~1apmPayments~1{paymentId}~1settlements/post/responses/500/content/application~1json/examples/Example"}},"securitySchemeStore":{"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"https://try.access.worldpay-bsh.securedataplatform.co.uk","description":"Try"},{"url":"https://access.worldpay-bsh.securedataplatform.co.uk","description":"Live"}],"specType":"openapi"},"options":{"jsonSamplesExpandLevel":7,"schemasExpansionLevel":1,"hideSchemaTitles":true,"hidePropertiesPrefix":true,"hideInfoMetadata":true,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"curl"},{"lang":"Python"},{"lang":"Java"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"PHP"},{"lang":"Ruby"},{"lang":"C#"}]},"excludeFromSearch":true,"feedback":{"type":"sentiment","settings":{"label":"Do you like our page?","submitText":"Thanks for your feedback","comment":{"likeLabel":"What was most helpful?","dislikeLabel":"What can we improve?"}}},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/access/_bundle/products/apms/@20230601/openapi.json?download"},{"url":"/access/_bundle/products/apms/@20230601/openapi.yaml?download"}],"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"APM API","description":" __Authentication__\n    Set your headers\n```\n    Authorization: {your_credentials}\n    Content-Type: application/json\n    WP-Api-Version: 2023-06-01\n```\n    Replace `{your_credentials}` with your base64-encoded Basic Auth username and password.\n    <br><br>\n    __DNS whitelisting__\n\n    Whitelist the following URLs:\n    * `https://try.access.worldpay-bsh.securedataplatform.co.uk/`\n    * `https://access.worldpay-bsh.securedataplatform.co.uk/`\n\n    Please ensure you use DNS whitelisting, not explicit IP whitelisting.\n    When you make a request within Access Worldpay, you should always cache the response returned.\n "}},"baseSlug":"/products/apms/20230601/openapi","routesMapping":{}}