Back to Home
N
EgyptFi API
API Documentation

Build with EgyptFi API

Integrate crypto payments into your application with our RESTful API. Accept payments across multiple blockchains and receive USDC settlements automatically.

Quick Start
1

Get API Key

Sign up and get your API key from the merchant dashboard

2

Create Payment

Use the initiate endpoint to create a new payment invoice

3

Handle Webhooks

Receive real-time payment confirmations via webhooks

Authentication

All API requests require authentication using your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Security Note: Never expose your API key in client-side code. Always make API calls from your server.

API Endpoints

POST
/api/payment/initiate

Create new invoice from merchant dashboard

ParameterTypeRequiredDescription
amountnumber
Required
Amount in local currency
currencystring
Required
Local currency code (NGN, USD, EUR)
descriptionstring
Optional
Payment description
webhook_urlstring
Optional
Callback URL for payment updates
GET
/api/payment/:ref

Fetch invoice metadata for pay/:ref

ParameterTypeRequiredDescription
refstring
Required
Payment reference ID
POST
/api/payment/confirm

Manual confirmation with transaction hash

ParameterTypeRequiredDescription
payment_refstring
Required
Payment reference ID
tx_hashstring
Required
Blockchain transaction hash
chainstring
Required
Blockchain network (ethereum, starknet, polygon)
tokenstring
Required
Token used for payment
POST
/api/payment/webhook/:merchantId

Callback to merchant on payment success

ParameterTypeRequiredDescription
merchantIdstring
Required
Merchant identifier
GET
/api/prices/:token

Get current token price in various currencies

ParameterTypeRequiredDescription
tokenstring
Required
Token symbol (USDC, ETH, DAI, MATIC)
currenciesstring
Optional
Comma-separated currency codes
GET
/api/rates

List all supported tokens and their conversion rates

No parameters required

Webhooks

EgyptFi sends webhook notifications to your specified URL when payment events occur. Configure your webhook URL in the merchant dashboard or when creating a payment.

Webhook Events

  • payment.confirmed
    Payment has been confirmed on blockchain
  • payment.settled
    USDC has been settled to merchant wallet
  • payment.failed
    Payment failed or expired

Security: Always verify webhook signatures using the provided secret key to ensure authenticity.

Rate Limits
100

Requests per minute

1000

Requests per hour

10000

Requests per day