API reference
Every call, at https://api.paygenthq.ai/v1. Send your secret key as a Bearer token; bodies are JSON or form fields; amounts are whole minor units.
Account
GET/v1/business | Your business and the key's mode |
GET/v1/balance | Available, pending, reserve and outgoing naira |
GET/v1/product_access | Which products are on |
POST/v1/test_events | Send a sample webhook event |
Pay-ins
POST/v1/checkouts | Start a payment |
GET/v1/checkouts/:id | A checkout |
GET/v1/payments | Payments, newest first |
GET/v1/payments/:id | A payment |
GET/v1/customers | Customers |
POST/v1/products | A product |
GET/v1/products | Products |
POST/v1/payment_links | A payment link |
GET/v1/payment_links | Payment links |
Invoices and subscriptions
POST/v1/invoices | Make (and send) an invoice |
GET/v1/invoices | Invoices |
GET/v1/invoices/:id | An invoice |
POST/v1/invoices/:id/send | Send it |
POST/v1/invoices/:id/void | Cancel it |
POST/v1/subscriptions | Start a subscription |
GET/v1/subscriptions | Subscriptions |
GET/v1/subscriptions/:id | A subscription |
POST/v1/subscriptions/:id/pause | Pause |
POST/v1/subscriptions/:id/resume | Resume |
POST/v1/subscriptions/:id/cancel | Cancel |
Refunds and disputes
POST/v1/refunds | Refund all or part of a payment |
GET/v1/refunds | Refunds |
GET/v1/refunds/:id | A refund |
GET/v1/disputes | Disputes |
GET/v1/disputes/:id | A dispute |
POST/v1/disputes/:id/respond | Answer a dispute |
Transfers and payouts
GET/v1/banks | Bank codes |
POST/v1/banks/resolve | The name on an account |
POST/v1/transfers | Send to a bank account |
POST/v1/transfers/bulk | Up to 500 at once |
GET/v1/transfers | Transfers |
GET/v1/transfers/:id | A transfer |
POST/v1/payouts | Pay out to your own bank |
GET/v1/payouts | Payouts |
Mobile money
GET/v1/mobile_money/operators | Networks in a country |
POST/v1/mobile_money/quote | What it costs in naira |
POST/v1/mobile_money | Send to a wallet |
Virtual cards
POST/v1/cardholders | A cardholder |
GET/v1/cardholders | Cardholders |
POST/v1/cards | A card, with its first load |
GET/v1/cards | Cards |
GET/v1/cards/:id | A card, its loads and spends |
POST/v1/cards/:id/load | Add dollars |
POST/v1/cards/:id/unload | Take dollars back |
POST/v1/cards/:id/freeze | Freeze |
POST/v1/cards/:id/unfreeze | Unfreeze |
Stablecoins
GET/v1/coins | Coin balances, addresses and activity |
POST/v1/coins/addresses | Your address for a coin and network |
POST/v1/coins/payouts | Send coins |
POST/v1/coins/conversions/quote | Coins to naira: the rate |
POST/v1/coins/conversions | Convert |
Identity
POST/v1/identity/checks | Check a BVN or NIN |
GET/v1/identity/checks | Checks |
GET/v1/identity/checks/:id | A check |
Errors: see Errors and idempotency.
paygent