{"templateId":"markdown","versions":[{"version":"20240601","label":"2024-06-01 (Latest)","link":"/products/payments/enable-features/ramp-services","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","admonition","json-schema"]},"custom_product":"Payments","type":"markdown"},"seo":{"title":"Crypto Ramp Providers | 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"]},": 01 September 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":"crypto-ramp-providers","__idx":0},"children":["Crypto ramp providers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Crypto ramp providers facilitate the conversion from fiat currencies (e.g. USD) to non-fiat currencies (e.g. cryptocurrency), or vice versa. Card networks require ramp provider merchants to include special transaction indicators in their authorization requests to identify the type of ramp transaction. Merchants who have contracted third-party conversion affiliates for conversion services must also submit relevant ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#conversion-affiliate-data"},"children":["affiliate data"]}," in their authorization request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-to-enable","__idx":1},"children":["How to enable"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchant.rampProvider"]}," object to identify your ramp provider and, where applicable, include conversion affiliate details."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"special-transaction-indicator","__idx":2},"children":["Special transaction indicator"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["From ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["October 2024"]},", Visa introduced a mandate to include special transaction indicators to increase transparency and clarify dispute rules for digital currency and NFT transactions. Send the relevant ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purpose"]}," value inside ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instruction.fundsTransfer"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"instruction\": {\n    \"fundsTransfer\": {\n      \"type\": \"purchase\",\n      \"purpose\": \"stablecoin\"\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Supported ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purpose"]}," values:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["blockchainNativeToken"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["crypto"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["stablecoin"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nft"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cbdc"]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You must always send the above ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purpose"]}," values with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fundsTransfer.type"]}," of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purchase"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["walletLoad"]},". Sending any other type may lead to increased decline rates from card networks."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"ramp-provider-reference","__idx":3},"children":["Ramp provider reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Card networks mandate that crypto ramp merchants submit their unique identifier in every authorization:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"merchant\": {\n    \"rampProvider\": {\n      \"reference\": \"12345677898\"\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can't send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rampProvider"]}," data together with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentFacilitator"]}," data."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"conversion-affiliate-data","__idx":4},"children":["Conversion affiliate data"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the ramp provider uses conversion affiliates, submit the affiliate details inside ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchant.rampProvider"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"merchant\": {\n    \"rampProvider\": {\n      \"reference\": \"12345677898\",\n      \"conversionAffiliate\": {\n        \"reference\": \"1234567890\",\n        \"name\": \"Name\",\n        \"url\": \"http://some-url-here.com\",\n        \"taxReference\": \"987-654-4321\",\n        \"address\": {\n          \"countryCode\": \"US\"\n        }\n      }\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"schema","__idx":5},"children":["Schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../openapi.yaml#/components/schemas/PaymentsRampProvider"},"options":{"schemasExpansionLevel":1,"hideSchemaTitles":true,"hidePropertiesPrefix":true,"hideInfoMetadata":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/PaymentsRampProvider"},"PaymentsConversionAffiliateAddress":{"type":"object","description":"Address of the conversion affiliate.","properties":{"countryCode":{"type":"string","description":"Country code of the conversion affiliate in [ISO 3166-1 Alpha-2 format].","example":"US","maxLength":2,"minLength":2}},"required":["countryCode"]},"PaymentsConversionAffiliate":{"type":"object","description":"An object containing conversion affiliate information.","properties":{"reference":{"type":"string","description":"Unique identifier for the conversion affiliate.","example":"1234567890","maxLength":15,"minLength":1,"pattern":"^[a-zA-Z0-9]*$"},"name":{"type":"string","description":"Legal or trading name of the conversion affiliate.","example":"Name","maxLength":22,"minLength":1,"pattern":"^(?!\\s*$)[A-Za-z0-9 @!£*#$)(+\\-_=.,/;:'\"]*$"},"address":{"$ref":"#/components/schemas/PaymentsConversionAffiliateAddress"},"url":{"type":"string","description":"Public website URL of the conversion affiliate.","example":"http://some-url-here.com","maxLength":255,"minLength":1},"taxReference":{"type":"string","description":"Tax identifier of the conversion affiliate.","example":"987-654-4321","maxLength":20,"minLength":1,"pattern":"^[A-Za-z0-9@!£*#$)(+\\-_=.,/;:'\"]*$"}},"required":["address","name","reference"]},"PaymentsRampProvider":{"type":"object","description":"An object containing ramp provider information.","properties":{"reference":{"type":"string","description":"Unique identifier assigned to the ramp provider.","example":"12345677898","maxLength":11,"minLength":1,"pattern":"^[a-zA-Z0-9]*$"},"conversionAffiliate":{"$ref":"#/components/schemas/PaymentsConversionAffiliate"}},"required":["conversionAffiliate","reference"]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"outcome-details","__idx":6},"children":["Outcome details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The payment response does not include any ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rampProvider"]}," specific information."]}]},"headings":[{"value":"Crypto ramp providers","id":"crypto-ramp-providers","depth":1},{"value":"How to enable","id":"how-to-enable","depth":2},{"value":"Special transaction indicator","id":"special-transaction-indicator","depth":3},{"value":"Ramp provider reference","id":"ramp-provider-reference","depth":3},{"value":"Conversion affiliate data","id":"conversion-affiliate-data","depth":3},{"value":"Schema","id":"schema","depth":2},{"value":"Outcome details","id":"outcome-details","depth":2}],"frontmatter":{"seo":{"title":"Crypto Ramp Providers | Payments API"}},"lastModified":"2026-08-26T16:07:49.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/payments/enable-features/ramp-services","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}