Fedapay

Authentication

FedaPay uses Bearer token authentication with API keys stored in your FedaPay dashboard.

Getting Your API Keys

1. Log in to your FedaPay Dashboard (https://dashboard.fedapay.com)
2. Navigate to your account settings
3. Retrieve both Test API Key (for sandbox) and Live API Key (for production)
4. Keep API keys secure—never commit them to version control

API Key Authentication Header

All requests require the Authorization header with Bearer token format:

Authorization: Bearer sk_test_YOUR_SECRET_KEY

Setting API Key in Code

PHP SDK

<?php
\FedaPay\Fedapay::setApiKey('sk_test_YOUR_SECRET_KEY');
\FedaPay\Fedapay::setEnvironment('sandbox'); // or 'production'

Node.js

const FedaPay = require('fedapay');
FedaPay.setApiKey('sk_test_YOUR_SECRET_KEY');
FedaPay.setEnvironment('sandbox');

cURL

curl -H "Authorization: Bearer sk_test_YOUR_SECRET_KEY" \
     https://sandbox-api.fedapay.com/v1/transactions

Environment Selection

• Sandbox: https://sandbox-api.fedapay.com/v1 (testing, no real charges)
• Production: https://api.fedapay.com/v1 (live transactions)

Always test thoroughly in sandbox before switching to production.

Core API Reference

Base URLs

Sandbox:    https://sandbox-api.fedapay.com/v1
Production: https://api.fedapay.com/v1

Transaction Creation

Create a new transaction to initiate a payment.

Endpoint: POST /transactions

Request:

{
  "description": "Order #12345 - Purchase",
  "amount": 10000,
  "currency": {
    "iso": "XOF"
  },
  "callback_url": "https://yoursite.com/payment-callback",
  "mode": "mtn_open",
  "customer": {
    "id": 1
  }
}

Key Parameters:

• description (string): Payment description shown to customer
• amount (integer): Amount in XOF francs (whole units). XOF centimes are not used in practice; treat every unit as one franc. 5000 = 5,000 XOF.
• currency.iso (string): Currency code (XOF, XAF)
• callback_url (string): URL to redirect after payment completion
• mode (string): Payment method (see Payment Methods section)
• customer (object): Customer ID or inline customer details
  • id (integer): Existing customer ID, or create inline:
  • firstname (string): Customer first name
  • lastname (string): Customer last name
  • email (string): Customer email
  • phone_number (string): Customer phone number

Successful Response (201 Created):

{
  "id": 12345,
  "status": "pending",
  "description": "Order #12345 - Purchase",
  "amount": 10000,
  "currency": {
    "iso": "XOF",
    "name": "CFA Franc"
  },
  "mode": "mtn_open",
  "reference": "TX-20240115-ABC123",
  "customer": {
    "id": 1,
    "firstname": "John",
    "lastname": "Doe",
    "email": "[email protected]"
  },
  "created_at": "2024-01-15T10:30:00Z"
}

Retrieve Transaction

Get details about a specific transaction.

Endpoint: GET /transactions/{id}

Response:

{
  "id": 12345,
  "status": "approved",
  "description": "Order #12345 - Purchase",
  "amount": 10000,
  "currency": {
    "iso": "XOF"
  },
  "mode": "mtn_open",
  "reference": "TX-20240115-ABC123",
  "approved_at": "2024-01-15T10:35:00Z",
  "customer": {
    "id": 1,
    "firstname": "John",
    "lastname": "Doe"
  }
}

List Transactions

Retrieve paginated list of transactions.

Endpoint: GET /transactions

Query Parameters:

• limit (integer): Max results per page (default: 20, max: 100)
• page (integer): Page number (default: 1)
• sort (string): Sort field (e.g., -created_at for descending)

Response:

{
  "data": [
    {
      "id": 12345,
      "status": "approved",
      "amount": 10000,
      "currency": { "iso": "XOF" }
    }
  ],
  "meta": {
    "total": 150,
    "current_page": 1,
    "per_page": 20,
    "last_page": 8
  }
}

Customer Management

Create Customer

Endpoint: POST /customers

{
  "firstname": "John",
  "lastname": "Doe",
  "email": "[email protected]",
  "phone_number": "+22960000000",
  "metadata": {
    "merchant_id": "12345"
  }
}

Response:

{
  "id": 1,
  "firstname": "John",
  "lastname": "Doe",
  "email": "[email protected]",
  "phone_number": "+22960000000",
  "created_at": "2024-01-15T10:00:00Z"
}

Retrieve Customer

Endpoint: GET /customers/{id}

Supported Payment Methods

FedaPay supports the following payment modes (varies by country):

No-Redirect Modes: Direct payment possible with MTN Benin, Moov Benin, Moov Togo, and MTN Côte d'Ivoire without redirecting to FedaPay's payment page.

Webhooks

FedaPay sends real-time notifications to your application when transaction events occur.

Setting Up Webhooks

1. Log in to FedaPay Dashboard
2. Navigate to Settings → Webhooks
3. Click New Webhook
4. Enter your webhook URL (must be publicly accessible HTTPS)
5. Select events to subscribe to
6. Save

Webhook URL Example