Initiate Off-Ramp

Initiate an off-ramp transaction for an existing customer.

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

Endpoint

POST /v1/offramp/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)

accountNumber

string

Yes

Recipient bank account number or mobile money number

bankCode

string

No

Bank code for NGN bank payouts (use List Banks to get valid codes). Not required for mobile money payouts

blockchain

string

Yes

Blockchain network

reference

string

Yes

Your unique reference (must be a UUID)

token

string

Yes

Cryptocurrency the user will send

fiatCurrency

string

Yes

Fiat currency for payout

fiatAmount

number

No*

Fiat amount to be paid out

cryptoAmount

number

No*

Crypto amount to be sent

businessFeeInCrypto

number

No

Your business fee in crypto

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

ONOFFRAMP0033

Invalid bank code

Last updated