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.
For the customer's payment information, you must include just one of the following parameters:
card.firstSix
card.pan
tokenex.token
tokenex.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.
At a minimum, you must include
data.customer.billToState
plus one of the following parameters:card.firstSix
,card.pan
,tokenex.token
, ortokenex.firstSix
.