Operations
Operation Types
operation | Meaning | Typical use case |
|---|---|---|
purchase | Standard sale (one-step); funds captured immediately | E-commerce checkout |
debit | Charge a customer for a previously agreed service (no linked Checkout purchase) | Post-paid services, back-office charges |
credit | Payout / push funds to the customer | Payouts, refunds, rewards |
transfer | Move funds between two parties using the Checkout form | P2P, marketplace payouts |
[!NOTE] Use
purchaseunless your business explicitly requires one of the others.recurring_init,vat_calc, and the >methodsarray are valid only forpurchase.
Purchase
operation: purchase
Description: Initiates a standard sale (purchase) operation. The customer is charged immediately for the specified amount.
Typical use cases:
- One-time e‑commerce payments
- Standard online purchases where funds are captured right away
Debit
operation: debit
Description: Initiates a debit operation, where funds are taken from the customer’s payment instrument (e.g. card or account) without a linked prior purchase via Checkout.
Typical use cases:
- Charging a customer based on a previously agreed service (e.g. post‑paid services)
- Manual debits initiated by the merchant’s back‑office or CRM flow
Credit
operation: credit
Description: Initiates a credit operation, where funds are sent to the customer instead of being charged from them. This is effectively a payout/credit to the customer’s card or account.
Typical use cases:
- Payouts to customers (cash‑out, winnings, rewards, etc.)
- Manual adjustments or balance top‑ups in favor of the customer
Transfer
operation: transfer
Description: Initiates a transfer between two parties/accounts using the Checkout form. Funds are moved from the source side to the destination side according to your business logic.
Typical use cases:
- Internal transfers between customer wallets/accounts
- Marketplace or platform flows where funds are moved from one participant to another
Post-payment operations
Post-payment actions (capture, refund, void, recurring, retry, status lookup) act on a payment that has already been initiated through /api/v1/session. See the Payment Checkout API for request parameters and examples.
API requests
Request parameters, field definitions, and curl examples for all Checkout operations live in the API requests section, not on this page.