Skip to main content
POST
/
payments
/
virtual-account
/
offramp-order
Create a virtual account offramp order
curl --request POST \
  --url https://api-sb.meld.io/payments/virtual-account/offramp-order \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destinationCurrencyCode": "USD",
  "paymentMethod": {
    "type": "LOCAL_BANK_TRANSFER"
  },
  "serviceProvider": "ACROSS",
  "sourceAmount": 20000,
  "sourceCurrencyCode": "USDC",
  "sourceWalletAddress": "0xe51f36521fF5D857824e615a64D34808534a55e6"
}
'
{
  "orderId": "<string>",
  "paymentMethodType": "<string>",
  "walletAddress": "<string>"
}

Authorizations

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

Headers

X-Idempotency-Key
string<uuid>

Body

application/json

Request to create a virtual account offramp order

customerId
string
required

Customer id

Minimum string length: 1
destinationCurrencyCode
string
required

Destination fiat currency code

Minimum string length: 1
Example:

"USD"

paymentMethod
object
required

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

serviceProvider
enum<string>
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,
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,
WYRE,
XANPOOL,
YELLOWCARD,
YODLEE
sourceAmount
number
required

Source amount in cryptocurrency

Required range: x >= 0
Example:

20000

sourceCurrencyCode
string
required

Source cryptocurrency code

Minimum string length: 1
Example:

"USDC"

sourceWalletAddress
string
required

Source wallet address to send cryptocurrency from

Minimum string length: 1
Example:

"0xe51f36521fF5D857824e615a64D34808534a55e6"

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

Business offramp order created successfully

Response containing virtual account offramp order details

orderId
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