SalamPay API Documentation

Accept payments via Wave, Orange Money, Free Money and more with a single API integration.

Authentication

Authenticate your API requests using Bearer tokens. Include your API key in the Authorization header.

Authorization: Bearer spk_live_your_api_key_here

Create a checkout session to redirect your customer to the SalamPay payment page.

curl https://api.salamfay.com/v1/checkout/sessions \
  -H "Authorization: Bearer spk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 25000,
    "currency": "XOF",
    "provider": "wave",
    "customer": {
      "phone": "+221771234567",
      "name": "Amadou Diallo"
    },
    "metadata": {
      "order_id": "ORD-12345"
    },
    "success_url": "https://example.com/success",
    "cancel_url": "https://example.com/cancel"
  }'

Request Body

Response

{
  "id": "cs_abc123xyz",
  "object": "checkout.session",
  "amount": 25000,
  "currency": "XOF",
  "status": "pending",
  "checkout_url": "https://pay.salamfay.com/cs_abc123xyz",
  "expires_at": "2024-03-20T12:00:00Z"
}

Webhooks

SalamPay sends webhook events to notify your application when payment status changes.

Event Types

Webhook Payload

{
  "id": "evt_123abc",
  "type": "checkout.session.completed",
  "created": 1710921600,
  "data": {
    "object": {
      "id": "cs_abc123xyz",
      "amount": 25000,
      "status": "completed",
      "metadata": {
        "order_id": "ORD-12345"
      }
    }
  }
}

Errors

SalamPay uses standard HTTP response codes to indicate success or failure.

SDKs & Libraries

Use our official SDKs for faster integration.

Testing

Use test API keys to simulate payments without real money.