Initiate On-Ramp

Initiate an on-ramp transaction for an existing customer.

Initiates a fiat-to-crypto on-ramp transaction for a customer that already exists in your IvoryPay account.

Endpoint

POST /v1/onramp/initiate

Authentication

Header
Value

x-api-key

Your API key

Request body

Field
Type
Required
Description

email

string

Yes

Existing customer's email address

phoneNumber

string

No

Customer's phone number (E.164 format)

walletAddress

string

Yes

Destination crypto wallet address

blockchain

string

Yes

Blockchain network. See Supported Blockchains

reference

string

Yes

Your unique reference (must be a UUID)

token

string

Yes

Cryptocurrency to receive. See Supported Networks & Tokens

fiatCurrency

string

Yes

Fiat currency to pay in. See Supported Currencies

fiatAmount

number

No*

Amount in fiat

cryptoAmount

number

No*

Amount in crypto

businessFeeInFiat

number

No

Your business fee in fiat

redirectUrl

string

No

Redirect URL after checkout

note

string

No

Transaction note

circle-exclamation

Example request

Example response

Error cases

Error code
Description

ONOFFRAMP0053

Customer not found — use the with-customer endpoint instead

Last updated