Initiate Buy

Initiate a Buy transaction for an existing customer.

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

Endpoint

POST /v1/buy/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 collect

businessFeeInFiat

number

Your business fee in fiat

fiatCurrency

string

Yes

Fiat currency

reference

string

Yes

Your unique reference (UUID)

redirectUrl

string

Redirect URL after checkout

note

string

Transaction note

Example request

curl -X POST https://ramp-api.ivorypay.io/api/v1/buy/initiate \
  -H "x-api-key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "kemi@example.com",
    "fiatAmount": 25000,
    "fiatCurrency": "NGN",
    "reference": "770e8400-e29b-41d4-a716-446655440002"
  }'

const response = await fetch("https://ramp-api.ivorypay.io/api/v1/buy/initiate", {
  method: "POST",
  headers: {
    "x-api-key": "your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    email: "kemi@example.com",
    fiatAmount: 25000,
    fiatCurrency: "NGN",
    reference: "770e8400-e29b-41d4-a716-446655440002",
  }),
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
    "https://ramp-api.ivorypay.io/api/v1/buy/initiate",
    headers={
        "x-api-key": "your_api_key",
        "Content-Type": "application/json",
    },
    json={
        "email": "kemi@example.com",
        "fiatAmount": 25000,
        "fiatCurrency": "NGN",
        "reference": "770e8400-e29b-41d4-a716-446655440002",
    },
)

print(response.json())

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io"
	"net/http"
)

func main() {
	body, _ := json.Marshal(map[string]interface{}{
		"email":        "kemi@example.com",
		"fiatAmount":   25000,
		"fiatCurrency": "NGN",
		"reference":    "770e8400-e29b-41d4-a716-446655440002",
	})

	req, _ := http.NewRequest("POST", "https://ramp-api.ivorypay.io/api/v1/buy/initiate", bytes.NewBuffer(body))
	req.Header.Set("x-api-key", "your_api_key")
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	respBody, _ := io.ReadAll(resp.Body)
	fmt.Println(string(respBody))
}

Example response

{
  "statusCode": 200,
  "success": true,
  "message": "Buy initiated successfully",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "accountName": "IvoryPay - Kemi Adeyemi",
    "accountNumber": "9876543210",
    "expectedAmount": 25000,
    "platformFee": 125,
    "businessFee": 0,
    "expiresAt": "2026-03-26T13:00:00.000Z",
    "reference": "770e8400-e29b-41d4-a716-446655440002",
    "bank": "Providus Bank",
    "currency": "NGN",
    "createdAt": "2026-03-26T12:00:00.000Z",
    "checkoutUrl": "https://checkout.ivorypay.io/pay/buy456"
  }
}

PreviousInitiate Buy (with Customer)NextGet Buy Status

Last updated 1 month ago

hashtagEndpoint

hashtagAuthentication

hashtagRequest body

hashtagExample request

hashtagExample response

Endpoint

Authentication

Request body

Example request

Example response