Skip to main content
POST
Create a headless onramp order

Authorizations

Authorization
string
header
default:BASIC <Meld API Key>
required

Headers

Meld-Version
string

Dated API version to use for this request, e.g. 2026-02-03.

Example:

"2026-02-03"

X-Idempotency-Key
string<uuid>

Body

application/json

Request to create a headless onramp order

countryCode
string
required

Country code (ISO 3166-1 alpha-2)

Minimum string length: 1
Example:

"US"

destinationCurrencyCode
string
required

Destination cryptocurrency code

Minimum string length: 1
Example:

"USDC"

destinationWalletAddress
string
required

Wallet address to receive the cryptocurrency

Minimum string length: 1
paymentMethodType
enum<string>
required

Payment method type

Available options:
CREDIT_DEBIT_CARD,
APPLE_PAY,
ACH,
SEPA,
PIX,
MOBILE_MONEY
serviceProvider
enum<string>
required

Service provider to use for the order

Available options:
NOAH,
DUENETWORK,
BRALE,
YELLOWCARD,
MERCURYO
Example:

"NOAH"

sourceAmount
number
required

Source amount

Required range: x >= 0
Example:

200

sourceCurrencyCode
string
required

Source currency code (ISO 4217)

Minimum string length: 1
Example:

"USD"

clientIpAddress
string

The end-user's IP address. Required by some service providers.

customerId
string

Meld customer id (one of customerId / externalCustomerId is required)

customerPhoneNumber
string

Customer phone number — required for MOBILE_MONEY

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

providerData
YellowcardData · object

Provider-specific extension; subtype keyed by serviceProvider

redirectUrl
string

Redirect URL — required for CARD/REDIRECT flows

Response

Headless order created

Headless onramp order response envelope

customerId
string

Meld customer id

externalCustomerId
string

Caller's external customer id

externalOrderId
string

Caller's external order id

id
string

Unique order ID for tracking the onramp order

payload
object

Echo of the integrator's request payload for this order

paymentMethodResponseDetails
ApplePayOrder · object

Method-specific response payload

paymentMethodType
enum<string>

Payment method type for this order

Available options:
CREDIT_DEBIT_CARD,
APPLE_PAY,
ACH,
SEPA,
PIX,
MOBILE_MONEY
serviceProviderDetails
object

Raw provider receiving-bank details (untyped passthrough). Present for bank-transfer methods when the provider returns them; carries fields that have no typed home on paymentMethodResponseDetails (e.g. beneficiary/company name, bank name, address). Omitted when empty.