Skip to main content

A single payment line on an operation. amount is always a positive integer — direction carries the sign semantic.

  • inbound: money flows from customer to merchant (customer pays)
  • outbound: money flows from merchant to customer (change, refunds)

Include a method-specific sub-object when you have details to attach. Only the sub-object matching method is considered; others are ignored.

method
enum<string>
required
Available options:
cash,
card,
wallet,
voucher,
gift_card,
online,
other
direction
enum<string>
required

Direction of money flow. inbound: customer pays merchant. outbound: merchant pays customer (change, refund payout).

Available options:
inbound,
outbound
amount
integer
required

Always a positive integer in minor currency units

Example:

4250

currency
string

Defaults to the operation currency if omitted

reference
string | null

External transaction reference from your payment processor. Stored and returned as-is. Useful for reconciliation.

cash
object

Present when method is cash

card
object

Present when method is card

wallet
object

Present when method is wallet (Apple Pay, Google Pay, etc). Wallet payments are card-present NFC transactions. Distinct from card because some jurisdictions require the wallet provider on the receipt.

voucher
object

Present when method is voucher

gift_card
object

Present when method is gift_card

online
object

Present when method is online. Covers remote payment providers (PayPal, Klarna, bank transfer) — distinct from wallet which is card-present NFC.