{"templateId":"markdown","versions":[{"version":"20240601","label":"2024-06-01 (Latest)","link":"/products/payments/enable-features/payment-facilitator","default":true,"active":true,"folderId":"15ab58d6"}],"sharedDataIds":{"sidebar":"sidebar-products/payments/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/payments/openapi"},"props":{"metadata":{"markdoc":{"tagList":["partial","badge","json-schema"]},"custom_product":"Payments","type":"markdown"},"seo":{"title":"Payment Facilitator | Payments API","description":"Worldpay for Developers - docs, code examples, resources and tools. Everything you need to build your omnichannel payment solution.","siteUrl":"https://docs.worldpay.com/access","image":"/access/assets/worldpay-logo-light.21b7daf79984773a9fcd7d4fbcb07ae5289dfffd6023c4c3dca720c7058e53dc.33f780a6.svg","keywords":"documentation, api, openapi, sdks, developer, payments, json, payouts, 3ds","jsonLd":{"@context":"https://schema.org","@type":"Organization","url":"https://docs.worldpay.com/access","name":"Worldpay"},"meta":[{"name":"google-site-verification","content":"zjziIKaP3ImsqsfhYnEBnq1R85UabiSwl7HTXuwtZuo"},{"name":"doc_product","content":"Access"},{"name":"doc_category","content":"Documentation"}],"llmstxt":{"hide":false,"sections":[{"title":"Payments API","description":"Payment orchestration API combining fraud assessment, 3ds authentication, SCA exemptions, Worldpay Token creation and a card or wallet based payment.","includeFiles":["products/payments/@20240601/**/*"],"excludeFiles":[]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"],"excludeFiles":[]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"],"excludeFiles":[]},{"title":"3DS Authentication API","description":"Request 3DS authentication to protect against fraud, be SCA compliant and to shift liability using this standalone API.","includeFiles":["products/3ds/@v3/**/*"],"excludeFiles":[]},{"title":"FraudSight API","description":"Request a risk assessment and receive a response with an outcome (e.g. lowRisk) using this standalone API.","includeFiles":["products/fraudsight/@v1/**/*"],"excludeFiles":[]},{"title":"Checkout SDK","description":"Integrate using our clientside SDKs for both web and native devices. Benefit from SAQ-A/PCI-SSF compliance.","includeFiles":["products/checkout/web/@v2/**/*","products/checkout/ios/@v4/**/*","products/checkout/android/@v4/**/*","products/checkout/react-native/@v3/**/*","products/checkout/flutter/@v1/**/*"],"excludeFiles":[]},{"title":"Tokens API","description":"Minimizes the exposure of sensitive card details and increases the security of your customer's card details.","includeFiles":["products/tokens/@v3/**/*"],"excludeFiles":[]},{"title":"Card Payments API","description":"Request a card payment using this standalone API, requires separate requests for 3DS, Fraud assessment etc.","includeFiles":["products/card-payments/@v7/**/*"],"excludeFiles":[]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"],"excludeFiles":[]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"],"excludeFiles":[]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"],"excludeFiles":[]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"],"excludeFiles":[]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"],"excludeFiles":[]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"],"excludeFiles":[]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"],"excludeFiles":[]},{"title":"Hosted Payment Pages (HPP) API","description":"Our low-code option to take payments securely at the lowest PCI compliance level - SAQ A.","includeFiles":["products/hosted-payment-pages/@v1/**/*"],"excludeFiles":[]},{"title":"Money Transfers API","description":"Money Transfer OCTs (Original Credit Transaction) allow funds to be pushed to an eligible card in 30 minutes or less.","includeFiles":["products/money-transfers/@v1/**/*"],"excludeFiles":[]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"],"excludeFiles":[]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"],"excludeFiles":[]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"],"excludeFiles":[]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"],"excludeFiles":[]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"],"excludeFiles":[]},{"title":"Verified Tokens API","description":"Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.","includeFiles":["products/verified-tokens/@v3/**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last updated"]},": 16 July 2026 | ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/payments/changelog/"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Change log"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"payment-facilitator","__idx":0},"children":["Payment Facilitator"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Badge","attributes":{"size":"small","to":"/","fontWeight":"bold","color":"var(--wp-colour-black)","mt":"0rem","mb":"0.5rem","px":"1rem","py":"0.5rem","borderRadius":"6rem","bg":"#E0D5FC"},"children":["Enterprise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payment Facilitators provide payment services on behalf of their customers, including processing payments with Worldpay. In this model, the customers of a Payment Facilitator are sub-merchants. When a cardholder makes a purchase, the sub-merchant routes the transaction data to the Payment Facilitator, and the Payment Facilitator sends compliant payment transactions to Worldpay on behalf of the sub-merchant. Worldpay settles funds to the Payment Facilitator, who in turn pays out to their sub-merchants."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All Payment Facilitators must supply additional transaction information which clearly identifies both the Payment Facilitator and the sub-merchant involved."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-to-enable","__idx":1},"children":["How to enable"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchant.paymentFacilitator"]}," object and providing all the required details related to the sub-merchant."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"paymentfacilitator-object-required","__idx":2},"children":["paymentFacilitator object (Required)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"\"merchant\": {\n  ....\n    \"paymentFacilitator\": {\n      \"schemeId\": \"12345\",                         \n      \"independentSalesOrganizationId\": \"12345\",        \n      \"subMerchant\": {                             \n        \"name\": \"Sub-Merchant Plc\",                    \n        \"reference\": \"12345\",                      \n        \"address\": {                               \n          \"postalCode\": \"SW1 1AA\",                 \n          \"street\": \"Regent Street\",               \n          \"city\": \"London\",                        \n          \"countryCode\": \"GB\",                     \n          \"state\": \"CA\"\n        },\n        \"taxReference\": \"12345\",\n        \"phoneNumber\": \"0123456789\",\n        \"email\": \"test@email.com\"\n      }\n    },\n  ....\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"schema","__idx":3},"children":["Schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../openapi.yaml#/components/schemas/PaymentsPaymentFacilitator"},"options":{"schemasExpansionLevel":1,"hideSchemaTitles":true,"hidePropertiesPrefix":true,"hideInfoMetadata":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/PaymentsPaymentFacilitator"},"PaymentsSubMerchantAddress":{"type":"object","properties":{"postalCode":{"type":"string","description":"Post code/Zip code of your subMerchant's company.","example":"SW1 1AA","maxLength":10,"minLength":1,"pattern":"^(?!\\s*$)[a-zA-Z0-9\\s]*$"},"street":{"type":"string","description":"Street name of your subMerchant's company.","example":"221B Baker Street","maxLength":50,"minLength":1,"pattern":"^(?!\\s*$)[A-Za-z0-9\\s]*$"},"city":{"type":"string","description":"City of your subMerchant's company.","example":"London","maxLength":13,"minLength":1,"pattern":"^(?!\\s*$)[A-Za-z\\s-]*$"},"state":{"type":"string","description":"State of your subMerchant's company.","example":"GB","maxLength":3,"minLength":1,"pattern":"^(?!\\s*$)[a-zA-Z0-9\\s]*$"},"countryCode":{"type":"string","description":"Country code of your subMerchant's company in [ISO 3166-1 Alpha-2 format](/products/reference/supported-countries-currencies#iso-country-codes).","example":"GB","maxLength":2,"minLength":2}},"required":["city","countryCode","postalCode","street"]},"PaymentsSubMerchant":{"type":"object","properties":{"name":{"type":"string","description":"The name of your subMerchant's company.<br><br>Also used for __3DS authentication__ to display the merchant name during the authentication process.","example":"Merchant Plc","maxLength":25,"minLength":1,"pattern":"^(?!\\s*$)[A-Za-z0-9 ]*$"},"reference":{"type":"string","description":"Unique merchant reference.","example":"123456789012345","maxLength":15,"minLength":1,"pattern":"[a-zA-Z0-9]*$"},"address":{"$ref":"#/components/schemas/PaymentsSubMerchantAddress","description":"Contains the subMerchant address information."},"phoneNumber":{"type":"string","description":"Phone number of your subMerchant's company.","example":"987-65-4321","maxLength":20,"minLength":4,"pattern":"^(?!\\s*$)[0-9\\s()+\\-/.x]*$"},"taxReference":{"type":"string","description":"Tax Reference of your subMerchant's company.","example":"987-65-4321","maxLength":20,"minLength":1,"pattern":"^(?!\\s*$)[a-zA-Z0-9\\s-]*$"},"email":{"type":"string","description":"Email address of your subMerchant's company.","example":"email@example.com","maxLength":40,"minLength":1,"pattern":"^.+@.+$"},"url":{"type":"string","example":"url.example.com","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9@!£*#$)(+\\-_=.,/;:]*$"}},"required":["address","name","reference"]},"PaymentsPaymentFacilitator":{"type":"object","properties":{"schemeId":{"type":"string","description":"Your payment facilitator ID received from Mastercard, Visa and Amex.","example":"12345678901","maxLength":11,"minLength":1,"pattern":"[0-9]*$"},"independentSalesOrganizationId":{"type":"string","description":"Independent Sales Organization (ISO) ID provided by Mastercard.","example":"12345678901","maxLength":11,"minLength":1,"pattern":"[0-9]*$"},"subMerchant":{"$ref":"#/components/schemas/PaymentsSubMerchant","description":"Your sub-merchant's details."}},"required":["schemeId","subMerchant"]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"outcome-details","__idx":4},"children":["Outcome details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The payment response does not include any ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentFacilitator"]}," specific information."]}]},"headings":[{"value":"Payment Facilitator","id":"payment-facilitator","depth":1},{"value":"How to enable","id":"how-to-enable","depth":2},{"value":"paymentFacilitator object (Required)","id":"paymentfacilitator-object-required","depth":3},{"value":"Schema","id":"schema","depth":3},{"value":"Outcome details","id":"outcome-details","depth":2}],"frontmatter":{"seo":{"title":"Payment Facilitator | Payments API"}},"lastModified":"2026-02-18T14:54:13.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/payments/enable-features/payment-facilitator","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}