Service-fee

Adds a service fee to a payment in addition to the amount requested. Service fees are designed to be used by merchants in the government and education MCCs.

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.

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

Features (required)

Name	Type	Description	Rules
amount	number	Amount in cents. Features should include either an `amount` or a `percentage`, but not both. Examples: 10.
percentage	number	The percentage will be applied to calculate the service-fee based on the actual payment amount. Features should include either an `amount` or a `percentage`, but not both. Examples: 0.02.

Context (required)

Name	Type	Description	Rules
types	array	If `types` is set to `ACH` or `CreditCard`, the service 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 Service-fee action to a business process or blueprint.

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