Meld.io · Schema
HeadlessOrderOnrampRequest
Request to create a headless onramp order
Data IntegrationFintechAPI PlatformStablecoinsDigital AssetsEnterprise
Properties
| Name | Type | Description |
|---|---|---|
| clientIpAddress | string | The end-user's IP address. Required by some service providers. |
| countryCode | string | Country code (ISO 3166-1 alpha-2) |
| customerId | string | Meld customer id (one of customerId / externalCustomerId is required) |
| customerPhoneNumber | string | Customer phone number — required for MOBILE_MONEY |
| destinationCurrencyCode | string | Destination cryptocurrency code |
| destinationWalletAddress | string | Wallet address to receive the cryptocurrency |
| externalCustomerId | string | Caller's external customer id (one of customerId / externalCustomerId is required) |
| externalOrderId | string | Caller's reference for the order; unique per account when provided |
| paymentMethodType | string | Payment method type |
| providerData | object | Provider-specific extension; subtype keyed by serviceProvider |
| redirectUrl | string | Redirect URL — required for CARD/REDIRECT flows |
| serviceProvider | string | Service provider to use for the order |
| sourceAmount | number | Source amount |
| sourceCurrencyCode | string | Source currency code (ISO 4217) |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/meld/json-schema/meld-headless-order-onramp-request-schema.json",
"title": "HeadlessOrderOnrampRequest",
"description": "Request to create a headless onramp order",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/meld-headless-api-openapi.yml#/components/schemas/HeadlessOrderOnrampRequest",
"type": "object",
"properties": {
"clientIpAddress": {
"type": "string",
"description": "The end-user's IP address. Required by some service providers."
},
"countryCode": {
"type": "string",
"description": "Country code (ISO 3166-1 alpha-2)",
"minLength": 1
},
"customerId": {
"type": "string",
"description": "Meld customer id (one of customerId / externalCustomerId is required)"
},
"customerPhoneNumber": {
"type": "string",
"description": "Customer phone number — required for MOBILE_MONEY"
},
"destinationCurrencyCode": {
"type": "string",
"description": "Destination cryptocurrency code",
"minLength": 1
},
"destinationWalletAddress": {
"type": "string",
"description": "Wallet address to receive the cryptocurrency",
"minLength": 1
},
"externalCustomerId": {
"type": "string",
"description": "Caller's external customer id (one of customerId / externalCustomerId is required)"
},
"externalOrderId": {
"type": "string",
"description": "Caller's reference for the order; unique per account when provided"
},
"paymentMethodType": {
"type": "string",
"description": "Payment method type",
"enum": [
"CREDIT_DEBIT_CARD",
"APPLE_PAY",
"ACH",
"SEPA",
"PIX",
"MOBILE_MONEY"
]
},
"providerData": {
"description": "Provider-specific extension; subtype keyed by serviceProvider",
"oneOf": [
{
"title": "YellowcardData",
"allOf": [
{
"$ref": "#/$defs/YellowcardData"
}
]
}
]
},
"redirectUrl": {
"type": "string",
"description": "Redirect URL — required for CARD/REDIRECT flows"
},
"serviceProvider": {
"type": "string",
"description": "Service provider to use for the order",
"enum": [
"NOAH",
"DUENETWORK",
"BRALE",
"YELLOWCARD",
"MERCURYO"
]
},
"sourceAmount": {
"type": "number",
"description": "Source amount",
"minimum": 0.0
},
"sourceCurrencyCode": {
"type": "string",
"description": "Source currency code (ISO 4217)",
"minLength": 1
}
},
"required": [
"countryCode",
"destinationCurrencyCode",
"destinationWalletAddress",
"paymentMethodType",
"serviceProvider",
"sourceAmount",
"sourceCurrencyCode"
],
"$defs": {
"ProviderData": {
"description": "Provider-specific extension keyed by serviceProvider",
"properties": {
"serviceProvider": {
"type": "string"
}
},
"required": [
"serviceProvider"
]
},
"YellowcardData": {
"allOf": [
{
"$ref": "#/$defs/ProviderData"
},
{
"type": "object",
"properties": {
"subaccountCustomerId": {
"type": "string",
"description": "Optional Meld customer id used to track the business sub-account this transaction belongs to when multiple businesses operate under one Meld account."
},
"externalSubaccountCustomerId": {
"type": "string",
"description": "Optional external identifier for the sub-account customer this transaction belongs to. Used for tracking when multiple businesses operate under one Meld account. A sub-account customer must be created first before it can be referenced."
}
}
}
],
"description": "Yellowcard-specific provider data"
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/meld-headless-order-onramp-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.