Developer Hub

Everything you need to integrate CheckoutPay into your application. API reference, webhooks, testing tools, and more.

Developer Program — earn on client integrations Apply to the program

API Reference

Base URL

https://check-outpay.com/api/v1

Authentication

All API requests require an API key in the header:

X-API-Key: pk_your_api_key_here
View Complete API Documentation

Webhooks

Receive real-time notifications when payment status changes. Configure your webhook URL in your dashboard.

Webhook Events

  • payment.approved - Payment verified and approved
  • payment.rejected - Payment rejected or expired
Learn More About Webhooks

Quick Integration Guide

1

Get API Keys

Sign up and get your API keys from the dashboard

2

Make API Call

Create payment request using our REST API

3

Receive Webhook

Get notified when payment is verified

Testing

Test Mode

Use test API keys to test your integration without processing real payments.

Note: Test mode uses the same API endpoints but with test credentials. No real payments will be processed.

Get Started with Test Keys

Developer & API FAQs

See all FAQs including search for WordPress, API, and developer program topics.

Does CheckoutPay offer a payment gateway API in Nigeria?

Yes. Merchants use REST APIs to create payments, virtual accounts, and subscriptions, with webhook callbacks for success and failure. Start at https://www.check-outnow.com/api-docs and complete signup for full keys and reference docs in the business dashboard.

How do I authenticate API requests?

Generate API keys from your CheckoutPay business dashboard. Send the secret key in the Authorization header as documented in your account API reference. Never expose secrets in client-side mobile or browser code.

What webhook events should my app handle?

At minimum, handle payment success and failure events so you can fulfill orders or grant access. Verify webhook signatures when provided, respond quickly with HTTP 200, and make handlers idempotent using your payment reference IDs.

How do virtual account payments work via API?

Create a payment with amount and customer metadata; CheckoutPay returns account details or payment instructions. When the customer transfers from a Nigerian bank, matching completes the payment and triggers your webhook.

Is there a sandbox for developers?

Use test credentials from your dashboard for integration testing. Sandbox transactions are for quality assurance only and do not qualify for developer revenue share.

How should I handle duplicate webhook deliveries?

Store processed event IDs or payment references and ignore repeats. Design fulfillment logic to be idempotent so the same successful payment never ships twice.

Can I integrate Laravel, mobile apps, or custom checkout?

Yes. Any stack that can call HTTPS APIs and receive webhooks can integrate. Agencies in the Developer Program should align partner attribution during onboarding at https://www.check-outnow.com/developers/program.

Where is the full API reference?

Public overview lives at https://www.check-outnow.com/api-docs. After registration, open API documentation inside your business dashboard for endpoints, payloads, and examples tied to your environment.

What is the CheckoutPay Developer Program in Nigeria?

It is a partner program for developers and agencies who integrate CheckoutPay for clients. Approved partners can earn ongoing revenue share on qualifying production volume—not just a one-off project fee.

Do I need to apply before earning revenue share?

Yes. Submit the application at https://www.check-outnow.com/developers/program/apply and be approved. Until you are in the program, we do not accrue developer share even if you already use our API or plugin.

How is this different from integrating Paystack or Flutterwave for years?

Many gateways treat developers as implementation help while the brand keeps long-term processing value. CheckoutPay is built so approved partners with valid attribution can earn a defined share on eligible volume.

Where do I put my Business ID on a client WordPress site?

In the WooCommerce CheckoutPay gateway settings, use the developer or partner Business ID field. The merchant still uses their own API credentials; your ID only routes revenue share to your account.

I build Laravel or mobile apps—how do I get paid without WordPress?

The WordPress field is the first simple pattern we ship. The same principle applies elsewhere: an explicit partner identifier agreed at onboarding (metadata, referral codes, or documented API patterns). Contact us via https://www.check-outnow.com/contact with your stack before go-live.

Does my client pay extra so I get paid?

Your share comes from the program economics on eligible processing—not from a hidden surcharge on the shopper. Rates and terms are described on https://www.check-outnow.com/developers/program and in your partner agreement.

Do test or sandbox transactions count toward my share?

No. Revenue share applies to qualifying production volume under program rules with valid attribution. Test keys are for integration only.

Can one agency Business ID cover many client stores?

Usually yes: one partner business account and one Business ID across many stores, each using the plugin or API with your attribution field. Separate legal entities may need separate business accounts.

CheckoutPay Support