Adds a convenience fee to a payment in addition to the amount requested.

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)

Always union to payment action.

Macro level details for how union attribute behaves can be found within the Union documentation.

Features (required)

Name	Type	Description	Rules
amount	number	(required) Amount in cents. Examples: 10.

Context

Name	Type	Description	Rules
types	array	If `types` is set to `ACH` or `CreditCard`, the convenience fee applies only when that specific payment method is used to make a payment. Examples: ["CreditCard"].	Possible values: `ACH`, `CreditCard`.

Example

Below is an example payload for adding an Convenience-fee action to a business process or blueprint.

{
    "type": "convenience-fee",
    "union": 1,
    "features": {
        "amount": 10
    },
    "context": {
        "types": [
            "CreditCard"
        ]
    }
}