surcharge-calculation

Request

PropertyTypeRequiredDescription
currencystringRequired
Calculate Surcharge requests only
The currency being used for the transaction.
amountstringRequiredThe amount of the transaction prior to surcharge.
payment-methodstringOptionalThe payment method of the transaction. If payment information such as credit-card is provided in the request, the payment method will be inferred automatically.
pf-tokenstringRequired
for Calculate Surcharge requests only if using Hosted Payment Fields
A Hosted Payment Fields token.
walletcontainerRequired
Only if using Apple Pay or Google Pay
Refer to wallet.
vaulted-shopper-idintegerOptional
Calculate Surcharge requests only
A Vaulted Shopper ID.
credit-cardcontainerRequired
for Calculate Surcharge requests only if not using Hosted Payment Fields or vaulted shopper
Refer to credit-card.
surcharge-infocontainerRequired
Calculate Prorated Surcharge requests only
Refer to surcharge-info.

Response

PropertyTypeDescription
currencystringThe currency used for the surcharge calculation.
amountstringThe calculated amount of the surcharge.
payment-methodstringThe payment method of the transaction.
Calculate Surcharge response only
payer-detailscontainerRefer to payer-info.
Calculate Surcharge response only
credit-cardcontainerRefer to credit-card.
surcharge-infocontainerRefer to surcharge-info.