For businesses and developers
Reconcile card-to-card and bank transfer payments, from the dashboard or in code
From your first test receipt to the evidence pack, signed webhooks and store plugins. Every amount in the API is an integer in rial.
20 guides
Get started
Payments
- Payments and their statusesThe payment object, its payment methods and destination, the unique amount, how receipts and deposits complete it, and every status a payment can be in.
- Hosted checkout and the return redirectWhat your customer sees at checkout_url, the two payment tabs and the receipt step, the checkout API behind the page, and how to verify the signed return link.
- Receipts and reviewHow customers send their bank receipt, how your team approves it fully or partly or rejects it in one queue, and how a receipt and a bank SMS never count one transfer twice.
- Bank transfers (Pol, Paya, Satna)Take payments by IBAN transfer as well as card to card: cards with an IBAN, accounts without a card, the payment methods setting, the kinds of transfer and the wait window.
- Partial payments and top-upsWhat happens when a customer sends less than they should, how your team approves part of a receipt, and how the rest is collected on the same payment.
- CorrectionsApprove, reject and reopen receipts, attach and detach deposits, record a transfer by hand and clear the review queue, from the dashboard or the API.
- OverpaymentsWhen a customer sends more than asked, or money arrives on a canceled payment, and how you close it out.
- Evidence packOne printable record per payment, with its receipts and their fingerprints, its deposits and who did what and when, to save as a PDF.
- Payment linksA shareable page that takes payments without any code: a fixed price or an amount the payer types, with the fields you ask for.
- CustomersKeep the people who pay you in one place, with their cards, totals and any credit you owe them.
Developer tools
- WebhooksReceive signed events when payments change, verify the signature exactly, and handle retries and duplicates.
- IdempotencyRetry any POST safely, so a lost answer never creates a second payment.
- Pagination and expandWalk long lists with cursors, filter them by date, and load related objects in the same request.
- ErrorsThe error object, what each status means, and every public error code with what to do about it.
Integrations
- Bank SMS beside receipts: the SMS app (optional)What the optional SMS app adds to receipt review, how to set it up on Android and iPhone so it catches card-to-card, Pol, Paya and Satna deposits, and why everything works without it.
- WooCommerce, Easy Digital Downloads and WHMCSInstall a ready plugin, connect it in one click, and see how orders and invoices follow their payments and receipts.
- Node, PHP and Python librariesInstall an official library, create payments, verify webhooks and handle errors in your own language.