Skip to main content
POST
Create a headless offramp order

Authorizations

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

Headers

X-Idempotency-Key
string<uuid>

Body

application/json

Request to create a headless offramp order

customerId
string
default:""
required

Customer id

Minimum string length: 1
Example:

""

destinationCurrencyCode
string
default:""
required

Destination fiat currency code

Minimum string length: 1
Example:

""

fiatPayoutMethod
object
required

Payout method details for how and where the fiat currency will be received

Example:

""

serviceProvider
enum<string>
default:""
required

Service provider to use for this offramp order

Available options:
ACROSS,
AEROPAY,
AKOYA,
ALCHEMYPAY,
APPLEPAY,
AUTHORIZENET,
BANXA,
BILIRA,
BINANCECONNECT,
BINANCEPAY,
BLOCKCHAINDOTCOM,
BOOMFI,
BRAINTREE,
BRALE,
BTCDIRECT,
CASHAPP,
CHECKOUT,
CIRCLE,
COINBASEPAY,
COINFLOW,
DUENETWORK,
ELDORADO,
FINICITY,
FLASHNET,
FONBNK,
GUARDARIAN,
HARBOUR,
KOYWE,
KRYPTONIM,
MERCURYO,
MESH,
MESO,
MOONPAY,
MOOV,
MX,
NMI,
NOAH,
ONMETA,
ONRAMPMONEY,
PAYBIS,
PAYPAL,
PLAID,
RAMP,
REVOLUT,
ROBINHOOD,
ROUTERPROTOCOL,
SALTEDGE,
SALTEDGEPARTNERS,
SARDINE,
SHIFT4,
SHOPIFY,
SIMPLEX,
SKRILLCRYPTO,
SQUARE,
STRIPE,
SUMSUB,
SWAPPED,
TANGOCARD,
TELLER,
TOPPER,
TRANSAK,
TREMENDOUS,
TRANSFI,
UNLIMIT,
UPHOLD,
WYRE,
XANPOOL,
YELLOWCARD,
YODLEE
Example:

""

sourceAmount
number
default:""
required

Source amount in cryptocurrency

Required range: x >= 0
Example:

""

sourceCurrencyCode
string
default:""
required

Source cryptocurrency code

Minimum string length: 1
Example:

""

sourceWalletAddress
string
default:""
required

Source wallet address to send cryptocurrency from

Minimum string length: 1
Example:

""

externalSubaccountCustomerId
string

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.

subaccountCustomerId
string

Optional Meld customer id used to track the business sub-account this transaction belongs to when multiple businesses operate under one Meld account.

Response

Headless offramp order created

Response containing headless offramp order details

id
string

Unique order ID for tracking the offramp order

paymentMethodType
string

Payment method for receiving the fiat funds

walletAddress
string

Wallet address used for the transfer