Skip to main content

Financial operation request body

Used by: /sale, /preauth, /confirm, /cancel, /refund

Money format:

  • All monetary fields are integers in minor units.
  • Do not send decimal separators or floating-point values.
  • Examples for a 2-decimal currency: 1.00 -> 100, 125.50 -> 12550.
  • For zero-decimal currencies, the value matches the whole amount.
FieldTypeRequiredDescription
pay_idstringRecommendedIntegrator operation ID (idempotency key)
terminallongNoTerminal numeric ID (see terminal/merchant resolution rules below)
merchantlongNoMerchant numeric ID (see terminal/merchant resolution rules below)
amountlongYesTransaction amount in minor units
tipslongNoTip amount in minor units
cashbacklongNoCashback amount in minor units
rrnstringOperation-dependentReference number for linked operations
currency_namestringYesCurrency identifier/name
package_namestringNoCallback package identifier
doc_numberstringNoExternal document number
headlessbooleanNoHeadless mode flag
no_printingbooleanNoDisable printing
txn_configobjectNoAdditional transaction options
languagestringNoResponse localization hint

Validation notes:

  • tips and cashback cannot both be greater than zero.
  • currency_name must be supported by deployment.