Surcharge fee on a payment.
Adds a surcharge to a payment, when appropriate to do so. Surcharging is regulated by Visa and can only be enabled when your processing provider has permitted it.
In order to use this action the merchant account must have a product of the following type enabled.
This action pairs well with the following actions.
Union (required)
Target a payment action.
Macro level details for how union attribute behaves can be found within the Union documentation.
Features (required)
| Name | Type | Description | Rules |
|---|---|---|---|
| percentage | number | (required) Surcharge percentage to be applied when a qualifying payment-method permits. Examples: 0.02. | Maximum: 0.03 |
Example
Below is an example payload for adding an action to a business process or blueprint.
{
"type": "surcharge",
"union": 0,
"features": {
"percentage": 0.02
}
}