surchargeCalculation

Request

PropertyTypeRequiredDescription
currencystringRequired
Calculate Surcharge requests only
The currency being used for the transaction.
amountstringRequiredThe amount of the transaction prior to surcharge.
paymentMethodstringOptionalThe payment method of the transaction. If payment information such as creditCard is provided in the request, the payment method will be inferred automatically.
walletcontainerRequired
Only if using Apple Pay or Google Pay
Refer to wallet.
pfTokenstringRequired
for Calculate Surcharge requests only if using Hosted Payment Fields
A Hosted Payment Fields token.
vaultedShopperIdintegerOptional
Calculate Surcharge requests only
A Vaulted Shopper ID.
creditCardcontainerRequired
for Calculate Surcharge requests only if not using Hosted Payment Fields or vaulted shopper
Refer to creditCard.
surchargeInfocontainerRequired
Calculate Prorated Surcharge requests only
Refer to surchargeInfo.

Response

PropertyTypeDescription
currencystringThe currency used for the surcharge calculation.
amountstringThe calculated amount of the surcharge.
paymentMethodstringThe payment method of the transaction.
Calculate Surcharge response only
payerDetailscontainerRefer to payerInfo.
Calculate Surcharge response only
creditCardcontainerRefer to creditCard.
surchargeInfocontainerRefer to surchargeInfo.