Create a payment collection or link

Collect a payment two ways: a hosted checkout link, or raw bank details for your own UI.

Hosted checkout link

Call collect-link and redirect the customer to the URL we return. We handle the bank-details display, the countdown and the confirmation:

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"}'

Raw bank details

Call collect to get an account number, bank and reference to render yourself:

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

Each collection has a 30-minute window before it expires.

List, check status and cancel

• List: GET /api/v1/payment/payments, filter by status to build dashboards.
• Check status: GET /api/v1/payment/status/:ref, syncs the latest transfer status when the payment is not yet terminal.
• Cancel: POST /api/v1/payment/cancel with the paymentReference. Only pending collections can be cancelled.

Tip: Never reuse a cancelled reference. Create a new reference for replacements.

What's next

• See Set up and verify webhooks.
• See Payment statuses and error codes.