[{"type":"group","fsPath":"products/3ds/@v3","metadata":{"custom_product":"3DS","type":"openapi","title":"3DS","version":"3","description":"Protect your business and meet regulatory requirements by verifying your customer's identity. Authentication header Authorization: {your_credentials} Replace {your_credentials} with your base64-encoded Basic Auth username and password given to your by your Worldpay Implementation Manager.  <br /> <br /> You must use the Authorization header for any request you send to our 3DS API. Accept/Content-Type header Content-Type: application/vnd.worldpay.verifications.customers-v3.hal+json\nAccept: application/vnd.worldpay.verifications.customers-v3.hal+json We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our 3DS API. We require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a POST or a PUT .  <br /><br /> DNS whitelisting  Whitelist the following URLs: https://try.access.worldpay-bsh.securedataplatform.co.uk/ https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting.","category":["3DS","SCA Exemptions"],"business":["Enterprise"],"catalog-list":true,"generated":false,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":1},"WP API standards (new)":{"uniqueErrors":2,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2F3ds%2Fopenapi"},"link":"/products/3ds/openapi","routeSlug":"/products/3ds/openapi","label":"3DS","version":"v3","isDefault":true,"versionFolderId":"9e210f12","items":[{"type":"link","label":"3DS","link":"/products/3ds/openapi","routeSlug":"/products/3ds/openapi","version":"v3","isDefault":true,"versionFolderId":"9e210f12"},{"label":"Generate required data for 3DS Device Data Collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/3ds/openapi/other/devicedatainitialize","routeSlug":"/products/3ds/openapi/other/devicedatainitialize","metadata":{"seo":{"title":"Generate required data for 3DS Device Data Collection","description":"Allow card issuers to perform Device Data Collection to fingerprint your customer's device."}},"httpPath":"/verifications/customers/3ds/deviceDataInitialization","version":"v3","isDefault":true,"versionFolderId":"9e210f12"},{"label":"Initiate the 3DS authentication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/3ds/openapi/other/authenticate","routeSlug":"/products/3ds/openapi/other/authenticate","metadata":{"seo":{"title":"Initiate the 3DS authentication","description":"Authenticate your customer by submitting order and risk data."}},"httpPath":"/verifications/customers/3ds/authentication","version":"v3","isDefault":true,"versionFolderId":"9e210f12"},{"label":"Verify the 3DS challenge response","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/3ds/openapi/other/verify","routeSlug":"/products/3ds/openapi/other/verify","metadata":{"seo":{"title":"Verify the 3DS challenge response","description":"Verify the results of a challenged authentication."}},"httpPath":"/verifications/customers/3ds/verification","version":"v3","isDefault":true,"versionFolderId":"9e210f12"}],"sidebar":[{"type":"link","label":"3DS","link":"/products/3ds/openapi","routeSlug":"/products/3ds/openapi","version":"v3","isDefault":true,"versionFolderId":"9e210f12"}]},{"type":"group","fsPath":"products/account-payouts/@20250101","metadata":{"custom_product":"Account Payouts","type":"openapi","title":"Account Payouts","version":"2025-01-01","description":"Send funds to your customer's bank accounts and search for payouts using parameters. Authentication header Authorization: {your_credentials}  Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.  <br /> <br />  You must use the Authorization header for any request you send to our Account Payouts API  <br /><br />  WP-Api-Version header  WP-Api-Version: 2025-01-01 We use the WP-Api-Version header to identify which version of our API you are using.  <br /><br />  DNS whitelisting Whitelist the following URLs:  * https://try.access.worldpay-bsh.securedataplatform.co.uk/  * https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.","business":["Enterprise","Marketplaces"],"catalog-list":true,"category":["Payouts"],"generated":true,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":3},"WP API standards (new)":{"uniqueErrors":2,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Faccount-payouts%2Fopenapi"},"link":"/products/account-payouts/openapi","routeSlug":"/products/account-payouts/openapi","label":"Account Payouts","version":"20250101","isDefault":true,"versionFolderId":"7d817e0b","items":[{"type":"link","label":"Account Payouts","link":"/products/account-payouts/openapi","routeSlug":"/products/account-payouts/openapi","version":"20250101","isDefault":true,"versionFolderId":"7d817e0b"},{"type":"group","label":"Single payout","link":"/products/account-payouts/openapi/single-payout","routeSlug":"/products/account-payouts/openapi/single-payout","items":[{"label":"Make a single payout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/account-payouts/openapi/single-payout/postpayout","routeSlug":"/products/account-payouts/openapi/single-payout/postpayout","metadata":{"seo":{"title":"Make a single payout","description":"Make a single payout"}},"httpPath":"/accountPayouts","version":"20250101","isDefault":true,"versionFolderId":"7d817e0b"}],"version":"20250101","isDefault":true,"versionFolderId":"7d817e0b"},{"type":"group","label":"Batch payout","link":"/products/account-payouts/openapi/batch-payout","routeSlug":"/products/account-payouts/openapi/batch-payout","items":[{"label":"Make a batch payout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/account-payouts/openapi/batch-payout/postbatchpayout","routeSlug":"/products/account-payouts/openapi/batch-payout/postbatchpayout","metadata":{"seo":{"title":"Make a batch payout","description":"Make a batch payout"}},"httpPath":"/accountPayouts/batch","version":"20250101","isDefault":true,"versionFolderId":"7d817e0b"}],"version":"20250101","isDefault":true,"versionFolderId":"7d817e0b"},{"type":"group","label":"Get payouts by Payout Request ID","link":"/products/account-payouts/openapi/get-payouts-by-payout-request-id","routeSlug":"/products/account-payouts/openapi/get-payouts-by-payout-request-id","items":[{"label":"Retrieve payout details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/account-payouts/openapi/get-payouts-by-payout-request-id/getbypayoutrequestid","routeSlug":"/products/account-payouts/openapi/get-payouts-by-payout-request-id/getbypayoutrequestid","metadata":{"seo":{"title":"Retrieve payout details","description":"Retrieve payout details"}},"httpPath":"/accountPayouts/{payoutRequestId}","version":"20250101","isDefault":true,"versionFolderId":"7d817e0b"}],"version":"20250101","isDefault":true,"versionFolderId":"7d817e0b"},{"type":"group","label":"Get payouts","link":"/products/account-payouts/openapi/get-payouts","routeSlug":"/products/account-payouts/openapi/get-payouts","items":[{"label":"Retrieve payout details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/account-payouts/openapi/get-payouts/getbyquery","routeSlug":"/products/account-payouts/openapi/get-payouts/getbyquery","metadata":{"seo":{"title":"Retrieve payout details","description":"Retrieve payout details"}},"httpPath":"/accountPayouts/events","version":"20250101","isDefault":true,"versionFolderId":"7d817e0b"}],"version":"20250101","isDefault":true,"versionFolderId":"7d817e0b"}],"sidebar":[{"type":"link","label":"Account Payouts","link":"/products/account-payouts/openapi","routeSlug":"/products/account-payouts/openapi","version":"20250101","isDefault":true,"versionFolderId":"7d817e0b"}]},{"type":"group","fsPath":"products/account-verifications/@20250101","metadata":{"type":"openapi","title":"Beneficiary Account Verifications (BAV)","version":"2025-01-01","description":"Verify that the bank details of your beneficiary are valid before sending a payout.<br><br>  Authentication header Authorization: {your_credentials}\n  WP-Api-Version: 2025-01-01 Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.  <br /> <br />  You must use the Authorization header for any request you send to our Beneficiary Account Verifications API, unless you are using client certificate authenticating with SSL/TLS .  <br /><br /> DNS whitelisting Whitelist the following URLs: https://try.access.worldpay-bsh.securedataplatform.co.uk/ https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.","category":["Verifications"],"business":["Enterprise","Marketplaces"],"catalog-list":true,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":2},"WP API standards (new)":{"uniqueErrors":2,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Faccount-verifications%2Fopenapi"},"link":"/products/account-verifications/openapi","routeSlug":"/products/account-verifications/openapi","label":"Beneficiary Account Verifications (BAV)","version":"20250101","isDefault":true,"versionFolderId":"809c5cbe","items":[{"type":"link","label":"Beneficiary Account Verifications (BAV)","link":"/products/account-verifications/openapi","routeSlug":"/products/account-verifications/openapi","version":"20250101","isDefault":true,"versionFolderId":"809c5cbe"},{"label":"Verify a beneficiary account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/account-verifications/openapi/other/postaccountverifications","routeSlug":"/products/account-verifications/openapi/other/postaccountverifications","metadata":{"seo":{"title":"Verify a beneficiary account","description":"Verify a beneficiary account"}},"httpPath":"/accountVerifications","version":"20250101","isDefault":true,"versionFolderId":"809c5cbe"}],"sidebar":[{"type":"link","label":"Beneficiary Account Verifications (BAV)","link":"/products/account-verifications/openapi","routeSlug":"/products/account-verifications/openapi","version":"20250101","isDefault":true,"versionFolderId":"809c5cbe"}]},{"type":"group","fsPath":"products/apms/@20240701","metadata":{"custom_product":"APMs","type":"openapi","title":"APMs","version":"2024-07-01","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later Set your headers Authorization: {your_credentials}\n   Content-Type: application/json\n   WP-Api-Version: 2024-07-01 Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager. You must use the Authorization header for any request you send to our APMs API. DNS Whitelisting Whitelist the following URLs: https://try.access.worldpay-bsh.securedataplatform.co.uk/ https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting.  When you make a request within Access Worldpay, you should always cache the response returned.","business":"Enterprise","generated":true,"category":"Alternative Payments","catalog-list":true,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":1},"WP API standards (new)":{"uniqueErrors":1,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fapms%2Fopenapi"},"link":"/products/apms/openapi","routeSlug":"/products/apms/openapi","label":"APMs","version":"20240701","isDefault":true,"versionFolderId":"c6e104b6","items":[{"type":"link","label":"APMs","link":"/products/apms/openapi","routeSlug":"/products/apms/openapi","version":"20240701","isDefault":true,"versionFolderId":"c6e104b6"},{"type":"group","label":"Payment","link":"/products/apms/openapi/payment","routeSlug":"/products/apms/openapi/payment","items":[{"label":"Create an APM payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/apms/openapi/payment/paymentv2","routeSlug":"/products/apms/openapi/payment/paymentv2","metadata":{"seo":{"title":"Create an APM payment","description":"Perform a sale."}},"httpPath":"/apmPayments","version":"20240701","isDefault":true,"versionFolderId":"c6e104b6"}],"version":"20240701","isDefault":true,"versionFolderId":"c6e104b6"},{"type":"group","label":"Payment Lifecycle","link":"/products/apms/openapi/payment-lifecycle","routeSlug":"/products/apms/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/openapi/payment-lifecycle/query","routeSlug":"/products/apms/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."}},"httpPath":"/apmPayments/{paymentId}","version":"20240701","isDefault":true,"versionFolderId":"c6e104b6"},{"label":"Confirm APM payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/apms/openapi/payment-lifecycle/confirmpaymentv2","routeSlug":"/products/apms/openapi/payment-lifecycle/confirmpaymentv2","metadata":{"seo":{"title":"Confirm APM payment","description":"Create a confirm payment request for smart button functionality."}},"httpPath":"/apmPayments/{paymentId}/confirmations","version":"20240701","isDefault":true,"versionFolderId":"c6e104b6"},{"label":"Reverse an APM payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/apms/openapi/payment-lifecycle/reverse","routeSlug":"/products/apms/openapi/payment-lifecycle/reverse","metadata":{"seo":{"title":"Reverse an APM payment","description":"Perform a reversal on the funds taken from a sale."}},"httpPath":"/apmPayments/{paymentId}/reversals","version":"20240701","isDefault":true,"versionFolderId":"c6e104b6"},{"label":"Partial reverse an APM payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/apms/openapi/payment-lifecycle/partialreversev2","routeSlug":"/products/apms/openapi/payment-lifecycle/partialreversev2","metadata":{"seo":{"title":"Partial reverse an APM payment","description":"Perform a partial reversal on the funds taken from a sale."}},"httpPath":"/apmPayments/{paymentId}/partialReversals","version":"20240701","isDefault":true,"versionFolderId":"c6e104b6"},{"label":"Settle an APM payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/apms/openapi/payment-lifecycle/settle","routeSlug":"/products/apms/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."}},"httpPath":"/apmPayments/{paymentId}/settlements","version":"20240701","isDefault":true,"versionFolderId":"c6e104b6"},{"label":"Partial settle an APM payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/apms/openapi/payment-lifecycle/partialsettlev2","routeSlug":"/products/apms/openapi/payment-lifecycle/partialsettlev2","metadata":{"seo":{"title":"Partial 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."}},"httpPath":"/apmPayments/{paymentId}/partialSettlements","version":"20240701","isDefault":true,"versionFolderId":"c6e104b6"}],"version":"20240701","isDefault":true,"versionFolderId":"c6e104b6"}],"sidebar":[{"type":"link","label":"APMs","link":"/products/apms/openapi","routeSlug":"/products/apms/openapi","version":"20240701","isDefault":true,"versionFolderId":"c6e104b6"}]},{"type":"group","fsPath":"products/balance/@20250101","metadata":{"custom_product":"Balances","type":"openapi","title":"Balances","version":"2025-01-01","description":"Get accounts data. Authentication header Authorization: {your_credentials}  Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.  <br /> <br />  You must use the Authorization header for any request you send to our Balances API.  <br /><br />  WP-Api-Version Header  WP-Api-Version: 2025-01-01 We use the WP-Api-Version header to identify which version of our API you are using. You must use the WP-Api-Version header for any request you send.  <br /><br />  DNS whitelisting Whitelist the following URLs:  * https://try.access.worldpay-bsh.securedataplatform.co.uk/  * https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.","business":["Enterprise","Marketplaces"],"catalog-list":true,"category":["Accounts"],"generated":true,"scorecardStatus":"MINIMUM","scorecardLevel":"WP API standards (new)","scorecardLevelIdx":2,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":1},"WP API standards (new)":{"uniqueErrors":0,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fbalance%2Fopenapi"},"link":"/products/balance/openapi","routeSlug":"/products/balance/openapi","label":"Balances","version":"20250101","isDefault":true,"versionFolderId":"566949f1","items":[{"type":"link","label":"Balances","link":"/products/balance/openapi","routeSlug":"/products/balance/openapi","version":"20250101","isDefault":true,"versionFolderId":"566949f1"},{"label":"Get account details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/balance/openapi/other/receivetransferrequestforaccount","routeSlug":"/products/balance/openapi/other/receivetransferrequestforaccount","metadata":{"seo":{"title":"Get account details","description":"Retrieve the details of one specific account."}},"httpPath":"/accounts/{accountNumber}","version":"20250101","isDefault":true,"versionFolderId":"566949f1"},{"label":"Get details for all your accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/balance/openapi/other/receivetransferrequest","routeSlug":"/products/balance/openapi/other/receivetransferrequest","metadata":{"seo":{"title":"Get details for all your accounts","description":"Retrieve account details for all your accounts."}},"httpPath":"/accounts","version":"20250101","isDefault":true,"versionFolderId":"566949f1"}],"sidebar":[{"type":"link","label":"Balances","link":"/products/balance/openapi","routeSlug":"/products/balance/openapi","version":"20250101","isDefault":true,"versionFolderId":"566949f1"}]},{"type":"group","fsPath":"products/card-bin/@v2","metadata":{"custom_product":"Card Bin","type":"openapi","title":"Card BIN Data","version":"2","description":"Lookup card metadata from a Primary Account Number (PAN), Network Token Number, or Worldpay token href. Returns: card brand(s), BIN and BIN length, PAN length, funding type, issuer name, issuer country (ISO alpha-2), default currency (ISO alpha-3), DCC eligibility, anonymous prepaid / AMLD5 compliance status, card category (consumer or commercial), product ID, product subtype, flexible credential participation including the Visa deployment model and account funding transactions support for domestic and cross-border. <br><br> Set your headers Authorization: {your_credentials}\n  Content-Type: application/json\n  WP-Api-Version: 2 Replace {your_credentials} with your base64-encoded Basic Auth username:password given to you by your Worldpay Implementation Manager. <br/><br/> We require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a POST or a PUT . <br/><br/> We use the WP-Api-Version header to identify which version of our API you are using. You must use this header for any request you send to our Card BIN API. <br/><br/>  DNS whitelisting <br> Whitelist the following URLs:<br> * https://try.access.worldpay-bsh.securedataplatform.co.uk/ <br> * https://access.worldpay-bsh.securedataplatform.co.uk/ <br><br>  Please ensure you use DNS whitelisting, not explicit IP whitelisting.","category":["Card BIN"],"business":["Enterprise"],"catalog-list":true,"generated":false,"scorecardStatus":"MINIMUM","scorecardLevel":"WP API standards (new)","scorecardLevelIdx":2,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":1},"WP API standards (new)":{"uniqueErrors":0,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fcard-bin%2Fopenapi"},"link":"/products/card-bin/openapi","routeSlug":"/products/card-bin/openapi","label":"Card BIN Data","version":"v2","isDefault":true,"versionFolderId":"9e19fa74","items":[{"type":"link","label":"Card BIN Data","link":"/products/card-bin/openapi","routeSlug":"/products/card-bin/openapi","version":"v2","isDefault":true,"versionFolderId":"9e19fa74"},{"type":"group","label":"Card Lookup","link":"/products/card-bin/openapi/card-lookup","routeSlug":"/products/card-bin/openapi/card-lookup","items":[{"label":"Lookup BIN data using a card number or Worldpay token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-bin/openapi/card-lookup/getcardbindata","routeSlug":"/products/card-bin/openapi/card-lookup/getcardbindata","metadata":{"seo":{"title":"Lookup BIN data using a card number or Worldpay token","description":"Returns card metadata for the supplied payment instrument. This is a read-only lookup with no side effects - safe to retry on network errors."}},"httpPath":"/api/cardBin/panLookup","version":"v2","isDefault":true,"versionFolderId":"9e19fa74"}],"version":"v2","isDefault":true,"versionFolderId":"9e19fa74"}],"sidebar":[{"type":"link","label":"Card BIN Data","link":"/products/card-bin/openapi","routeSlug":"/products/card-bin/openapi","version":"v2","isDefault":true,"versionFolderId":"9e19fa74"}]},{"type":"group","fsPath":"products/card-bin/@v1","metadata":{"custom_product":"Card Bin","type":"openapi","title":"Card BIN Data","version":"1","description":"Retrieve detailed information about a card. Header Authorization: {your_credentials}\n    Content-Type: application/json\n    WP-Api-Version: 1 Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.  <br><br>  You must use the Authorization header for any request you send to our Card BIN Data API. <br /><br /> DNS whitelisting Whitelist the following URLs:  * https://try.access.worldpay-bsh.securedataplatform.co.uk/  * https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting.  When you make a request within Access Worldpay, you should always cache the response returned.","category":["Card BIN"],"business":["Enterprise"],"catalog-list":true,"generated":false,"scorecardStatus":"MINIMUM","scorecardLevel":"WP API standards (new)","scorecardLevelIdx":2,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":0},"WP API standards (new)":{"uniqueErrors":0,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fcard-bin%2Fv1%2Fopenapi"},"link":"/products/card-bin/v1/openapi","routeSlug":"/products/card-bin/v1/openapi","label":"Card BIN Data","version":"v1","isDefault":false,"versionFolderId":"9e19fa74","items":[{"type":"link","label":"Card BIN Data","link":"/products/card-bin/v1/openapi","routeSlug":"/products/card-bin/v1/openapi","version":"v1","isDefault":false,"versionFolderId":"9e19fa74"},{"label":"Get BIN data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-bin/v1/openapi/other/panlookup","routeSlug":"/products/card-bin/v1/openapi/other/panlookup","metadata":{"seo":{"title":"Get BIN data","description":"Returns card BIN data for the card number or Worldpay token supplied."}},"httpPath":"/cardBin/panLookup","version":"v1","isDefault":false,"versionFolderId":"9e19fa74"}],"sidebar":[{"type":"link","label":"Card BIN Data","link":"/products/card-bin/v1/openapi","routeSlug":"/products/card-bin/v1/openapi","version":"v1","isDefault":false,"versionFolderId":"9e19fa74"}]},{"type":"group","fsPath":"products/card-payments/@v7","metadata":{"custom_product":"Card Payments","type":"openapi","title":"Card Payments","version":"7","description":"Take online payments with our Card Payments API. Authentication header Authorization: {your_credentials} Replace {your_credentials} with your base64-encoded Basic Auth username and password given to your by your Worldpay Implementation Manager.  <br /> <br /> You must use the Authorization header for any request you send to our Card Payments API. Accept/Content-Type header Content-Type: application/vnd.worldpay.payments-v7+json\nAccept: application/vnd.worldpay.payments-v7+json We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Card Payments API. We require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a POST or a PUT .  <br /><br /> DNS whitelisting  Whitelist the following URLs: https://try.access.worldpay-bsh.securedataplatform.co.uk/ https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting.","category":["Card Payments","Wallets"],"business":["Enterprise","Marketplaces"],"catalog-list":true,"generated":false,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":2},"WP API standards (new)":{"uniqueErrors":3,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fcard-payments%2Fopenapi"},"link":"/products/card-payments/openapi","routeSlug":"/products/card-payments/openapi","label":"Card Payments","version":"v7","isDefault":true,"versionFolderId":"5e391095","items":[{"type":"link","label":"Card Payments","link":"/products/card-payments/openapi","routeSlug":"/products/card-payments/openapi","version":"v7","isDefault":true,"versionFolderId":"5e391095"},{"label":"Take a card payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payments/openapi/other/authorize","routeSlug":"/products/card-payments/openapi/other/authorize","metadata":{"seo":{"title":"Take a card payment","description":"Take online card payments using our Card Payments API."}},"httpPath":"/cardPayments/customerInitiatedTransactions","version":"v7","isDefault":true,"versionFolderId":"5e391095"},{"label":"Take a repeat card payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payments/openapi/other/recurring","routeSlug":"/products/card-payments/openapi/other/recurring","metadata":{"seo":{"title":"Take a repeat card payment","description":"Take online payments using our Card Payments API."}},"httpPath":"/cardPayments/merchantInitiatedTransactions","version":"v7","isDefault":true,"versionFolderId":"5e391095"},{"type":"group","label":"Manage payments","link":"/products/card-payments/openapi/manage-payments","routeSlug":"/products/card-payments/openapi/manage-payments","items":[{"label":"Settle for full amount","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payments/openapi/manage-payments/settle","routeSlug":"/products/card-payments/openapi/manage-payments/settle","metadata":{"seo":{"title":"Settle for full amount","description":"To receive all the funds from the customer, send us a settle request."}},"httpPath":"/payments/settlements/full/{linkData}","version":"v7","isDefault":true,"versionFolderId":"5e391095"},{"label":"Settle for partial amount","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payments/openapi/manage-payments/partialsettlement","routeSlug":"/products/card-payments/openapi/manage-payments/partialsettlement","metadata":{"seo":{"title":"Settle for partial amount","description":"To receive a portion of the funds of a payment, send us a partial settle request."}},"httpPath":"/payments/settlements/partials/{linkData}","version":"v7","isDefault":true,"versionFolderId":"5e391095"},{"label":"Refund full amount","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payments/openapi/manage-payments/refund","routeSlug":"/products/card-payments/openapi/manage-payments/refund","metadata":{"seo":{"title":"Refund full amount","description":"Send a refund request to return the full settled amount to your customer."}},"httpPath":"/payments/settlements/refunds/full/{linkData}","version":"v7","isDefault":true,"versionFolderId":"5e391095"},{"label":"Refund partial amount","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payments/openapi/manage-payments/partialrefund","routeSlug":"/products/card-payments/openapi/manage-payments/partialrefund","metadata":{"seo":{"title":"Refund partial amount","description":"Send a partial refund request to return a portion of the settled amount to your customer. Send the amount to refund and the authorization currency in the body."}},"httpPath":"/payments/settlements/refunds/partials/{linkData}","version":"v7","isDefault":true,"versionFolderId":"5e391095"},{"label":"Cancel full authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payments/openapi/manage-payments/cancel","routeSlug":"/products/card-payments/openapi/manage-payments/cancel","metadata":{"seo":{"title":"Cancel full authorization","description":"If you don't want to proceed with a payment, you can send a full cancel request."}},"httpPath":"/payments/authorizations/cancellations/{linkData}","version":"v7","isDefault":true,"versionFolderId":"5e391095"},{"label":"Cancel partial authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payments/openapi/manage-payments/partialcancel","routeSlug":"/products/card-payments/openapi/manage-payments/partialcancel","metadata":{"seo":{"title":"Cancel partial authorization","description":"If you don't want to proceed with a payment, you can send a partial cancel request."}},"httpPath":"/payments/authorizations/cancellations/partials/{linkData}","version":"v7","isDefault":true,"versionFolderId":"5e391095"},{"label":"Increase authorization amount","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payments/openapi/manage-payments/increaseauthorize","routeSlug":"/products/card-payments/openapi/manage-payments/increaseauthorize","metadata":{"seo":{"title":"Increase authorization amount","description":"If you want to increase an initial estimated authorization amount (submitted with estimated set to true), you can send a incremental authorization request."}},"httpPath":"/payments/authorizations/incrementalAuthorizations/{linkData}","version":"v7","isDefault":true,"versionFolderId":"5e391095"},{"label":"Reversal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payments/openapi/manage-payments/reversal","routeSlug":"/products/card-payments/openapi/manage-payments/reversal","metadata":{"seo":{"title":"Reversal","description":"Your reversal request is processed as a cancel or refund request. This depends on the time passed after your sale request was submitted. For US entities the payment is refunded after one day after a successful sale request. Any other payment moves to refunded after 15 minutes."}},"httpPath":"/payments/sales/reversals/{linkData}","version":"v7","isDefault":true,"versionFolderId":"5e391095"}],"version":"v7","isDefault":true,"versionFolderId":"5e391095"},{"type":"group","label":"Recover payments","link":"/products/card-payments/openapi/recover-payments","routeSlug":"/products/card-payments/openapi/recover-payments","items":[{"label":"Recover payment status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payments/openapi/recover-payments/eventrecovery","routeSlug":"/products/card-payments/openapi/recover-payments/eventrecovery","metadata":{"seo":{"title":"Recover payment status","description":"Send a request to find out the current status of your payment after it has been authorized using its associated transactionReference and entity."}},"httpPath":"/payments/events","version":"v7","isDefault":true,"versionFolderId":"5e391095"},{"label":"Query payment status","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payments/openapi/recover-payments/eventquery","routeSlug":"/products/card-payments/openapi/recover-payments/eventquery","metadata":{"seo":{"title":"Query payment status","description":"Send a request to find out the current status of your payment after it has been authorized using the events action link."}},"badges":[{"name":"Deprecated - Use Payment Queries API","color":"orange"}],"httpPath":"/payments/events/{linkData}","version":"v7","isDefault":true,"versionFolderId":"5e391095"}],"version":"v7","isDefault":true,"versionFolderId":"5e391095"}],"sidebar":[{"type":"link","label":"Card Payments","link":"/products/card-payments/openapi","routeSlug":"/products/card-payments/openapi","version":"v7","isDefault":true,"versionFolderId":"5e391095"}]},{"type":"group","fsPath":"products/card-payouts/@v4","metadata":{"custom_product":"Card Payouts","type":"openapi","title":"Card Payouts","version":"4","description":"Send funds to your customer's cards. Standard or using Fast Access. Authentication Set your headers: Authorization: {your_credentials}\n  Content-Type: application/vnd.worldpay.payouts-v4+json\n  Accept: application/vnd.worldpay.payouts-v4+json Replace {your_credentials} with your base64-encoded Basic Auth username and password. <br> DNS whitelisting Whitelist the following URLs: https://try.access.worldpay-bsh.securedataplatform.co.uk/ https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.","category":["Payouts"],"business":["Enterprise"],"catalog-list":true,"generated":false,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":2},"WP API standards (new)":{"uniqueErrors":3,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fcard-payouts%2Fopenapi"},"link":"/products/card-payouts/openapi","routeSlug":"/products/card-payouts/openapi","label":"Card Payouts","version":"v4","isDefault":true,"versionFolderId":"c6ff1dc0","items":[{"type":"link","label":"Card Payouts","link":"/products/card-payouts/openapi","routeSlug":"/products/card-payouts/openapi","version":"v4","isDefault":true,"versionFolderId":"c6ff1dc0"},{"label":"Retrieve payout details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payouts/openapi/other/getpayoutsdetails","routeSlug":"/products/card-payouts/openapi/other/getpayoutsdetails","metadata":{"seo":{"title":"Retrieve payout details","description":"Retrieve the details of an existing basic disbursement or Fast Access payout."}},"httpPath":"/payouts/{resource}","version":"v4","isDefault":true,"versionFolderId":"c6ff1dc0"},{"label":"Retrieve payout details from a historic resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payouts/openapi/other/querypayouts","routeSlug":"/products/card-payouts/openapi/other/querypayouts","metadata":{"seo":{"title":"Retrieve payout details from a historic resource","description":"Query by transaction reference and entity to retrieve a payout."}},"httpPath":"/payouts/query","version":"v4","isDefault":true,"versionFolderId":"c6ff1dc0"},{"label":"Standard payout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payouts/openapi/other/basicdisbursement","routeSlug":"/products/card-payouts/openapi/other/basicdisbursement","metadata":{"seo":{"title":"Standard payout","description":"Disburse funds to a payout instrument."}},"httpPath":"/payouts/basicDisbursement","version":"v4","isDefault":true,"versionFolderId":"c6ff1dc0"},{"label":"Fast Access payout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-payouts/openapi/other/fastaccess","routeSlug":"/products/card-payouts/openapi/other/fastaccess","metadata":{"seo":{"title":"Fast Access payout","description":"Disburse funds to a payout instrument using Fast Access."}},"httpPath":"/payouts/fastAccess","version":"v4","isDefault":true,"versionFolderId":"c6ff1dc0"}],"sidebar":[{"type":"link","label":"Card Payouts","link":"/products/card-payouts/openapi","routeSlug":"/products/card-payouts/openapi","version":"v4","isDefault":true,"versionFolderId":"c6ff1dc0"}]},{"type":"group","fsPath":"products/card-verifications/@v6","metadata":{"custom_product":"Card Verifications","type":"openapi","title":"Card Verifications","version":"6","description":"Determine the validity of your customer's card to maximize authorization rates.<br><br> Authentication header Authorization: {your_credentials} Replace {your_credentials} with your base64-encoded Basic Auth username and password given to your by your Worldpay Implementation Manager. <br /> <br />  You must use the Authorization header for any request you send to our Card Verifications API. <br><br> Accept/Content-Type header for card verifications Content-Type : application/vnd.worldpay.cardVerifications-v6+json,\nAccept : application/vnd.worldpay.cardVerifications-v6+json <br> Accept/Content-Type header for ACH verifications (US accounts) Content-Type : application/vnd.worldpay.achVerifications-v6+json,\nAccept : application/vnd.worldpay.achVerifications-v6+json <br> We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Card Verifications API. <br><br> We require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a POST or a PUT . <br /><br />  DNS whitelisting <br><br> Whitelist the following URLs:<br><br> * https://try.access.worldpay-bsh.securedataplatform.co.uk/ <br> * https://access.worldpay-bsh.securedataplatform.co.uk/ <br><br>  Please ensure you use DNS whitelisting, not explicit IP whitelisting.","category":["Verifications"],"business":["Enterprise"],"catalog-list":true,"generated":false,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":4},"WP API standards (new)":{"uniqueErrors":4,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fcard-verifications%2Fopenapi"},"link":"/products/card-verifications/openapi","routeSlug":"/products/card-verifications/openapi","label":"Card Verifications","version":"v6","isDefault":true,"versionFolderId":"17a671ff","items":[{"type":"link","label":"Card Verifications","link":"/products/card-verifications/openapi","routeSlug":"/products/card-verifications/openapi","version":"v6","isDefault":true,"versionFolderId":"17a671ff"},{"label":"Card Verification / Name Inquiry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-verifications/openapi/other/cardverify","routeSlug":"/products/card-verifications/openapi/other/cardverify","metadata":{"seo":{"title":"Card Verification / Name Inquiry","description":"Verify your customer's card. Perform a name inquiry to verify the name of the cardholder."}},"httpPath":"/cardVerifications","version":"v6","isDefault":true,"versionFolderId":"17a671ff"},{"label":"ACH verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-verifications/openapi/other/ach","routeSlug":"/products/card-verifications/openapi/other/ach","metadata":{"seo":{"title":"ACH verification","description":"Successful account verification outcome."}},"httpPath":"/achVerifications","version":"v6","isDefault":true,"versionFolderId":"17a671ff"},{"label":"Query a previous verification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/card-verifications/openapi/other/getcardverificationbyresourceid","routeSlug":"/products/card-verifications/openapi/other/getcardverificationbyresourceid","metadata":{"seo":{"title":"Query a previous verification","description":"Querying of a successful verification."}},"httpPath":"/cardVerifications/{linkData}","version":"v6","isDefault":true,"versionFolderId":"17a671ff"}],"sidebar":[{"type":"link","label":"Card Verifications","link":"/products/card-verifications/openapi","routeSlug":"/products/card-verifications/openapi","version":"v6","isDefault":true,"versionFolderId":"17a671ff"}]},{"type":"group","fsPath":"products/events/@v1","metadata":{"custom_product":"Events","type":"openapi","title":"Events","version":"1","description":"Receive status updates from Access Worldpay by setting up a webhook. Contact your Worldpay Implementation Manager to add your webhook URL and enable or disable the events based on your requirement. The webhook destination (URL) must use an encrypted connection ( https ) and have a certificate signed by a trusted certificate authority. Every certificate within the chain, including the root, must be using a certificate signing algorithm of SHA-256 or better. Support for certificate chains involving any certs with the SHA-1 certificate signing algorithm ends March 2026. <style>  [class*=\"tag-post\"] {  display: none;  }  </style>","category":["Webhooks"],"business":["Enterprise"],"catalog-list":true,"generated":false,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":0},"WP API standards (new)":{"uniqueErrors":1,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fevents%2Fopenapi"},"link":"/products/events/openapi","routeSlug":"/products/events/openapi","label":"Events","version":"v1","isDefault":true,"versionFolderId":"5ea8243d","items":[{"type":"link","label":"Events","link":"/products/events/openapi","routeSlug":"/products/events/openapi","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"type":"group","label":"Payment","link":"/products/events/openapi/payment","routeSlug":"/products/events/openapi/payment","items":[{"label":"sentForAuthorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/sentforauthorizationpayment","routeSlug":"/products/events/openapi/payment/sentforauthorizationpayment","metadata":{"seo":{"title":"sentForAuthorization","description":"sentForAuthorization"}},"httpPath":"sentForAuthorization","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"authorized","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/authorizedpayment","routeSlug":"/products/events/openapi/payment/authorizedpayment","metadata":{"seo":{"title":"authorized","description":"authorized"}},"httpPath":"authorized","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"sentForSettlement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/sentforsettlementpayment","routeSlug":"/products/events/openapi/payment/sentforsettlementpayment","metadata":{"seo":{"title":"sentForSettlement","description":"sentForSettlement"}},"httpPath":"sentForSettlement","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"settled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/settledpayment","routeSlug":"/products/events/openapi/payment/settledpayment","metadata":{"seo":{"title":"settled","description":"settled"}},"httpPath":"settled","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"settlementFailed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/settlementfailedpayment","routeSlug":"/products/events/openapi/payment/settlementfailedpayment","metadata":{"seo":{"title":"settlementFailed","description":"settlementFailed"}},"httpPath":"settlementFailed","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"cancelled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/cancelledpayment","routeSlug":"/products/events/openapi/payment/cancelledpayment","metadata":{"seo":{"title":"cancelled","description":"cancelled"}},"httpPath":"cancelled","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"error","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/errorpayment","routeSlug":"/products/events/openapi/payment/errorpayment","metadata":{"seo":{"title":"error","description":"error"}},"httpPath":"error","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"expired","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/expiredpayment","routeSlug":"/products/events/openapi/payment/expiredpayment","metadata":{"seo":{"title":"expired","description":"expired"}},"httpPath":"expired","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"refused","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/refusedpayment","routeSlug":"/products/events/openapi/payment/refusedpayment","metadata":{"seo":{"title":"refused","description":"refused"}},"httpPath":"refused","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"sentForRefund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/sentforrefundpayment","routeSlug":"/products/events/openapi/payment/sentforrefundpayment","metadata":{"seo":{"title":"sentForRefund","description":"sentForRefund"}},"httpPath":"sentForRefund","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"refunded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/refundedpayment","routeSlug":"/products/events/openapi/payment/refundedpayment","metadata":{"seo":{"title":"refunded","description":"refunded"}},"httpPath":"refunded","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"refundFailed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/refundfailedpayment","routeSlug":"/products/events/openapi/payment/refundfailedpayment","metadata":{"seo":{"title":"refundFailed","description":"refundFailed"}},"httpPath":"refundFailed","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"tokenCreated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/tokencreated","routeSlug":"/products/events/openapi/payment/tokencreated","metadata":{"seo":{"title":"tokenCreated","description":"tokenCreated"}},"httpPath":"tokenCreated","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"settlementInstructed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/settlementinstructedpayment","routeSlug":"/products/events/openapi/payment/settlementinstructedpayment","metadata":{"seo":{"title":"settlementInstructed","description":"settlementInstructed"}},"httpPath":"settlementInstructed","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"settlementRejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/settlementrejectedpayment","routeSlug":"/products/events/openapi/payment/settlementrejectedpayment","metadata":{"seo":{"title":"settlementRejected","description":"settlementRejected"}},"httpPath":"settlementRejected","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"topUpAccepted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/topupacceptedpayment","routeSlug":"/products/events/openapi/payment/topupacceptedpayment","metadata":{"seo":{"title":"topUpAccepted","description":"topUpAccepted"}},"httpPath":"topUpAccepted","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"topUpRejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/topuprejectedpayment","routeSlug":"/products/events/openapi/payment/topuprejectedpayment","metadata":{"seo":{"title":"topUpRejected","description":"topUpRejected"}},"httpPath":"topUpRejected","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"chargedBack","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/chargedbackpayment","routeSlug":"/products/events/openapi/payment/chargedbackpayment","metadata":{"seo":{"title":"chargedBack","description":"chargedBack"}},"httpPath":"chargedBack","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"cancelledByCustomer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/cancelledbycustomerpayment","routeSlug":"/products/events/openapi/payment/cancelledbycustomerpayment","metadata":{"seo":{"title":"cancelledByCustomer","description":"cancelledByCustomer"}},"httpPath":"cancelledByCustomer","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"requestExpired","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payment/requestexpiredpayment","routeSlug":"/products/events/openapi/payment/requestexpiredpayment","metadata":{"seo":{"title":"requestExpired","description":"requestExpired"}},"httpPath":"requestExpired","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"}],"version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"type":"group","label":"Payout","link":"/products/events/openapi/payout","routeSlug":"/products/events/openapi/payout","items":[{"label":"disbursed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payout/disbursedpayout","routeSlug":"/products/events/openapi/payout/disbursedpayout","metadata":{"seo":{"title":"disbursed","description":"disbursed"}},"httpPath":"disbursed","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"pending","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payout/pendingpayout","routeSlug":"/products/events/openapi/payout/pendingpayout","metadata":{"seo":{"title":"pending","description":"pending"}},"httpPath":"pending","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"refused","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payout/refusedpayout","routeSlug":"/products/events/openapi/payout/refusedpayout","metadata":{"seo":{"title":"refused","description":"refused"}},"httpPath":"refusedPayout","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"requested","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payout/requestedpayout","routeSlug":"/products/events/openapi/payout/requestedpayout","metadata":{"seo":{"title":"requested","description":"requested"}},"httpPath":"requestedPayout","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"label":"approved","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/payout/approvedpayout","routeSlug":"/products/events/openapi/payout/approvedpayout","metadata":{"seo":{"title":"approved","description":"approved"}},"httpPath":"approvedPayout","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"}],"version":"v1","isDefault":true,"versionFolderId":"5ea8243d"},{"type":"group","label":"Chargeback","link":"/products/events/openapi/chargeback","routeSlug":"/products/events/openapi/chargeback","items":[{"label":"informationRequested","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/events/openapi/chargeback/informationrequestedchargeback","routeSlug":"/products/events/openapi/chargeback/informationrequestedchargeback","metadata":{"seo":{"title":"informationRequested","description":"informationRequested"}},"httpPath":"informationRequested","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"}],"version":"v1","isDefault":true,"versionFolderId":"5ea8243d"}],"sidebar":[{"type":"link","label":"Events","link":"/products/events/openapi","routeSlug":"/products/events/openapi","version":"v1","isDefault":true,"versionFolderId":"5ea8243d"}]},{"type":"group","fsPath":"products/fraudsight/@v1","metadata":{"custom_product":"FraudSight","type":"openapi","title":"FraudSight","version":"v1","description":"Request a risk assessment and prevent fraud with this standalone API.<br><br> Authentication header Authorization: {your_credentials} Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.  <br /> <br />  You must use the Authorization header for any request you send to our FraudSight API.  <br /><br />  Accept and Content-Type headers Content-Type: application/vnd.worldpay.fraudsight-v1.hal+json\nAccept: application/vnd.worldpay.fraudsight-v1.hal+json We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our FraudSight API.  <br /><br />  We require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a POST or a PUT.  <br /><br />  DNS whitelisting Whitelist the following URLs: https://try.access.worldpay-bsh.securedataplatform.co.uk/ https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned. You must apply the riskProfile from the FraudSight assessment response in the Card Payments API to link the Worldpay payment. This allows the data model to mature and identify fraudulent transactions. Alternatively make additional FraudSight update requests. See linking the FraudSight assessment for details.","category":["Risk Assessments"],"business":["Enterprise"],"catalog-list":true,"generated":false,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":1},"WP API standards (new)":{"uniqueErrors":2,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Ffraudsight%2Fopenapi"},"link":"/products/fraudsight/openapi","routeSlug":"/products/fraudsight/openapi","label":"FraudSight","version":"v1","isDefault":true,"versionFolderId":"bcec2bc6","items":[{"type":"link","label":"FraudSight","link":"/products/fraudsight/openapi","routeSlug":"/products/fraudsight/openapi","version":"v1","isDefault":true,"versionFolderId":"bcec2bc6"},{"label":"Fraud assessment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fraudsight/openapi/other/assessment","routeSlug":"/products/fraudsight/openapi/other/assessment","metadata":{"seo":{"title":"Fraud assessment","description":"Request a risk assessment"}},"httpPath":"/fraudsight/assessment","version":"v1","isDefault":true,"versionFolderId":"bcec2bc6"},{"type":"group","label":"Update","link":"/products/fraudsight/openapi/update","routeSlug":"/products/fraudsight/openapi/update","items":[{"label":"Provide details of the payment outcome","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fraudsight/openapi/update/updatepayment","routeSlug":"/products/fraudsight/openapi/update/updatepayment","metadata":{"seo":{"title":"Provide details of the payment outcome","description":"Provide payment outcome information."}},"httpPath":"/fraudsight/update/payment","version":"v1","isDefault":true,"versionFolderId":"bcec2bc6"},{"label":"Provide details of a payment that resulted in fraud","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fraudsight/openapi/update/updatefraud","routeSlug":"/products/fraudsight/openapi/update/updatefraud","metadata":{"seo":{"title":"Provide details of a payment that resulted in fraud","description":"Provide payment fraud information."}},"httpPath":"/fraudsight/update/fraud","version":"v1","isDefault":true,"versionFolderId":"bcec2bc6"},{"label":"Provide details of a payment that resulted in a chargeback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fraudsight/openapi/update/updatechargeback","routeSlug":"/products/fraudsight/openapi/update/updatechargeback","metadata":{"seo":{"title":"Provide details of a payment that resulted in a chargeback","description":"Provide payment chargeback information."}},"httpPath":"/fraudsight/update/chargeback","version":"v1","isDefault":true,"versionFolderId":"bcec2bc6"}],"version":"v1","isDefault":true,"versionFolderId":"bcec2bc6"}],"sidebar":[{"type":"link","label":"FraudSight","link":"/products/fraudsight/openapi","routeSlug":"/products/fraudsight/openapi","version":"v1","isDefault":true,"versionFolderId":"bcec2bc6"}]},{"type":"group","fsPath":"products/fx/@v1","metadata":{"custom_product":"FX","type":"openapi","title":"FX","version":"1","description":"Manage Foreign Exchange. Authentication header Authorization: {your_credentials} Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.  <br /> <br />  You must use the Authorization header for any request you send to our FX APIs.  <br /><br />  Accept header Accept: application/vnd.worldpay.foreignexchange-v1+json We use the Accept header to identify which version of our API you are using.  You must use the Accept header for any request you send to our FX APIs. <br /><br />  DNS whitelisting Whitelist the following URLs: https://try.access.worldpay-bsh.securedataplatform.co.uk/ - Account Payouts customers only https://access.worldpay-bsh.securedataplatform.co.uk/ - MCP and Account Payouts customers Please ensure you use DNS whitelisting, not explicit IP whitelisting. When  you make a request within Access Worldpay, you should always cache the  response returned.","catalog-list":true,"business":["Enterprise","Marketplaces"],"category":["FX"],"generated":true,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":1},"WP API standards (new)":{"uniqueErrors":2,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Ffx%2Fopenapi"},"link":"/products/fx/openapi","routeSlug":"/products/fx/openapi","label":"FX","version":"v1","isDefault":true,"versionFolderId":"0592dff7","items":[{"type":"link","label":"FX","link":"/products/fx/openapi","routeSlug":"/products/fx/openapi","version":"v1","isDefault":true,"versionFolderId":"0592dff7"},{"label":"Get FX rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fx/openapi/other/getfxrates","routeSlug":"/products/fx/openapi/other/getfxrates","metadata":{"seo":{"title":"Get FX rates","description":"Retrieve an FX rate for a particular payment method."}},"httpPath":"/foreignExchange/rates","version":"v1","isDefault":true,"versionFolderId":"0592dff7"},{"label":"Create FX quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fx/openapi/other/postfxquote","routeSlug":"/products/fx/openapi/other/postfxquote","metadata":{"seo":{"title":"Create FX quote","description":"Lock the FX rate for a specific currency pairing. For Account Payouts customers only."}},"httpPath":"/foreignExchange/quote","version":"v1","isDefault":true,"versionFolderId":"0592dff7"},{"label":"Retrieve an FX quote","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fx/openapi/other/getfxquote","routeSlug":"/products/fx/openapi/other/getfxquote","metadata":{"seo":{"title":"Retrieve an FX quote","description":"Retrieving an existing FX quote.For Account Payouts customers only."}},"httpPath":"/foreignExchange/quote","version":"v1","isDefault":true,"versionFolderId":"0592dff7"},{"label":"Create an external contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fx/openapi/other/postcontract","routeSlug":"/products/fx/openapi/other/postcontract","metadata":{"seo":{"title":"Create an external contract","description":"Create an external contract to lock a forward FX rate. For Account Payouts customers only."}},"httpPath":"/foreignExchange/contract","version":"v1","isDefault":true,"versionFolderId":"0592dff7"},{"label":"Activate or cancel contract","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fx/openapi/other/putcontract","routeSlug":"/products/fx/openapi/other/putcontract","metadata":{"seo":{"title":"Activate or cancel contract","description":"Enable a contract to use locked in FX rates in an Account Payout. For Account Payouts customers only."}},"httpPath":"/foreignExchange/contract/{contractId}","version":"v1","isDefault":true,"versionFolderId":"0592dff7"},{"label":"Add a markup to your FX rate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fx/openapi/other/addmarkup","routeSlug":"/products/fx/openapi/other/addmarkup","metadata":{"seo":{"title":"Add a markup to your FX rate","description":"Adding a markup to an existing FX rate. For MCP customers only."}},"httpPath":"/foreignExchange/markup/{entity}","version":"v1","isDefault":true,"versionFolderId":"0592dff7"},{"label":"Retrieve markup","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fx/openapi/other/getmarkup","routeSlug":"/products/fx/openapi/other/getmarkup","metadata":{"seo":{"title":"Retrieve markup","description":"Retrieving an existing markup for a specific FX rate.For MCP customers only."}},"httpPath":"/foreignExchange/markup/{entity}","version":"v1","isDefault":true,"versionFolderId":"0592dff7"}],"sidebar":[{"type":"link","label":"FX","link":"/products/fx/openapi","routeSlug":"/products/fx/openapi","version":"v1","isDefault":true,"versionFolderId":"0592dff7"}]},{"type":"group","fsPath":"products/hosted-payment-pages/@v1","metadata":{"custom_product":"Hosted Payment Pages","type":"openapi","title":"Hosted Payment Pages (HPP) API","version":"1","description":"Our low-code integration to take payments securely. Authentication header Authorization: {your_credentials} Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.  <br /> <br /> You must use the Authorization header for any request you send to our Hosted Payment Pages APIs. Accept header Accept: application/vnd.worldpay.payment_pages-v1.hal+json We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Hosted Payment Pages APIs.  <br /><br /> DNS whitelisting Whitelist the following URLs: https://try.access.worldpay-bsh.securedataplatform.co.uk/ https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting.","business":["SMB (Worldpay eCommerce)","Enterprise"],"catalog-list":true,"category":["3DS","Card Payments","Risk Assessments","Tokens","Wallets","Query Payments"],"generated":false,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":0},"WP API standards (new)":{"uniqueErrors":1,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fhosted-payment-pages%2Fopenapi"},"link":"/products/hosted-payment-pages/openapi","routeSlug":"/products/hosted-payment-pages/openapi","label":"Hosted Payment Pages (HPP) API","version":"v1","isDefault":true,"versionFolderId":"089b7d23","items":[{"type":"link","label":"Hosted Payment Pages (HPP) API","link":"/products/hosted-payment-pages/openapi","routeSlug":"/products/hosted-payment-pages/openapi","version":"v1","isDefault":true,"versionFolderId":"089b7d23"},{"label":"Create a new transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/hosted-payment-pages/openapi/other/create","routeSlug":"/products/hosted-payment-pages/openapi/other/create","metadata":{"seo":{"title":"Create a new transaction","description":"Create a new transaction"}},"httpPath":"/payment_pages","version":"v1","isDefault":true,"versionFolderId":"089b7d23"}],"sidebar":[{"type":"link","label":"Hosted Payment Pages (HPP) API","link":"/products/hosted-payment-pages/openapi","routeSlug":"/products/hosted-payment-pages/openapi","version":"v1","isDefault":true,"versionFolderId":"089b7d23"}]},{"type":"group","fsPath":"products/money-transfers/@v1","metadata":{"custom_product":"Money Transfers","type":"openapi","title":"Money Transfers","version":"1","description":"Money Transfer OCTs (Original Credit Transaction) allow funds to be pushed to an eligible card in 30 minutes or less. Withdrawing money from a digital wallet is an example of a Money Transfer OCT. Authentication Set your headers: Authorization: {your_credentials}\n  Content-Type: application/vnd.worldpay.money-transfers-v1+json\n  Accept: application/vnd.worldpay.money-transfers-v1+json Replace {your_credentials} with your base64-encoded Basic Auth username and password. <br> DNS whitelisting Whitelist the following URLs: https://try.access.worldpay-bsh.securedataplatform.co.uk/ https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.","category":["Payouts"],"business":["Enterprise"],"catalog-list":true,"generated":false,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":3},"WP API standards (new)":{"uniqueErrors":4,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fmoney-transfers%2Fopenapi"},"link":"/products/money-transfers/openapi","routeSlug":"/products/money-transfers/openapi","label":"Money Transfers","version":"v1","isDefault":true,"versionFolderId":"3a5f09cf","items":[{"type":"link","label":"Money Transfers","link":"/products/money-transfers/openapi","routeSlug":"/products/money-transfers/openapi","version":"v1","isDefault":true,"versionFolderId":"3a5f09cf"},{"label":"Push funds to an eligible card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/money-transfers/openapi/other/pushtocard","routeSlug":"/products/money-transfers/openapi/other/pushtocard","metadata":{"seo":{"title":"Push funds to an eligible card","description":"Push funds to an eligible card."}},"httpPath":"/moneyTransfers/pushToCard","version":"v1","isDefault":true,"versionFolderId":"3a5f09cf"},{"label":"Query for a money transfer using transactionReference and entity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/money-transfers/openapi/other/query","routeSlug":"/products/money-transfers/openapi/other/query","metadata":{"seo":{"title":"Query for a money transfer using transactionReference and entity","description":"Query for a money transfer."}},"httpPath":"/moneyTransfers/query","version":"v1","isDefault":true,"versionFolderId":"3a5f09cf"}],"sidebar":[{"type":"link","label":"Money Transfers","link":"/products/money-transfers/openapi","routeSlug":"/products/money-transfers/openapi","version":"v1","isDefault":true,"versionFolderId":"3a5f09cf"}]},{"type":"group","fsPath":"products/parties/@20250101","metadata":{"custom_product":"Parties","type":"openapi","title":"Parties","version":"2025-01-01","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks. Authentication Set your headers Authorization: {your_credentials}\nWP-Api-Version: 2025-01-01 Replace {your_credentials} with your base64-encoded Basic Auth username and password. DNS whitelisting Whitelist the following URLs: https://try.access.worldpay-bsh.securedataplatform.co.uk/ https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting. API collection A full set of API examples based on different scenarios. <a href=\"/collections/parties/20250101/OpenApiDocExamples.postman_collection.json\" download=\"wp-parties-api-postman\">Download Postman collection </a> <a href=\"/collections/parties/20250101/Try environment.postman_environment.json\" download=\"wp-parties-api-postman-try-env\">Download environment config for try env </a>","catalog-list":true,"business":["Marketplaces"],"category":["Parties"],"generated":true,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":2},"WP API standards (new)":{"uniqueErrors":3,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fparties%2Fopenapi"},"link":"/products/parties/openapi","routeSlug":"/products/parties/openapi","label":"Parties","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f","items":[{"type":"link","label":"Parties","link":"/products/parties/openapi","routeSlug":"/products/parties/openapi","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"type":"group","label":"Parties","link":"/products/parties/openapi/parties","routeSlug":"/products/parties/openapi/parties","items":[{"label":"Create a party","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/parties/createaccount","routeSlug":"/products/parties/openapi/parties/createaccount","metadata":{"seo":{"title":"Create a party","description":"Create a party"}},"httpPath":"/parties","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"label":"Browse parties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/parties/browseparties","routeSlug":"/products/parties/openapi/parties/browseparties","metadata":{"seo":{"title":"Browse parties","description":"Browse parties and optionally filtered by criteria. Results are paginated."}},"httpPath":"/parties","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"label":"View a party","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/parties/partyquery","routeSlug":"/products/parties/openapi/parties/partyquery","metadata":{"seo":{"title":"View a party","description":"Retrieve information about a party."}},"httpPath":"/parties/{partyId}","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"label":"Update a party","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/parties/updateparty","routeSlug":"/products/parties/openapi/parties/updateparty","metadata":{"seo":{"title":"Update a party","description":"Update a party"}},"httpPath":"/parties/{partyId}","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"label":"Deactivate a party","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/parties/deactivateparty","routeSlug":"/products/parties/openapi/parties/deactivateparty","metadata":{"seo":{"title":"Deactivate a party","description":"Deactivate a party"}},"httpPath":"/parties/{partyId}/deactivation","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"label":"Reactivate a party","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/parties/reactivateparty","routeSlug":"/products/parties/openapi/parties/reactivateparty","metadata":{"seo":{"title":"Reactivate a party","description":"Reactivate a party"}},"httpPath":"/parties/{partyId}/activation","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"}],"version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"type":"group","label":"Payout instruments","link":"/products/parties/openapi/payout-instruments","routeSlug":"/products/parties/openapi/payout-instruments","items":[{"label":"Create a payout instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/payout-instruments/createpayoutinstruments","routeSlug":"/products/parties/openapi/payout-instruments/createpayoutinstruments","metadata":{"seo":{"title":"Create a payout instrument","description":"Create a payout instrument"}},"httpPath":"/parties/{partyId}/payoutInstruments","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"label":"View a payout instrument","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/payout-instruments/getpayoutinstrument","routeSlug":"/products/parties/openapi/payout-instruments/getpayoutinstrument","metadata":{"seo":{"title":"View a payout instrument","description":"View a payout instrument"}},"httpPath":"/parties/{partyId}/payoutInstruments/{payoutInstrumentId}","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"label":"Update a payout instrument","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/payout-instruments/updatepayoutinstruments","routeSlug":"/products/parties/openapi/payout-instruments/updatepayoutinstruments","metadata":{"seo":{"title":"Update a payout instrument","description":"Update a payout instrument"}},"httpPath":"/parties/{partyId}/payoutInstruments/{payoutInstrumentId}","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"}],"version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"type":"group","label":"Balance accounts","link":"/products/parties/openapi/balance-accounts","routeSlug":"/products/parties/openapi/balance-accounts","items":[{"label":"Create a balance account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/balance-accounts/createbalanceaccount","routeSlug":"/products/parties/openapi/balance-accounts/createbalanceaccount","metadata":{"seo":{"title":"Create a balance account","description":"Create a balance account"}},"httpPath":"/parties/{partyId}/balanceAccounts","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"label":"View a balance account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/balance-accounts/getbalanceaccount","routeSlug":"/products/parties/openapi/balance-accounts/getbalanceaccount","metadata":{"seo":{"title":"View a balance account","description":"View a balance account"}},"httpPath":"/parties/{partyId}/balanceAccounts/{balanceAccountId}","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"label":"Update a balance account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/balance-accounts/updatebalanceaccount","routeSlug":"/products/parties/openapi/balance-accounts/updatebalanceaccount","metadata":{"seo":{"title":"Update a balance account","description":"Update a balance account"}},"httpPath":"/parties/{partyId}/balanceAccounts/{balanceAccountId}","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"}],"version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"type":"group","label":"Beneficial owners","link":"/products/parties/openapi/beneficial-owners","routeSlug":"/products/parties/openapi/beneficial-owners","items":[{"label":"Create a beneficial owner","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/beneficial-owners/createbeneficialowner","routeSlug":"/products/parties/openapi/beneficial-owners/createbeneficialowner","metadata":{"seo":{"title":"Create a beneficial owner","description":"Create a beneficial owner"}},"httpPath":"/parties/{partyId}/beneficialOwners","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"label":"View a beneficial owner","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/beneficial-owners/getbeneficialowner","routeSlug":"/products/parties/openapi/beneficial-owners/getbeneficialowner","metadata":{"seo":{"title":"View a beneficial owner","description":"View a beneficial owner"}},"httpPath":"/parties/{partyId}/beneficialOwners/{beneficialOwnerId}","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"label":"Update a beneficial owner","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/beneficial-owners/updatebeneficialowner","routeSlug":"/products/parties/openapi/beneficial-owners/updatebeneficialowner","metadata":{"seo":{"title":"Update a beneficial owner","description":"Update a beneficial owner"}},"httpPath":"/parties/{partyId}/beneficialOwners/{beneficialOwnerId}","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"label":"Delete a beneficial owner","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/beneficial-owners/deletebeneficialowner","routeSlug":"/products/parties/openapi/beneficial-owners/deletebeneficialowner","metadata":{"seo":{"title":"Delete a beneficial owner","description":"Delete a beneficial owner"}},"httpPath":"/parties/{partyId}/beneficialOwners/{beneficialOwnerId}","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"}],"version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"type":"group","label":"Identity verification","link":"/products/parties/openapi/identity-verification","routeSlug":"/products/parties/openapi/identity-verification","items":[{"label":"Perform identity verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/identity-verification/performidentityverification","routeSlug":"/products/parties/openapi/identity-verification/performidentityverification","metadata":{"seo":{"title":"Perform identity verification","description":"Perform identity verification"}},"httpPath":"/parties/{partyId}/identityVerification","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"},{"label":"View identity verification status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/parties/openapi/identity-verification/getidentityverificationstatus","routeSlug":"/products/parties/openapi/identity-verification/getidentityverificationstatus","metadata":{"seo":{"title":"View identity verification status","description":"View identity verification status"}},"httpPath":"/parties/{partyId}/identityVerification","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"}],"version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"}],"sidebar":[{"type":"link","label":"Parties","link":"/products/parties/openapi","routeSlug":"/products/parties/openapi","version":"20250101","isDefault":true,"versionFolderId":"78a47a1f"}]},{"type":"group","fsPath":"products/payment-queries/@v1","metadata":{"custom_product":"Payment Queries","type":"openapi","title":"Payment Queries","version":"1","description":"Query your payments data based on a variety of parameters. Authentication Set your headers: Authorization: {your_credentials}\n  Accept: application/vnd.worldpay.payment-queries-v1.hal+json Replace {your_credentials} with your base64-encoded Basic Auth username and password. <br><br>  DNS whitelisting Whitelist the following URLs: https://try.access.worldpay-bsh.securedataplatform.co.uk/ https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting.","category":["Query Payments"],"business":["Enterprise"],"catalog-list":true,"generated":false,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":2},"WP API standards (new)":{"uniqueErrors":3,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fpayment-queries%2Fopenapi"},"link":"/products/payment-queries/openapi","routeSlug":"/products/payment-queries/openapi","label":"Payment Queries","version":"v1","isDefault":true,"versionFolderId":"f48383ec","items":[{"type":"link","label":"Payment Queries","link":"/products/payment-queries/openapi","routeSlug":"/products/payment-queries/openapi","version":"v1","isDefault":true,"versionFolderId":"f48383ec"},{"label":"Query payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-queries/openapi/other/querybydaterange","routeSlug":"/products/payment-queries/openapi/other/querybydaterange","metadata":{"seo":{"title":"Query payments","description":"Query payments within a specified date time range."}},"httpPath":"/paymentQueries/payments","version":"v1","isDefault":true,"versionFolderId":"f48383ec"},{"label":"Retrieve a payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-queries/openapi/other/retrievebypaymentid","routeSlug":"/products/payment-queries/openapi/other/retrievebypaymentid","metadata":{"seo":{"title":"Retrieve a payment","description":"Retrieve a single payment by payment ID."}},"httpPath":"/paymentQueries/payments/{paymentId}","version":"v1","isDefault":true,"versionFolderId":"f48383ec"},{"label":"Query historical payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-queries/openapi/other/queryarchivedpayments","routeSlug":"/products/payment-queries/openapi/other/queryarchivedpayments","metadata":{"seo":{"title":"Query historical payments","description":"Query payments processed before 25 June 2024."}},"httpPath":"/paymentQueries/archivedPayments","version":"v1","isDefault":true,"versionFolderId":"f48383ec"}],"sidebar":[{"type":"link","label":"Payment Queries","link":"/products/payment-queries/openapi","routeSlug":"/products/payment-queries/openapi","version":"v1","isDefault":true,"versionFolderId":"f48383ec"}]},{"type":"group","fsPath":"products/payments/@20240601","metadata":{"custom_product":"Payments","type":"openapi","title":"Payments","version":"2024-06-01","description":"Use a single API that orchestrates the payment flow to include FraudSight, 3DS and token creation. Authentication Set your headers Authorization: {your_credentials}    \nContent-Type: application/json    \nWP-Api-Version: 2024-06-01 Replace {your_credentials} with your base64-encoded Basic Auth username and password. DNS whitelisting Whitelist the following URLs: https://try.access.worldpay-bsh.securedataplatform.co.uk/ https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned. API collection A full set of API examples based on different scenarios. Download Postman collection","tags":["Orchestration"],"category":["3DS","SCA Exemptions","Card Payments","Risk Assessments","Tokens","Wallets"],"catalog-list":true,"business":["Enterprise","SMB (Worldpay eCommerce)"],"generated":true,"scorecardStatus":"MINIMUM","scorecardLevel":"WP API standards (new)","scorecardLevelIdx":2,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":0},"WP API standards (new)":{"uniqueErrors":0,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fpayments%2Fopenapi"},"link":"/products/payments/openapi","routeSlug":"/products/payments/openapi","label":"Payments","version":"20240601","isDefault":true,"versionFolderId":"15ab58d6","items":[{"type":"link","label":"Payments","link":"/products/payments/openapi","routeSlug":"/products/payments/openapi","version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"},{"type":"group","label":"Payment","link":"/products/payments/openapi/payment","routeSlug":"/products/payments/openapi/payment","items":[{"label":"Payment request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments/openapi/payment/payment","routeSlug":"/products/payments/openapi/payment/payment","metadata":{"seo":{"title":"Payment request","description":"Initiate payment"}},"httpPath":"/api/payments","version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"}],"version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"},{"type":"group","label":"3DS actions","link":"/products/payments/openapi/3ds-actions","routeSlug":"/products/payments/openapi/3ds-actions","items":[{"label":"Supply 3DS device data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments/openapi/3ds-actions/supply3dsdevicedata","routeSlug":"/products/payments/openapi/3ds-actions/supply3dsdevicedata","metadata":{"seo":{"title":"Supply 3DS device data","description":"Gather additional device data"}},"httpPath":"/api/payments/{linkData}/3dsDeviceData","version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"},{"label":"Continue with the payment after a 3DS challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments/openapi/3ds-actions/complete3dschallenge","routeSlug":"/products/payments/openapi/3ds-actions/complete3dschallenge","metadata":{"seo":{"title":"Continue with the payment after a 3DS challenge","description":"Verify authentication challenge"}},"httpPath":"/api/payments/{linkData}/3dsChallenges","version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"}],"version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"},{"type":"group","label":"Manage payments","link":"/products/payments/openapi/manage-payments","routeSlug":"/products/payments/openapi/manage-payments","items":[{"label":"Payment query request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments/openapi/manage-payments/queryevents","routeSlug":"/products/payments/openapi/manage-payments/queryevents","metadata":{"seo":{"title":"Payment query request","description":"Send a payment query request to find out the current status of a payment after it has been authorized."}},"httpPath":"/api/payments/{linkData}","version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"},{"label":"Submit a payment settle request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments/openapi/manage-payments/settle","routeSlug":"/products/payments/openapi/manage-payments/settle","metadata":{"seo":{"title":"Submit a payment settle request","description":"Send a settle request to receive all the funds of a payment."}},"httpPath":"/api/payments/{linkData}/settlements","version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"},{"label":"Submit a payment partial settle request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments/openapi/manage-payments/partialsettle","routeSlug":"/products/payments/openapi/manage-payments/partialsettle","metadata":{"seo":{"title":"Submit a payment partial settle request","description":"Send a partial settle request to receive a portion of the funds of a payment."}},"httpPath":"/api/payments/{linkData}/partialSettlements","version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"},{"label":"Submit a payment refund request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments/openapi/manage-payments/refund","routeSlug":"/products/payments/openapi/manage-payments/refund","metadata":{"seo":{"title":"Submit a payment refund request","description":"Send a refund request to return the full settled amount of a payment to your customer."}},"httpPath":"/api/payments/{linkData}/refunds","version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"},{"label":"Submit a payment partial refund request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments/openapi/manage-payments/partialrefund","routeSlug":"/products/payments/openapi/manage-payments/partialrefund","metadata":{"seo":{"title":"Submit a payment partial refund request","description":"Send a partial refund request to return a portion of the settled amount of a payment to your customer."}},"httpPath":"/api/payments/{linkData}/partialRefunds","version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"},{"label":"Submit a payment cancel request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments/openapi/manage-payments/cancel","routeSlug":"/products/payments/openapi/manage-payments/cancel","metadata":{"seo":{"title":"Submit a payment cancel request","description":"Send a cancel request if you don't want to proceed with a payment."}},"httpPath":"/api/payments/{linkData}/cancellations","version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"},{"label":"Submit a payment partial cancel request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments/openapi/manage-payments/partialcancel","routeSlug":"/products/payments/openapi/manage-payments/partialcancel","metadata":{"seo":{"title":"Submit a payment partial cancel request","description":"Send a partial cancel request if you don't want to proceed with a payment."}},"httpPath":"/api/payments/{linkData}/partialCancellations","version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"},{"label":"Submit a payment incremental authorization request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments/openapi/manage-payments/increaseauthorizedamount","routeSlug":"/products/payments/openapi/manage-payments/increaseauthorizedamount","metadata":{"seo":{"title":"Submit a payment incremental authorization request","description":"Send an incremental authorization request to increase an initial estimated authorization amount (submitted with estimated set to true)."}},"httpPath":"/api/payments/{linkData}/incrementalAuthorizations","version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"},{"label":"Submit a payment reverse request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments/openapi/manage-payments/reversal","routeSlug":"/products/payments/openapi/manage-payments/reversal","metadata":{"seo":{"title":"Submit a payment reverse request","description":"Send a reversal request, which is processed as a cancel or refund request depending on the time passed after you have submitted your sale request. For US entities the payment is refunded one day after a successful sale request. Any other payment moves to refunded after 15 minutes."}},"httpPath":"/api/payments/{linkData}/reversals","version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"}],"version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"}],"sidebar":[{"type":"link","label":"Payments","link":"/products/payments/openapi","routeSlug":"/products/payments/openapi","version":"20240601","isDefault":true,"versionFolderId":"15ab58d6"}]},{"type":"group","fsPath":"products/sca-exemptions/@v1","metadata":{"custom_product":"SCA Exemptions","type":"openapi","title":"SCA Exemptions","version":"1","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions. Exemptions are supported for Visa, Mastercard and Maestro.<br><br> Authentication header Authorization: {your_credentials} Replace {your_credentials} with your base64-encoded Basic Auth username and password given to your by your Worldpay Implementation Manager. <br /> <br />  You must use the Authorization header for any request you send to our Exemptions API. <br><br> Accept/Content-Type header Content-Type: application/vnd.worldpay.exemptions-v1.hal+json\nAccept: application/vnd.worldpay.exemptions-v1.hal+json <br> We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Exemptions API. <br><br> We require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a POST or a PUT . <br /><br />  DNS whitelisting <br><br> Whitelist the following URLs:<br><br> * https://try.access.worldpay-bsh.securedataplatform.co.uk/ <br> * https://access.worldpay-bsh.securedataplatform.co.uk/ <br><br>  Please ensure you use DNS whitelisting, not explicit IP whitelisting.  You must apply the riskProfile from the exemption assessment response in the Card Payments API to link the Worldpay payment and apply the exemption that was granted.  See applying the exemption for details.","category":["3DS","SCA Exemptions"],"business":["Enterprise"],"catalog-list":true,"generated":false,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":0},"WP API standards (new)":{"uniqueErrors":1,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fsca-exemptions%2Fopenapi"},"link":"/products/sca-exemptions/openapi","routeSlug":"/products/sca-exemptions/openapi","label":"SCA Exemptions","version":"v1","isDefault":true,"versionFolderId":"edc06d3d","items":[{"type":"link","label":"SCA Exemptions","link":"/products/sca-exemptions/openapi","routeSlug":"/products/sca-exemptions/openapi","version":"v1","isDefault":true,"versionFolderId":"edc06d3d"},{"label":"Exemption assessment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/sca-exemptions/openapi/other/assessment","routeSlug":"/products/sca-exemptions/openapi/other/assessment","metadata":{"seo":{"title":"Exemption assessment","description":"Assess for exemption."}},"httpPath":"/exemptions/assessment","version":"v1","isDefault":true,"versionFolderId":"edc06d3d"}],"sidebar":[{"type":"link","label":"SCA Exemptions","link":"/products/sca-exemptions/openapi","routeSlug":"/products/sca-exemptions/openapi","version":"v1","isDefault":true,"versionFolderId":"edc06d3d"}]},{"type":"group","fsPath":"products/sessions/@20250929","metadata":{"custom_product":"Sessions","type":"openapi","title":"Sessions API","version":"2025-09-29","description":"Delegate a payment using a provided payment method and allowance.","category":["Tokens"],"business":["Enterprise"],"catalog-list":true,"generated":false,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":1},"WP API standards (new)":{"uniqueErrors":1,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fsessions%2Fopenapi"},"link":"/products/sessions/openapi","routeSlug":"/products/sessions/openapi","label":"Sessions API","version":"20250929","isDefault":true,"versionFolderId":"2badc2c0","items":[{"type":"link","label":"Sessions API","link":"/products/sessions/openapi","routeSlug":"/products/sessions/openapi","version":"20250929","isDefault":true,"versionFolderId":"2badc2c0"},{"type":"group","label":"Delegate payment","link":"/products/sessions/openapi/delegate-payment","routeSlug":"/products/sessions/openapi/delegate-payment","items":[{"label":"Create a delegated payment token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/sessions/openapi/delegate-payment/delegatepayment","routeSlug":"/products/sessions/openapi/delegate-payment/delegatepayment","metadata":{"seo":{"title":"Create a delegated payment token","description":"Tokenizes a credential for controlled usage by the merchant's PSP per the Allowance constraints.Exactly one credential type is currently supported: card."}},"httpPath":"/sessions/agentic_commerce/delegate_payment","version":"20250929","isDefault":true,"versionFolderId":"2badc2c0"}],"version":"20250929","isDefault":true,"versionFolderId":"2badc2c0"}],"sidebar":[{"type":"link","label":"Sessions API","link":"/products/sessions/openapi","routeSlug":"/products/sessions/openapi","version":"20250929","isDefault":true,"versionFolderId":"2badc2c0"}]},{"type":"group","fsPath":"products/split-payments/@20250625","metadata":{"custom_product":"Split Payments","type":"openapi","title":"Split Payments","version":"2025-06-25","description":"Divide funds from a single payment amongst yourself and your parties/sellers. Authentication  Set your headers Authorization: {your_credentials}\n    WP-Api-Version: 2025-06-25 Replace {your_credentials} with your base64-encoded Basic Auth username and password given to your by your Worldpay Implementation Manager.  <br><br>  DNS whitelisting Whitelist the following URLs:  * https://try.access.worldpay-bsh.securedataplatform.co.uk/  * https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting.  When you make a request within Access Worldpay, you should always cache the response returned.","business":["Enterprise","Marketplaces"],"catalog-list":true,"category":["Card Payments"],"generated":true,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":2},"WP API standards (new)":{"uniqueErrors":2,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fsplit-payments%2Fopenapi"},"link":"/products/split-payments/openapi","routeSlug":"/products/split-payments/openapi","label":"Split Payments","version":"20250625","isDefault":true,"versionFolderId":"592be2e7","items":[{"type":"link","label":"Split Payments","link":"/products/split-payments/openapi","routeSlug":"/products/split-payments/openapi","version":"20250625","isDefault":true,"versionFolderId":"592be2e7"},{"label":"Create split payments request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/split-payments/openapi/other/splitpayments","routeSlug":"/products/split-payments/openapi/other/splitpayments","metadata":{"seo":{"title":"Create split payments request","description":"Create a request allowing you to split your payment."}},"httpPath":"/splitPayments","version":"20250625","isDefault":true,"versionFolderId":"592be2e7"},{"label":"Fully settle/refund a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/split-payments/openapi/other/fullcapturefulfillments","routeSlug":"/products/split-payments/openapi/other/fullcapturefulfillments","metadata":{"seo":{"title":"Fully settle/refund a payment","description":"Confirm a settlement/refund of all line items within a split payment."}},"httpPath":"/splitPayments/{splitPaymentId}/fulfillments","version":"20250625","isDefault":true,"versionFolderId":"592be2e7"},{"label":"Partially settle/refund a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/split-payments/openapi/other/singitemcapturefulfillments","routeSlug":"/products/split-payments/openapi/other/singitemcapturefulfillments","metadata":{"seo":{"title":"Partially settle/refund a payment","description":"Confirm a settlement/refund of individual line items within a payment."}},"httpPath":"/splitPayments/{splitPaymentId}/items/{itemId}/fulfillments","version":"20250625","isDefault":true,"versionFolderId":"592be2e7"}],"sidebar":[{"type":"link","label":"Split Payments","link":"/products/split-payments/openapi","routeSlug":"/products/split-payments/openapi","version":"20250625","isDefault":true,"versionFolderId":"592be2e7"}]},{"type":"group","fsPath":"products/statements/@20250101","metadata":{"custom_product":"Statements","type":"openapi","title":"Statements","version":"2025-01-01","description":"Retrieve your account statement and see individual entries for all credits and debits. Specify a date range and other optional filter values. Authentication header Authorization: {your_credentials}  Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.  <br /> <br />  You must use the Authorization header for any request you send to our Statements API.  <br /><br />  WP-Api-Version header  WP-Api-Version: 2025-01-01 We use the WP-Api-Version header to identify which version of our API you are using. You must use the WP-Api-Version header for any request you send to our Account APIs.  <br /><br />  DNS whitelisting Whitelist the following URLs:  * https://try.access.worldpay-bsh.securedataplatform.co.uk/  * https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.","business":["Enterprise","Marketplaces"],"catalog-list":true,"category":["Accounts"],"generated":true,"scorecardStatus":"MINIMUM","scorecardLevel":"WP API standards (new)","scorecardLevelIdx":2,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":1},"WP API standards (new)":{"uniqueErrors":0,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fstatements%2Fopenapi"},"link":"/products/statements/openapi","routeSlug":"/products/statements/openapi","label":"Statements","version":"20250101","isDefault":true,"versionFolderId":"72c31188","items":[{"type":"link","label":"Statements","link":"/products/statements/openapi","routeSlug":"/products/statements/openapi","version":"20250101","isDefault":true,"versionFolderId":"72c31188"},{"label":"Query account statement items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/statements/openapi/other/getstatements","routeSlug":"/products/statements/openapi/other/getstatements","metadata":{"seo":{"title":"Query account statement items","description":"Query account statement items"}},"httpPath":"/accounts/statements","version":"20250101","isDefault":true,"versionFolderId":"72c31188"}],"sidebar":[{"type":"link","label":"Statements","link":"/products/statements/openapi","routeSlug":"/products/statements/openapi","version":"20250101","isDefault":true,"versionFolderId":"72c31188"}]},{"type":"group","fsPath":"products/tokens/@v3","metadata":{"custom_product":"Tokens","type":"openapi","title":"Tokens","version":"3","description":"Minimize the exposure of sensitive card details and increase the security of your customer's card details. Authentication header Authorization: {your_credentials} Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.  <br /> <br />  You must use the Authorization header for any request you send to our Tokens API.  <br /><br />  Accept & Content-Type headers Accept: application/vnd.worldpay.tokens-v3.hal+json\n  Content-Type: application/vnd.worldpay.tokens-v3.hal+json We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Tokens API.  <br><br>  For detokenization requests, adapt the Accept header to also pass masked = false, as follows: Accept:  'application/vnd.worldpay.tokens-v3.hal+json; masked=false' <br>  Detokenizing exposes your business to high levels of PCI auditing, required to remain PCI compliant. <br><br>  We require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a POST or a PUT.  <br /><br />  DNS whitelisting Whitelist the following URLs: https://try.access.worldpay-bsh.securedataplatform.co.uk/ https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.","category":["Tokens"],"business":["Enterprise"],"catalog-list":true,"generated":false,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":4},"WP API standards (new)":{"uniqueErrors":5,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Ftokens%2Fopenapi"},"link":"/products/tokens/openapi","routeSlug":"/products/tokens/openapi","label":"Tokens","version":"v3","isDefault":true,"versionFolderId":"13618f6a","items":[{"type":"link","label":"Tokens","link":"/products/tokens/openapi","routeSlug":"/products/tokens/openapi","version":"v3","isDefault":true,"versionFolderId":"13618f6a"},{"type":"group","label":"Token","link":"/products/tokens/openapi/token","routeSlug":"/products/tokens/openapi/token","items":[{"label":"Create a new token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tokens/openapi/token/createsecuritytoken","routeSlug":"/products/tokens/openapi/token/createsecuritytoken","metadata":{"seo":{"title":"Create a new token","description":"Create a new token for the payment instrument."}},"httpPath":"/tokens","version":"v3","isDefault":true,"versionFolderId":"13618f6a"},{"label":"Retrieve token details using query parameters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tokens/openapi/token/querysecuritytoken","routeSlug":"/products/tokens/openapi/token/querysecuritytoken","metadata":{"seo":{"title":"Retrieve token details using query parameters","description":"At least one of tokenId or namespace must be provided. If the token was created with a namespace, both tokenId and namespace must be supplied. To look up all tokens created under a namespace, query by namespace alone."}},"httpPath":"/tokens","version":"v3","isDefault":true,"versionFolderId":"13618f6a"},{"label":"Retrieve token details using the token href link data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tokens/openapi/token/getsecuritytokenbyhref","routeSlug":"/products/tokens/openapi/token/getsecuritytokenbyhref","metadata":{"seo":{"title":"Retrieve token details using the token href link data","description":"Retrieve token details using the token href representing the token."}},"httpPath":"/tokens/{linkData}","version":"v3","isDefault":true,"versionFolderId":"13618f6a"},{"label":"Update this token","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tokens/openapi/token/updatesecuritytoken","routeSlug":"/products/tokens/openapi/token/updatesecuritytoken","metadata":{"seo":{"title":"Update this token","description":"Updating different fields represented by the token."}},"httpPath":"/tokens/{linkData}","version":"v3","isDefault":true,"versionFolderId":"13618f6a"},{"label":"Delete this token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tokens/openapi/token/deletesecuritytoken","routeSlug":"/products/tokens/openapi/token/deletesecuritytoken","metadata":{"seo":{"title":"Delete this token","description":"Deleting a token based on an encrypted token href."}},"httpPath":"/tokens/{linkData}","version":"v3","isDefault":true,"versionFolderId":"13618f6a"}],"version":"v3","isDefault":true,"versionFolderId":"13618f6a"},{"type":"group","label":"Network token","link":"/products/tokens/openapi/network-token","routeSlug":"/products/tokens/openapi/network-token","items":[{"label":"Request provisioning for a network token and receive a reference for use later","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tokens/openapi/network-token/provisionnetworktoken","routeSlug":"/products/tokens/openapi/network-token/provisionnetworktoken","metadata":{"seo":{"title":"Request provisioning for a network token and receive a reference for use later","description":"Request to provision a network token."}},"httpPath":"/tokens/network","version":"v3","isDefault":true,"versionFolderId":"13618f6a"},{"label":"Get the actual network token using the network token reference","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tokens/openapi/network-token/getnetworktoken","routeSlug":"/products/tokens/openapi/network-token/getnetworktoken","metadata":{"seo":{"title":"Get the actual network token using the network token reference","description":"Retrieve the detail for this network token."}},"httpPath":"/tokens/network/{tokenReference}","version":"v3","isDefault":true,"versionFolderId":"13618f6a"},{"label":"Delete a network token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tokens/openapi/network-token/deletesecuritynetworktoken","routeSlug":"/products/tokens/openapi/network-token/deletesecuritynetworktoken","metadata":{"seo":{"title":"Delete a network token","description":"Deleting a network token based on a token number."}},"httpPath":"/tokens/network/{tokenNumber}","version":"v3","isDefault":true,"versionFolderId":"13618f6a"},{"label":"Provision a cryptogram for short time use based on a network token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tokens/openapi/network-token/getnetworktokencryptogram","routeSlug":"/products/tokens/openapi/network-token/getnetworktokencryptogram","metadata":{"seo":{"title":"Provision a cryptogram for short time use based on a network token","description":"A network token cryptogram is a one-time value generated for a single payment authorization attempt using the network token. It helps to prove that the network token is valid and being used by an authorized party for a specific transaction."}},"httpPath":"/tokens/network/cryptograms","version":"v3","isDefault":true,"versionFolderId":"13618f6a"}],"version":"v3","isDefault":true,"versionFolderId":"13618f6a"}],"sidebar":[{"type":"link","label":"Tokens","link":"/products/tokens/openapi","routeSlug":"/products/tokens/openapi","version":"v3","isDefault":true,"versionFolderId":"13618f6a"}]},{"type":"group","fsPath":"products/transfers/@20250101","metadata":{"custom_product":"Account Transfers","type":"openapi","title":"Account Transfers","version":"2025-01-01","description":"Transfer funds from source account to target account. Authentication header Authorization: {your_credentials}  Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.  <br /> <br />  You must use the Authorization header for any request you send to our Account Transfers API.  <br /><br />  WP-Api-Version header  WP-Api-Version: 2025-01-01 We use the WP-Api-Version header to identify which version of our API you are using. You must use the WP-Api-Version header for any request you send.  <br /><br />  DNS whitelisting Whitelist the following URLs:  * https://try.access.worldpay-bsh.securedataplatform.co.uk/  * https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.","business":["Enterprise","Marketplaces"],"catalog-list":true,"category":["Accounts"],"generated":true,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":2},"WP API standards (new)":{"uniqueErrors":1,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Ftransfers%2Fopenapi"},"link":"/products/transfers/openapi","routeSlug":"/products/transfers/openapi","label":"Account Transfers","version":"20250101","isDefault":true,"versionFolderId":"733aea73","items":[{"type":"link","label":"Account Transfers","link":"/products/transfers/openapi","routeSlug":"/products/transfers/openapi","version":"20250101","isDefault":true,"versionFolderId":"733aea73"},{"label":"Transfer funds between your accounts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/transfers/openapi/other/receivetransferrequest","routeSlug":"/products/transfers/openapi/other/receivetransferrequest","metadata":{"seo":{"title":"Transfer funds between your accounts","description":"Transfer funds between your accounts."}},"httpPath":"/accounts/transfer","version":"20250101","isDefault":true,"versionFolderId":"733aea73"}],"sidebar":[{"type":"link","label":"Account Transfers","link":"/products/transfers/openapi","routeSlug":"/products/transfers/openapi","version":"20250101","isDefault":true,"versionFolderId":"733aea73"}]},{"type":"group","fsPath":"products/verified-tokens/@v3","metadata":{"custom_product":"Verified Tokens","type":"openapi","title":"Verified Tokens","version":"v3","description":"Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token. Authentication header Authorization: {your_credentials} Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.  <br /> <br />  You must use the Authorization header for any request you send to our Verified Tokens API.  <br /><br />  Accept header Accept: application/vnd.worldpay.verified-tokens-v3.hal+json We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Verified Tokens API.  <br /><br />  DNS whitelisting Whitelist the following URLs: https://try.access.worldpay-bsh.securedataplatform.co.uk/ https://access.worldpay-bsh.securedataplatform.co.uk/ Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.","category":["Tokens"],"business":["Enterprise"],"catalog-list":true,"generated-openapi":false,"scorecardStatus":"MINIMUM","scorecardLevel":"Baseline","scorecardLevelIdx":1,"scorecardLevels":{"Baseline":{"uniqueErrors":0,"uniqueWarnings":1},"WP API standards (new)":{"uniqueErrors":2,"uniqueWarnings":0}},"scoreCardSlug":"/apis/scorecard/apis/products%2Fverified-tokens%2Fopenapi"},"link":"/products/verified-tokens/openapi","routeSlug":"/products/verified-tokens/openapi","label":"Verified Tokens","version":"v3","isDefault":true,"versionFolderId":"bc25eb53","items":[{"type":"link","label":"Verified Tokens","link":"/products/verified-tokens/openapi","routeSlug":"/products/verified-tokens/openapi","version":"v3","isDefault":true,"versionFolderId":"bc25eb53"},{"label":"Verified Tokens cardOnFile resource","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/verified-tokens/openapi/other/cardonfile","routeSlug":"/products/verified-tokens/openapi/other/cardonfile","metadata":{"seo":{"title":"Verified Tokens cardOnFile resource","description":"Create a verified cardOnFile token by sending a request to cardOnFile resource. A cardOnFile verified token allows you to take payments that are made by the customer using a stored verified token, such as in one-click or in-app purchases."}},"httpPath":"/verifiedTokens/cardOnFile","version":"v3","isDefault":true,"versionFolderId":"bc25eb53"},{"label":"Verified Tokens oneTime resource","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/verified-tokens/openapi/other/onetime","routeSlug":"/products/verified-tokens/openapi/other/onetime","metadata":{"seo":{"title":"Verified Tokens oneTime resource","description":"Create a verified oneTime token by sending a request to oneTime resource. A oneTime verified token allows you to take payments that are made by the customer using a stored verified token, such as in one-click or in-app purchases."}},"httpPath":"/verifiedTokens/oneTime","version":"v3","isDefault":true,"versionFolderId":"bc25eb53"}],"sidebar":[{"type":"link","label":"Verified Tokens","link":"/products/verified-tokens/openapi","routeSlug":"/products/verified-tokens/openapi","version":"v3","isDefault":true,"versionFolderId":"bc25eb53"}]}]