Initiate Sell (with Customer)

Create a new customer and initiate a Sell (fiat payout) transaction.

Creates a new customer and initiates a fiat payout to their bank account.

Endpoint

POST /v1/sell

Authentication

Header	Value
x-api-key	Your API key

Request body

Field	Type	Required	Description
firstName	string	Yes	Customer's first name (min 1 character)
lastName	string	Yes	Customer's last name (min 1 character)
email	string	Yes	Customer's email address
phoneNumber	string	No	Customer's phone number (E.164 format)
fiatAmount	number	Yes	Fiat amount to pay out
businessFeeInFiat	number	No	Your business fee in fiat
fiatCurrency	string	Yes	Fiat currency. See Supported Currencies
accountNumber	string	Yes	Recipient bank account number
bankCode	string	Yes	Bank code (use List Banks to get valid codes)
reference	string	Yes	Your unique reference (UUID)
redirectUrl	string	No	Redirect URL
note	string	No	Transaction note

Example request

cURL

curl -X POST https://ramp-api.ivorypay.io/api/v1/sell \
  -H "x-api-key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Tunde",
    "lastName": "Bakare",
    "email": "[e-mail]",
    "fiatAmount": 75000,
    "fiatCurrency": "NGN",
    "accountNumber": "0123456789",
    "bankCode": "058",
    "reference": "880e8400-e29b-41d4-a716-446655440003"
  }'

Node.js

Python

Go

Example response

{
  "statusCode": 200,
  "success": true,
  "message": "Sell initiated successfully",
  "data": {
    "firstName": "Tunde",
    "lastName": "Bakare",
    "email": "[e-mail]",
    "refCode": "sell456xyz",
    "reference": "880e8400-e29b-41d4-a716-446655440003",
    "transferDetails": {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "currency": "NGN",
      "businessFeeInFiat": 0,
      "platformFeeFiat": 375,
      "fiatAmount": 75000,
      "accountName": "Tunde Bakare",
      "accountNumber": "0123456789"
    }
  }
}

Related webhooks

• sell.success — Fiat payout delivered to bank

• sell.failed — Payout failed

• sell.cancelled — Payout cancelled