Reference

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/businessYour business and the key's mode
GET/v1/balanceAvailable, pending, reserve and outgoing naira
GET/v1/product_accessWhich products are on
POST/v1/test_eventsSend a sample webhook event

Pay-ins

POST/v1/checkoutsStart a payment
GET/v1/checkouts/:idA checkout
GET/v1/paymentsPayments, newest first
GET/v1/payments/:idA payment
GET/v1/customersCustomers
POST/v1/productsA product
GET/v1/productsProducts
POST/v1/payment_linksA payment link
GET/v1/payment_linksPayment links

Invoices and subscriptions

POST/v1/invoicesMake (and send) an invoice
GET/v1/invoicesInvoices
GET/v1/invoices/:idAn invoice
POST/v1/invoices/:id/sendSend it
POST/v1/invoices/:id/voidCancel it
POST/v1/subscriptionsStart a subscription
GET/v1/subscriptionsSubscriptions
GET/v1/subscriptions/:idA subscription
POST/v1/subscriptions/:id/pausePause
POST/v1/subscriptions/:id/resumeResume
POST/v1/subscriptions/:id/cancelCancel

Refunds and disputes

POST/v1/refundsRefund all or part of a payment
GET/v1/refundsRefunds
GET/v1/refunds/:idA refund
GET/v1/disputesDisputes
GET/v1/disputes/:idA dispute
POST/v1/disputes/:id/respondAnswer a dispute

Transfers and payouts

GET/v1/banksBank codes
POST/v1/banks/resolveThe name on an account
POST/v1/transfersSend to a bank account
POST/v1/transfers/bulkUp to 500 at once
GET/v1/transfersTransfers
GET/v1/transfers/:idA transfer
POST/v1/payoutsPay out to your own bank
GET/v1/payoutsPayouts

Mobile money

GET/v1/mobile_money/operatorsNetworks in a country
POST/v1/mobile_money/quoteWhat it costs in naira
POST/v1/mobile_moneySend to a wallet

Virtual cards

POST/v1/cardholdersA cardholder
GET/v1/cardholdersCardholders
POST/v1/cardsA card, with its first load
GET/v1/cardsCards
GET/v1/cards/:idA card, its loads and spends
POST/v1/cards/:id/loadAdd dollars
POST/v1/cards/:id/unloadTake dollars back
POST/v1/cards/:id/freezeFreeze
POST/v1/cards/:id/unfreezeUnfreeze

Stablecoins

GET/v1/coinsCoin balances, addresses and activity
POST/v1/coins/addressesYour address for a coin and network
POST/v1/coins/payoutsSend coins
POST/v1/coins/conversions/quoteCoins to naira: the rate
POST/v1/coins/conversionsConvert

Identity

POST/v1/identity/checksCheck a BVN or NIN
GET/v1/identity/checksChecks
GET/v1/identity/checks/:idA check

Errors: see Errors and idempotency.