Getting started with the Boldswitch API

The Boldswitch API lets you collect payments programmatically with plain JSON over HTTPS. API access is an Enterprise feature.

Before you start

• Make sure your account is on the Enterprise plan. Sandbox testing is available so you can build before going live.
• Open Settings, then Developer, then API Keys to issue a live key and a test key.

How collection works

You have two ways to collect:

• Hosted checkout — call collect-link and redirect your customer to the URL we return. We display the bank details, the countdown and the confirmation for you.
• Raw bank details — call collect to get an account number, bank and reference, then render your own checkout.

After a customer pays, you list collections, check a status, or cancel, and reconcile against your records.

A first request

Create a hosted checkout link with your live key in the apikey header:

curl -X POST https://business.boldswitch.ng/api/v1/payment/collect-link \
  -H "apikey: live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount": 75000, "paymentReference": "INV-001"}'

The response includes a hosted URL the customer opens to pay.

Tip: Live keys call /api/v1/payment routes. Test keys call /api/v1/sandbox/payment routes. Using a key on the wrong environment fails authentication.

What's next

• See Create and manage your API keys.
• See Test in the sandbox.

Questions? Email support@boldswitch.ng.