Online Payments API
Our simple, straightforward API gets you up and running quickly.
Payments API Reference
The following are links to all our resources in our online payments API. Each section of our API includes detailed information about methods & parameters as well as example code.
- The amount fields in relation to currency will be the amount in the smallest denomination of your currency.
- For currencies with 2 decimals please use the amount * 100 (1.00USD = 100)
- For currencies with 3 decimals please use the amount * 1000 (1.000TND = 1000)
- For currencies with 0 decimal places use the amount * 1 (1JPY = 1)
An instance of a credit/debit card authorization, with a payment expected to be captured later.Learn more
One time use token representing card details that can be used to create a payment.Learn more
Coupons can be applied to subscriptions.Learn more
Customers can be assigned subscriptions for recurring payments.Learn more
BETA. Test Mode only.Learn more
An invoice contains items to charge a customer.Learn more
Line items for invoices.Learn more
An instance of a credit/debit card payment.Learn more
Recurring payment plans that are used to create subscriptions.Learn more
A refund of a previous payment (full or partial).Learn more
Subscriptions to recurring plans for a particular customer.Learn more
Tax rates to be applied to an invoice.Learn more
Objects representing HTTP endpoints that will receive callbacks after various events.Learn more
After logging into your account, your API keys can be located at: Settings ⟶ API Keys
There will be two private keys – one for Sandbox mode and one for Live mode. If you have not yet registered for Live mode, then there will only be a Sandbox key. To make them easy to distinguish, sandbox keys are prefixed with sbpb_ and live keys with lvpb_.
These are private keys, so keep them safe. Anyone who obtains your private API key can make API requests on your behalf!