amount
The amount
element is a child of several elements. When used in a payment transaction this element defines the amount of the transaction. When amount
is a child of the subscription
element, it defines the amount of the recurring payment. As a child of the activate
, load
, or unload
transactions, amount
defines the initial value of a newly activated gift Card, the amount loaded onto a reloadable Gift Card, or the amount unloaded from a Gift Card, respectively. When used in an Instruction-Based Dynamic Payout transaction type, it specifies the amount of funds to transfer and has a different maximum number of digits. Supply the value in cents without a decimal point. For example, a value of 1995 signifies $19.95.
When submitting an incremental authorization, use only the increase to the amount in the amount element of the incremental auth (i.e., <authIndicator>Incremental</authIndicator>
). For example, if you submitted an initial estimated auth (i.e., <authIndicator>Estimated</authIndicator>
) for 100 and final amount is 120, submit 20 as the amount in the incremental auth.
For the following currencies, the value you submit is the amount without implied decimal: Burundian Franc, Chilean Peso, Comoro Franc, Djibouti Franc, Guinea Franc, Iceland Krona, Japanese Yen, South Korean Won, Vanuatu Vatu, Paraguayan Guarani, Rawanda Franc, Vietnamese Dong, Uganda Shilling, CFA Franc BEAC, CFA Franc BCEAO, and CFP Franc. For example, if the currency is Japanese Yen, entering 2000 means 2000 Yen, NOT 20.00 Yen.
Type = Integer; totalDigits = 12 (for all transactions except Dynamic Payout) or 10 for Dynamic Payout
Parent Elements:
The amount element is a required child of each of the following Parent Elements: activate, authorization, BNPLAuthorizationRequest, BNPLCancelRequest, BNPLCaptureRequest, BNPLRefundRequest, credit (required if original transaction was not processed by Worldpay), captureGivenAuth, echeckCredit(required if original transaction was not processed by Worldpay), echeckSale, echeckVerification, forceCapture, fraudCheck, load, sale, unload
This element is also a required child of the following Instruction-Based Dynamic Payout transaction types: payFacCredit, payFacDebit, reserveCredit, reserveDebit, submerchantCredit, submerchantDebit, vendorCredit, vendorDebit, fastAccessFunding
The amount element is an optional child of each of the following Parent Elements: authReversal, capture, credit, echeckCredit, subscription, depositTransactionReversal
For all cases where the amount element is optional, except when a child of the subscription
element, if you do not specify a value, the system uses the entire amount from the referenced (by cnpTxnId
) transaction. When the amount is a child of the subscription
element, if you do not specify a value, the amount defaults to the value defined in the referenced recurring plan (planCode
element).
Attributes:
None
Child Elements:
None