{"templateId":"markdown","versions":[{"version":"20240701","label":"2024-07-01 (Latest)","link":"/products/apms/manage","default":true,"active":true,"folderId":"c6e104b6"}],"sharedDataIds":{"sidebar":"sidebar-products/apms/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/apms/openapi"},"props":{"metadata":{"markdoc":{"tagList":["partial","admonition"]},"custom_product":"APMs","type":"markdown"},"seo":{"title":"Manage your APM","description":"Worldpay for Developers - docs, code examples, resources and tools. Everything you need to build your omnichannel payment solution.","siteUrl":"https://docs.worldpay.com/access","image":"/access/assets/worldpay-logo-light.21b7daf79984773a9fcd7d4fbcb07ae5289dfffd6023c4c3dca720c7058e53dc.33f780a6.svg","keywords":"documentation, api, openapi, sdks, developer, payments, json, payouts, 3ds","jsonLd":{"@context":"https://schema.org","@type":"Organization","url":"https://docs.worldpay.com/access","name":"Worldpay"},"meta":[{"name":"google-site-verification","content":"zjziIKaP3ImsqsfhYnEBnq1R85UabiSwl7HTXuwtZuo"},{"name":"doc_product","content":"Access"},{"name":"doc_category","content":"Documentation"}],"llmstxt":{"hide":false,"sections":[{"title":"Payments API","description":"Payment orchestration API combining fraud assessment, 3ds authentication, SCA exemptions, Worldpay Token creation and a card or wallet based payment.","includeFiles":["products/payments/@20240601/**/*"],"excludeFiles":[]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"],"excludeFiles":[]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"],"excludeFiles":[]},{"title":"3DS Authentication API","description":"Request 3DS authentication to protect against fraud, be SCA compliant and to shift liability using this standalone API.","includeFiles":["products/3ds/@v3/**/*"],"excludeFiles":[]},{"title":"FraudSight API","description":"Request a risk assessment and receive a response with an outcome (e.g. lowRisk) using this standalone API.","includeFiles":["products/fraudsight/@v1/**/*"],"excludeFiles":[]},{"title":"Checkout SDK","description":"Integrate using our clientside SDKs for both web and native devices. Benefit from SAQ-A/PCI-SSF compliance.","includeFiles":["products/checkout/web/@v2/**/*","products/checkout/ios/@v4/**/*","products/checkout/android/@v4/**/*","products/checkout/react-native/@v3/**/*","products/checkout/flutter/@v1/**/*"],"excludeFiles":[]},{"title":"Tokens API","description":"Minimizes the exposure of sensitive card details and increases the security of your customer's card details.","includeFiles":["products/tokens/@v3/**/*"],"excludeFiles":[]},{"title":"Card Payments API","description":"Request a card payment using this standalone API, requires separate requests for 3DS, Fraud assessment etc.","includeFiles":["products/card-payments/@v7/**/*"],"excludeFiles":[]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"],"excludeFiles":[]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"],"excludeFiles":[]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"],"excludeFiles":[]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"],"excludeFiles":[]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"],"excludeFiles":[]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"],"excludeFiles":[]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"],"excludeFiles":[]},{"title":"Hosted Payment Pages (HPP) API","description":"Our low-code option to take payments securely at the lowest PCI compliance level - SAQ A.","includeFiles":["products/hosted-payment-pages/@v1/**/*"],"excludeFiles":[]},{"title":"Money Transfers API","description":"Money Transfer OCTs (Original Credit Transaction) allow funds to be pushed to an eligible card in 30 minutes or less.","includeFiles":["products/money-transfers/@v1/**/*"],"excludeFiles":[]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"],"excludeFiles":[]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"],"excludeFiles":[]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"],"excludeFiles":[]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"],"excludeFiles":[]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"],"excludeFiles":[]},{"title":"Verified Tokens API","description":"Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.","includeFiles":["products/verified-tokens/@v3/**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last updated"]},": 26 June 2026 | ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/apms/changelog/"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Change log"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"manage-your-apm","__idx":0},"children":["Manage your APM"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An overview on how to get the latest payment status and how to reverse (cancel or refund) and settle payments."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#query"},"children":["Query"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#events"},"children":["Events"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#settle"},"children":["Settle"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#reverse"},"children":["Reverse"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-payment-status","__idx":1},"children":["Get payment status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are two ways to get the payment status. You can either ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#query-payment"},"children":["query the payment"]}," or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/events"},"children":["setup webhooks"]}," to receive the latest event from us."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-payment","__idx":2},"children":["Query payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Make a GET request on the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["links:self"]}," action link returned in your payment response."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No request body is needed for this request."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"you-receive","__idx":3},"children":["You receive:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an HTTP code 200"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastEvent"]}," for your query request"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["links to available next actions for your payment depending on payment method and pay"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Reversal action"},"children":[" A reversal means that a payment either gets cancelled or refunded depending on the state of the payment. Where an APM supports cancel or refund, this would be via a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/apms/openapi/payment-lifecycle/reverse"},"children":["reversal request"]},"."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Payment method"},"children":["Payment method"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Partial cancel"},"children":["Partial cancel"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Cancel"},"children":["Cancel"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Partial settlement"},"children":["Partial settlement"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Settlement"},"children":["Settlement"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Partial refund"},"children":["Partial refund"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Refund"},"children":["Refund"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ACH/eCheck"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Alipay CN"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Alipay HK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Alipay+"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["BANCOMAT Pay"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Bancontact"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Bizum"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["BLIK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["China UnionPay"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["EFT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Euteller"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["iDEAL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Klarna"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅ ",{"$$mdtype":"Tag","name":"sup","attributes":{},"children":["1"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅ ",{"$$mdtype":"Tag","name":"sup","attributes":{},"children":["1"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Klarna (recurring)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Konbini"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Multibanco"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["MyBank"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OpenBanking"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PayPal"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅ ",{"$$mdtype":"Tag","name":"sup","attributes":{},"children":["1"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅ ",{"$$mdtype":"Tag","name":"sup","attributes":{},"children":["1"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PaysafeCard"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Pix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Przelewy24"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["SafetyPay"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Satispay"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["SEPA Direct Debit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Swish"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Trustly"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["WeChat Pay"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["✅"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"sup","attributes":{},"children":["1"]}," For payments where ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settlement.auto"]}," is set to \"false\"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-query-response","__idx":4},"children":["Example query response"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"possible-lastevent-values","__idx":5},"children":["Possible ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastEvent"]}," values"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorized"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancelFailed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancelled"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancelledByCustomer"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancelRequested"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["chargebackReversed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["chargedBack"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["disputeExpired"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["disputeFundsHeld"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["disputeFundsReleased"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["disputeReserveReleased"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["disputeInformationRequested"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["disputInformationSupplied"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["manuallyAmended"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["miscellaneous"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refunded"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refundExpired"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refundFailed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refundReversed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refused"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refusedByIssuer"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requestExpired"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentForRefund"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentForSettlement"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentForAuthorization"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settled"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settlementReversed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settlementFailed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["signedFormReceived"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"events","__idx":6},"children":["Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To use our webhooks take a look at our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/events"},"children":["events documentation"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"settle","__idx":7},"children":["Settle"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Make a settle request to settle an authorized payment."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Not all APMs support the settle request. Please refer to the individual APM documentation to understand if this action is supported for the APM."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3/settlements"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No request body is needed for this request."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reverse","__idx":8},"children":["Reverse"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your reverse request is processed as a cancel or refund request. This depends on the time passed after your payment request was completed."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorized"]}," payment status = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancel"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settled"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentForSettlement"]}," payment status = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refund"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[" Not all APMs support the reverse request. Some may only support refund, requiring the payment to be in a settled state before a reverse request can be processed. Please refer to the individual APM documentation to understand if this action is supported for the APM. "]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["POST to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["links:reverse"]}," action link returned in your query response or append the payments \"id\" to the reverse url template."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://access.worldpay.com/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3/reversals"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"full-reverse","__idx":9},"children":["Full reverse"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send a reverse request to return the full amount of the payment to your customer."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No request body is needed for this request."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"partial-reverse","__idx":10},"children":["Partial reverse"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send a partial reverse request to return a portion of the payment amount to your customer."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-partial-request","__idx":11},"children":["Example partial request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n    \"reference\": \"0-128characters\",\n    \"value\": {\n        \"amount\": 25,\n        \"currency\": \"GBP\"\n    }\n}\n"},"children":[]}]},"headings":[{"value":"Manage your APM","id":"manage-your-apm","depth":1},{"value":"Get payment status","id":"get-payment-status","depth":2},{"value":"Query payment","id":"query-payment","depth":3},{"value":"You receive:","id":"you-receive","depth":4},{"value":"Example query response","id":"example-query-response","depth":4},{"value":"Possible lastEvent values","id":"possible-lastevent-values","depth":4},{"value":"Events","id":"events","depth":3},{"value":"Settle","id":"settle","depth":2},{"value":"Reverse","id":"reverse","depth":2},{"value":"Full reverse","id":"full-reverse","depth":2},{"value":"Partial reverse","id":"partial-reverse","depth":2},{"value":"Example partial request","id":"example-partial-request","depth":3}],"frontmatter":{"seo":{"title":"Manage your APM"}},"lastModified":"2026-06-25T12:45:06.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/apms/manage","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}