Payonify API
The Payonify API is a RESTful API that allows merchants to process payments, create checkout sessions, and handle refunds for multiple payment methods including mobile money (EcoCash, OneMoney) and card payments (Visa, Mastercard, ZimSwitch).
Base URL
All API requests should be made to: https://api.payonify.com
Request/Response Format
All requests must use content type application/json and responses will be returned in JSON format.
Environment
Payonify provides both a test and a production environment to help you develop and test your integration.
- Test Environment: Use test API keys with the prefix
sk_test_to make test transactions that don't affect real money. - Production Environment: Use production API keys with the prefix
sk_live_to process real transactions.
Tags
Charges
The
Charge object represents a payment transaction. Creating a charge is the fundamental way to accept a payment with Payonify. A charge can be created with minimal information and then confirmed later, or created with complete payment information for immediate processing.Refunds
A
Refund object represents a reversal of funds from a previously created charge. When you create a refund, Payonify attempts to return the funds to the customer's original payment method.Checkout Sessions
A
Checkout Session represents your customer's session as they pay for one-time purchases through Checkout. Checkout Sessions provide a simple way to create a payment page for your customers.Payouts
A
Payout object represents a disbursement of funds to a recipient. Payouts allow you to send money to mobile money wallets and other supported destinations. Currently, EcoCash mobile money is available, with more coming soon.
Approval required: the Payouts API needs prior approval — your account must be approved for B2C services. Contact sales for more.