{"templateId":"scorecardClassic","sharedDataIds":{"scorecard":"scorecard","catalog":"catalog-worldpay-catalog"},"props":{"catalogId":"worldpay-catalog","catalogConfig":{"title":"APIs","description":"The full set of Access APIs available.\n","slug":"/apis/","filters":[{"title":"Business Type","property":"business","options":["Enterprise","SMB (Worldpay eCommerce)","Marketplaces"]},{"title":"Category","property":"category","type":"checkboxes"}],"groupByFirstFilter":false},"scorecardConfig":{"levels":[{"name":"Baseline","rules":{"info-contact":"off","info-license":"off","info-license-strict":"off","tag-description":"warn","tags-alphabetical":"off","parameter-description":"off","no-path-trailing-slash":"error","no-identical-paths":"warn","no-ambiguous-paths":"warn","path-declaration-must-exist":"error","path-not-include-query":"error","path-parameters-defined":"error","operation-description":"off","operation-2xx-response":"error","operation-4xx-response":"warn","operation-operationId":"error","operation-summary":"error","operation-operationId-unique":"error","operation-operationId-url-safe":"error","operation-parameters-unique":"error","operation-tag-defined":"off","security-defined":"error","operation-singular-tag":"error","no-unresolved-refs":"error","no-enum-type-mismatch":"error","paths-kebab-case":"off","struct":"error","spec-strict-refs":"error","no-http-verbs-in-paths":"warn","no-invalid-parameter-examples":"error","no-invalid-schema-examples":"warn","path-http-verbs-order":"off","path-params-defined":"error","path-segment-plural":"off","required-string-property-missing-min-length":"off","response-contains-header":"off","scalar-property-missing-example":"off","no-required-schema-properties-undefined":"warn","no-invalid-media-type-examples":"warn","no-server-example.com":"error","no-server-trailing-slash":"error","no-empty-servers":"error","no-example-value-and-externalValue":"error","no-unused-components":"error","no-undefined-server-variable":"error","no-server-variables-empty-enum":"error","spec-components-invalid-map-name":"error","boolean-parameter-prefixes":"off","component-name-unique":"error","operation-4xx-problem-details-rfc7807":"off","request-mime-type":"off","response-contains-property":"off","response-mime-type":"off","array-parameter-serialization":"off","rule/operationId-casing":{"severity":"warn","subject":{"type":"Operation","property":"operationId"},"assertions":{"casing":"camelCase"}},"rule/parameter-casing":{"severity":"warn","subject":{"type":"Parameter"},"assertions":{"casing":"camelCase"}},"rule/schema-properties-casing":{"severity":"warn","subject":{"type":"Schema","property":"properties"},"assertions":{"casing":"camelCase"}}},"oas2Rules":{},"oas3_0Rules":{},"oas3_1Rules":{},"oas3_2Rules":{},"async2Rules":{},"async3Rules":{},"arazzo1Rules":{},"arazzo1_1Rules":{},"overlay1Rules":{},"openrpc1Rules":{},"graphqlRules":{},"preprocessors":{},"oas2Preprocessors":{},"oas3_0Preprocessors":{},"oas3_1Preprocessors":{},"oas3_2Preprocessors":{},"async2Preprocessors":{},"async3Preprocessors":{},"arazzo1Preprocessors":{},"arazzo1_1Preprocessors":{},"overlay1Preprocessors":{},"openrpc1Preprocessors":{},"decorators":{},"oas2Decorators":{},"oas3_0Decorators":{},"oas3_1Decorators":{},"oas3_2Decorators":{},"async2Decorators":{},"async3Decorators":{},"arazzo1Decorators":{},"arazzo1_1Decorators":{},"overlay1Decorators":{},"openrpc1Decorators":{}},{"name":"WP API standards (new)","rules":{"info-contact":"off","info-license":"off","info-license-strict":"off","tag-description":"warn","tags-alphabetical":"off","parameter-description":"off","no-path-trailing-slash":"error","no-identical-paths":"error","no-ambiguous-paths":"error","path-declaration-must-exist":"error","path-not-include-query":"error","path-parameters-defined":"error","operation-description":"off","operation-2xx-response":"error","operation-4xx-response":"error","operation-operationId":"error","operation-summary":"error","operation-operationId-unique":"error","operation-operationId-url-safe":"error","operation-parameters-unique":"error","operation-tag-defined":"off","security-defined":"error","operation-singular-tag":"error","no-unresolved-refs":"error","no-enum-type-mismatch":"error","paths-kebab-case":"off","struct":"error","spec-strict-refs":"error","no-http-verbs-in-paths":"warn","no-invalid-parameter-examples":"error","no-invalid-schema-examples":"error","path-http-verbs-order":"off","path-params-defined":"error","path-segment-plural":"off","required-string-property-missing-min-length":"off","response-contains-header":"off","scalar-property-missing-example":"off","no-required-schema-properties-undefined":"error","no-invalid-media-type-examples":"error","no-server-example.com":"error","no-server-trailing-slash":"error","no-empty-servers":"error","no-example-value-and-externalValue":"error","no-unused-components":"error","no-undefined-server-variable":"error","no-server-variables-empty-enum":"error","spec-components-invalid-map-name":"error","boolean-parameter-prefixes":"off","component-name-unique":"error","operation-4xx-problem-details-rfc7807":"off","request-mime-type":"off","response-contains-property":"off","response-mime-type":"off","array-parameter-serialization":"off","rule/media-type-map-application-json":{"severity":"error","subject":{"type":"MediaTypesMap"},"assertions":{"const":"application/json"},"message":"NEW API Standard - application/json must be used for content-type"}},"oas2Rules":{},"oas3_0Rules":{},"oas3_1Rules":{},"oas3_2Rules":{},"async2Rules":{},"async3Rules":{},"arazzo1Rules":{},"arazzo1_1Rules":{},"overlay1Rules":{},"openrpc1Rules":{},"graphqlRules":{},"preprocessors":{},"oas2Preprocessors":{},"oas3_0Preprocessors":{},"oas3_1Preprocessors":{},"oas3_2Preprocessors":{},"async2Preprocessors":{},"async3Preprocessors":{},"arazzo1Preprocessors":{},"arazzo1_1Preprocessors":{},"overlay1Preprocessors":{},"openrpc1Preprocessors":{},"decorators":{},"oas2Decorators":{},"oas3_0Decorators":{},"oas3_1Decorators":{},"oas3_2Decorators":{},"async2Decorators":{},"async3Decorators":{},"arazzo1Decorators":{},"arazzo1_1Decorators":{},"overlay1Decorators":{},"openrpc1Decorators":{}}],"ignoreNonCompliant":false},"scorecardInfo":{"levelNames":["Baseline","WP API standards (new)"],"rules":["tag-description","no-path-trailing-slash","no-identical-paths","no-ambiguous-paths","path-declaration-must-exist","path-not-include-query","path-parameters-defined","operation-2xx-response","operation-4xx-response","operation-operationId","operation-summary","operation-operationId-unique","operation-operationId-url-safe","operation-parameters-unique","security-defined","operation-singular-tag","no-unresolved-refs","no-enum-type-mismatch","struct","spec-strict-refs","no-http-verbs-in-paths","no-invalid-parameter-examples","no-invalid-schema-examples","path-params-defined","no-required-schema-properties-undefined","no-invalid-media-type-examples","no-server-example.com","no-server-trailing-slash","no-empty-servers","no-example-value-and-externalValue","no-unused-components","no-undefined-server-variable","no-server-variables-empty-enum","spec-components-invalid-map-name","component-name-unique","rule/operationId-casing","rule/parameter-casing","rule/schema-properties-casing","rule/media-type-map-application-json"],"rulesPerLevel":{"Baseline":["tag-description","no-path-trailing-slash","no-identical-paths","no-ambiguous-paths","path-declaration-must-exist","path-not-include-query","path-parameters-defined","operation-2xx-response","operation-4xx-response","operation-operationId","operation-summary","operation-operationId-unique","operation-operationId-url-safe","operation-parameters-unique","security-defined","operation-singular-tag","no-unresolved-refs","no-enum-type-mismatch","struct","spec-strict-refs","no-http-verbs-in-paths","no-invalid-parameter-examples","no-invalid-schema-examples","path-params-defined","no-required-schema-properties-undefined","no-invalid-media-type-examples","no-server-example.com","no-server-trailing-slash","no-empty-servers","no-example-value-and-externalValue","no-unused-components","no-undefined-server-variable","no-server-variables-empty-enum","spec-components-invalid-map-name","component-name-unique","rule/operationId-casing","rule/parameter-casing","rule/schema-properties-casing"],"WP API standards (new)":["tag-description","no-path-trailing-slash","no-identical-paths","no-ambiguous-paths","path-declaration-must-exist","path-not-include-query","path-parameters-defined","operation-2xx-response","operation-4xx-response","operation-operationId","operation-summary","operation-operationId-unique","operation-operationId-url-safe","operation-parameters-unique","security-defined","operation-singular-tag","no-unresolved-refs","no-enum-type-mismatch","struct","spec-strict-refs","no-http-verbs-in-paths","no-invalid-parameter-examples","no-invalid-schema-examples","path-params-defined","no-required-schema-properties-undefined","no-invalid-media-type-examples","no-server-example.com","no-server-trailing-slash","no-empty-servers","no-example-value-and-externalValue","no-unused-components","no-undefined-server-variable","no-server-variables-empty-enum","spec-components-invalid-map-name","component-name-unique","rule/media-type-map-application-json"]}},"dynamicMarkdocComponents":[],"metadata":{},"seo":{"title":"Worldpay Developers","description":"Worldpay for Developers - docs, code examples, resources and tools. Everything you need to build your omnichannel payment solution.","siteUrl":"https://docs.worldpay-bsh.securedataplatform.co.uk","image":"/access/assets/worldpay-logo-light.21b7daf79984773a9fcd7d4fbcb07ae5289dfffd6023c4c3dca720c7058e53dc.33f780a6.svg","keywords":"documentation, api, openapi, sdks, developer, payments, json, payouts, 3ds","jsonLd":{"@context":"https://schema.org","@type":"Organization","url":"https://docs.worldpay-bsh.securedataplatform.co.uk/access","name":"Worldpay"},"meta":[{"name":"google-site-verification","content":"zjziIKaP3ImsqsfhYnEBnq1R85UabiSwl7HTXuwtZuo"},{"name":"doc_product","content":"Access"},{"name":"doc_category","content":"Documentation"}],"llmstxt":{"hide":false,"sections":[{"title":"Payments API","description":"Payment orchestration API combining fraud assessment, 3ds authentication, SCA exemptions, Worldpay Token creation and a card or wallet based payment.","includeFiles":["products/payments/@20240601/**/*"]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"]},{"title":"3DS Authentication API","description":"Request 3DS authentication to protect against fraud, be SCA compliant and to shift liability using this standalone API.","includeFiles":["products/3ds/@v3/**/*"]},{"title":"FraudSight API","description":"Request a risk assessment and receive a response with an outcome (e.g. lowRisk) using this standalone API.","includeFiles":["products/fraudsight/@v1/**/*"]},{"title":"Checkout SDK","description":"Integrate using our clientside SDKs for both web and native devices. Benefit from SAQ-A/PCI-SSF compliance.","includeFiles":["products/checkout/web/@v2/**/*","products/checkout/ios/@v4/**/*","products/checkout/android/@v4/**/*","products/checkout/react-native/@v3/**/*","products/checkout/flutter/@v1/**/*"]},{"title":"Tokens API","description":"Minimizes the exposure of sensitive card details and increases the security of your customer's card details.","includeFiles":["products/tokens/@v3/**/*"]},{"title":"Card Payments API","description":"Request a card payment using this standalone API, requires separate requests for 3DS, Fraud assessment etc.","includeFiles":["products/card-payments/@v7/**/*"]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"]},{"title":"Hosted Payment Pages (HPP) API","description":"Our low-code option to take payments securely at the lowest PCI compliance level - SAQ A.","includeFiles":["products/hosted-payment-pages/@v1/**/*"]},{"title":"Money Transfers API","description":"Money Transfer OCTs (Original Credit Transaction) allow funds to be pushed to an eligible card in 30 minutes or less.","includeFiles":["products/money-transfers/@v1/**/*"]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"]},{"title":"Verified Tokens API","description":"Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.","includeFiles":["products/verified-tokens/@v3/**/*"]}]}},"compilationErrors":[],"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"worldpay-portal.eu.redocly.app","port":4000,"ipAddress":"2.16.246.170"},"lang":"default_locale"},"pagePropGetterError":{"message":"","name":""}},"slug":"/apis/scorecard","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}