Skip to main content

Transactions

Merge Tag

Type

Description

{{transaction.transaction_id}}integerTransaction ID #
{{transaction.parent_transaction_id}}integerParent transaction ID #
{{transaction.transaction_batch_id}}integerTransaction batch ID #
{{transaction.customer_id}}integerThe customer ID # this contact belongs to
{{transaction.brand_id}}integerBrand ID #
{{transaction.gateway_id}}integerPayment gateway ID #
{{transaction.gateway_type}}stringPayment gateway type
{{transaction.gateway_nickname}}stringNickname for the payment gateway
{{transaction.gateway_status}}integerPayment gateway status (1 for success, 0 for failure)
{{transaction.gateway_transid}}stringPayment gateway transaction identifier
{{transaction.gateway_transid}}stringPayment gateway transaction identifier
{{transaction.gateway_method}}stringPayment gateway method
{{transaction.gateway_msg}}stringA customer-facing error message indicating why the transaction declined/failed
{{transaction.gateway_err_code}}integerA merchant-facing specific error code indicating why the transaction declined/failed
{{transaction.gateway_err_detail}}stringA merchant-facing detailed error message indicating why the transaction declined/failed
{{transaction.gateway_opts}}mixedAdditional gateway-specific data
{{transaction.token}}stringA unique token for the transaction
{{transaction.external_key}}stringTransaction external key value
{{transaction.currency_id}}integerCurrency ID #
{{transaction.currency_symbol}}stringCurrency symbol
{{transaction.currency_iso4217}}stringCurrency ISO 4217 code
{{transaction.amount}}floatTotal transaction amount (refunds will be negative)
{{transaction.fee}}floatTransaction fee (if gateway provides this data)
{{transaction.applied}}floatAmount that is applied to invoices
{{transaction.unapplied}}floatAmount that is unapplied (not applied to any invoices)
{{transaction.transaction_date}}dateDate of the transaction
{{transaction.transaction_status_name}}stringHuman-friendly transaction status
{{transaction.transaction_status_str}}stringStatus string
{{transaction.transaction_status_state}}stringStatus code
{{transaction.transaction_type}}stringTransaction type (one of: pay, ref, cre, spl)
{{transaction.transaction_type_name}}stringTransaction type name
{{transaction.transaction_method}}stringTransaction method
{{transaction.transaction_detail}}stringTransaction details
{{transaction.transaction_datetime}}datetimeDate/time of the transaction was created
{{transaction.transaction_ipaddr}}stringIP address that created the transaction
{{transaction.void_datetime}}datetimeDate/time the transaction was voided
{{transaction.url_self}}}}stringURL for viewing the transaction in the GUI
{{transaction.applied_to}}arrayInformation about how the payment is applied
{{transaction.custom_1}}mixedCustom field #1
{{transaction.custom_2}}mixedCustom field #2
{{transaction.custom_3}}mixedCustom field #3
{{transaction.custom_4}}mixedCustom field #4
{{transaction.custom_5}}mixedCustom field #5
{{transaction.memo}}stringTransaction memo