Skip to main content

Orders

Test environment: https://api-onramp.stg.eopay.io/order/create-api-on-ramp-order

Production environment: https://api-onramp.eopay.io/order/create-api-on-ramp-order

Request Parameters

ParameterTypeDescription
merchantIdstringMerchant ID assigned during onboarding
ssoCustomerIdstringUnique customer ID from the merchant system. Example: sso_customer_id = "abc0000001"
customerWalletAddressstringCustomer wallet address (for fiat-only payments you can provide mock data)
typenumber0: on-ramp, 1: off-ramp, 2: NFT on-ramp
currencystringFiat currency ISO-4217 three-letter code
cryptostringSupported crypto asset
orderAmountnumberOrder amount
ssoOrderIdstringMerchant-defined unique ID
includeFeenumber0: order amount excludes fees, 1: order amount includes fees, 2: merchant covers the fee for customer

Successful Response Example

{
"message": "",
"order": {
"cryptoAmount": 145.718246,
"cryptoId": 4,
"currencyId": 108,
"fiatAmount": 151,
"liquidityQuote": 0.9928,
"merchantId": 5571,
"orderUuid": "ea62f550-1b02-4676-ad4f-7bc03990c473",
"processingFee": 4.23,
"ssoOrderId": "nzknxwzt",
"status": 4,
"type": 0
}
}

Failure Response Example

{ message: 'HashCode not correct' }