subtotal
required |
number (double)
|
Subtotal (base amount before tax and tip), in the transaction currency.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
tax
required |
number (double)
|
Tax amount, in the transaction currency.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
tip
required |
number (double)
|
Tip/gratuity amount, in the transaction currency.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
shipping
required |
number (double)
|
Shipping amount, in the transaction currency. Null / zero when no shipping amount was collected, in which case no
shipping line is rendered.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
total
required |
number (double)
|
Total transaction amount, in the transaction currency.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
approvedAmount
required |
number (double)
|
Approved amount, in the transaction currency (may differ from total for partial approvals).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isPartialApproval
required |
boolean
|
Whether the approval was partial.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
requestedAmount
required |
number (double)
|
The amount requested from the card issuer, in the transaction currency. Present on a partial approval receipt, where it
is printed beside `approvedAmount`, and on a split tender summary, where it is the
order total. Null on every other receipt.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
remainingBalanceAfterApproval
required |
number (double)
|
What a partial approval left unpaid on this card: `requestedAmount` minus
`approvedAmount`, never negative. On a split tender summary, what the group as a
whole left unpaid. In the transaction currency. Null whenever `requestedAmount` is null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
currencyCode
required |
string
|
ISO 4217 currency code (e.g. "USD").
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
cashBack
required |
number (double)
|
Cash back (debit) or cash over (Discover credit) amount, in the transaction currency.
Printed on Discover credit and debit receipts, where the processor's receipt rules require it.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
transactionFee
required |
number (double)
|
Transaction fee assessed (e.g. PIN debit fees), in the transaction currency. Included when provided by the processor.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
availableBalance
required |
number (double)
|
Available balance remaining after the transaction, in the transaction currency. Included when
provided by the processor (credit, debit, EBT, prepaid).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
convenienceFee
required |
number (double)
|
Convenience fee assessed on the transaction, in the transaction currency. Null / zero when no convenience fee applies,
in which case no fee line is rendered.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
convenienceFeeBilledSeparately
required |
boolean
|
True when the convenience fee was submitted as its own separately-authorized charge rather
than being included in this transaction's `total`. The fee line is then rendered
with a "billed as a separate charge" qualifier so the total still reconciles.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
surcharge
required |
number (double)
|
Surcharge amount assessed on the transaction, in the transaction currency. Present only when the gateway computed and
applied a surcharge; null otherwise (a non-surcharged transaction shows no surcharge line).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
surchargeRate
required |
number (double)
|
The surcharge rate applied to produce `surcharge`, as a decimal fraction (e.g. 0.03
for 3%).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
surchargeReversed
required |
number (double)
|
Surcharge amount reversed back to the cardholder on a refund / reversal receipt, in the
transaction currency. Null / zero
on non-refund receipts.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
cashPrice
required |
number (double)
|
For a merchant that posts a cash price and a card price, the cash price of this payment, in the
transaction currency: its base amount. Present, with `cardPrice`, only when the payment was charged one of the
two posted prices; null otherwise, and the receipt then prints its ordinary subtotal.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
cardPrice
required |
number (double)
|
For a merchant that posts a cash price and a card price, the card price of this payment, in the
transaction currency: the cash price plus the merchant's card rate. On a card payment it is the price charged; on a cash or
bank payment it is the price the payer did not pay. Null when the payment was not dual priced.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
cashDiscountAmount
required |
number (double)
|
The discount a payment charged the cash price received, in the transaction currency:
`cardPrice` minus `cashPrice`. Present only on a cash payment, or a bank payment the merchant treats as
cash; null on a card payment and when the payment was not dual priced.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
cashDiscountForBankPayment
required |
boolean
|
True when `cashDiscountAmount` was received by a bank payment rather than cash.
False whenever no cash discount applies.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
cardPriceReversed
required |
number (double)
|
The share of the card price returned to the payer on a void, reversal or refund of a payment
charged the card price, in the transaction currency. Not printed as a row of its own: the refunded total already includes it.
Null when nothing of a card price was returned.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|