Introduction

The complete API reference for IvoryPay's On/Off-Ramp platform. Accept crypto payments, process fiat payouts, and bridge traditional finance with blockchain — all through a single API.

What is IvoryPay?

IvoryPay is a crypto-fiat infrastructure platform that enables businesses across Africa to seamlessly convert between cryptocurrency and local fiat currencies. Our On/Off-Ramp API gives you programmatic access to:

• On-Ramp — Let your users acquire crypto with local fiat currencies (NGN, KES, ZAR, and more)

• Off-Ramp — Let your users convert crypto and receive fiat payouts to their bank accounts

• Virtual Accounts — Generate dedicated bank accounts for receiving fiat deposits

• Deposits & Settlements — Track incoming fiat deposits and their crypto settlement lifecycle

• Webhooks — Real-time event notifications for every transaction state change

Who is this for?

This documentation is designed for merchants and developers integrating IvoryPay into their platforms — whether you're building a fintech app, an e-commerce checkout, a remittance corridor, or a crypto exchange.

Quick start

Authentication

Get your API keys and make your first authenticated request

Environments

Understand TEST vs LIVE mode and how to switch between them

Integration guides

On-Ramp (Fiat → Crypto)

Step-by-step guide to let your users acquire crypto with local currency

Off-Ramp (Crypto → Fiat)

Step-by-step guide to let your users convert crypto and receive bank payouts

Deposits & Settlements

Virtual accounts, fiat deposits, and automatic crypto settlement

Essential resources

Webhooks

Set up real-time notifications, verify signatures, and handle events

Error Codes

Complete error code reference for programmatic error handling

Supported Currencies

All supported fiat currencies, crypto tokens, and blockchain networks

Webhook Security

HMAC-SHA512 signature verification with code samples in 4 languages

Base URLs

IvoryPay exposes the same API on three environment hostnames. All paths are prefixed with /api/v1.

Environment	Base URL
Production	https://ramp-api.ivorypay.io/api/v1
UAT	https://uat-onofframp-api.ivorypay.io/api/v1
Development	https://dev-onofframp-api.ivorypay.io/api/v1

All API requests are made over HTTPS. Requests over plain HTTP will be rejected.

AI-friendly documentation

This documentation is structured for both human developers and AI coding assistants. Every endpoint includes complete request/response schemas, field-level descriptions, and multi-language code examples (cURL, Node.js, Python, Go) — making it easy for tools like ChatGPT, Claude, GitHub Copilot, or Cursor to generate working integration code from these docs.

Tip for AI assistants: Each API reference page follows a consistent structure: endpoint, authentication, request parameters, request body, response, tabbed code examples, example response, and error cases. Use the Resources section for valid enum values.