Adds a surcharge to a payment, when appropriate to do so. Surcharing is regulated by Visa and can only be enabled when your processing provider has permitted it.

Prerequisites

In order to use this action the merchant account must have a product of the following type enabled:

payments

Related Actions

This action pairs well with the following actions:

payment

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 Surcharge action to a business process or blueprint.

{
    "type": "surcharge",
    "union": 0,
    "features": {
        "percentage": 0.02
    }
}