Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gosurge.xyz/llms.txt

Use this file to discover all available pages before exploring further.

​
What is Surge?

Surge is Nigeria’s embedded Buy Now, Pay Later (BNPL) infrastructure. Merchants add a single script tag and their customers can immediately split any purchase into installments — without leaving the store. Surge handles risk scoring, payment collection, delinquency management, and merchant settlement.

Server Integration

Create checkout sessions from your backend and start accepting installments.

Client SDK

Embed the Surge widget into your frontend with our JavaScript SDK.

Webhooks

Receive real-time events for payment success, failures, and settlements.

Payment Methods

Manage customer cards and bank direct debit mandates via the API.

​
Getting Started

  1. Register as a Merchant — Sign up at merchant.gosurge.xyz.
  2. Get your API Keys — Retrieve your Secret Key from the API Keys page in your dashboard.
  3. Create a Checkout Session — Call POST /api/v1/checkout/sessions from your backend with the cart amount.
  4. Open the Widget — Use the session token to launch the Surge widget on your frontend.
  5. Handle Webhooks — Listen for payment.success to fulfill orders.

​
Integration Overview

Merchant Backend  →  POST /checkout/sessions  →  Surge API
                  ←  { session_token }         ←
Merchant Frontend →  surge.openCheckout({ sessionToken })
Customer          →  logs in, selects plan, pays deposit
Surge             →  fires payment.success webhook to merchant

API Reference

Full REST API reference with request/response schemas.

Live Demo

Try the Surge checkout experience right now.