Allows you to get a surcharge recommendation for a transaction based on the customer's billing state and information about the payment. The response provides information about whether surcharging is recommended or what restrictions apply for surcharging with the transaction.
If the saved card token includes data.customer.billToState, you only need to include that token in the request. Otherwise, you must explicitly include data.customer.billToState and just one of the following parameters:
card.firstSixcard.pantokenex.tokentokenex.firstSix
Note
In order to use this endpoint, the Surcharging feature must be enabled for the account and the new agreement must be accepted (which displays upon logging into the Dashboard).
Try It
To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.
If the saved card token includes
data.customer.billToState, you only need to include that token in the request. Otherwise, you must includedata.customer.billToStateplus just one of the following parameters:card.firstSix,card.pan,tokenex.token, ortokenex.firstSix.