Initiate Sell

Initiate a Sell transaction for an existing customer.

Initiates a fiat payout transaction for a customer that already exists in your IvoryPay account.

Endpoint

POST /v1/sell/initiate

Authentication

Header
Value

x-api-key

Your API key

Request body

Field
Type
Required
Description

email

string

Yes

Existing customer's email

fiatAmount

number

Yes

Fiat amount to pay out

businessFeeInFiat

number

No

Your business fee in fiat

fiatCurrency

string

Yes

Fiat currency

accountNumber

string

Yes

Recipient bank account number

bankCode

string

Yes

Bank code

reference

string

Yes

Your unique reference (UUID)

redirectUrl

string

No

Redirect URL

note

string

No

Transaction note

Example request

Example response

Last updated