Payout

This document outlines a streamlined payout process that enables customers to receive funds directly to their selected payment method. By integrating with a wide range of payout providers and methods, alongside features designed to enhance user experience, this solution ensures a seamless and efficient fund disbursement process. This best-in-class approach guarantees reliable and timely payouts while maintaining flexibility for both merchants and customers.

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

payouts

This action pairs well with the following actions.

State

The transaction record recording the pay out to the customer.

Union

If unioned then the transaction to pay out to the customer will not initiate until the unioned action is resolved.

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

Features

Name	Type	Description	Rules
description	string	(required) A short description of the payout. Used in messaging so a concise and direct is best. For rich descriptions use a markdown action. Examples: "Cash Back Reward", "Insurance Payout Claim 123".	MaxLength: 50 MinLength: 3
reference	string	Reference value to put on the transaction payout for reconciliation down stream.. Examples: "REF123".	MaxLength: 256
currency	string	Currency of the payout (ISO 3 Digit Currency Code). Examples: "USD".	MaxLength: 3 Pattern: ^([A-Z]*)$
noDisplay	boolean	Hides the breakdown of the amount. Examples: true.

Context (required)

Name	Type	Description	Rules
amount	number	(required) Amount in cents to pay out to the customer. Examples: 100.
reference	string	Reference value for this payout transaction, used for reconciliation in downstream systems/processes. If specified in context, it cannot be specified in features. When placed within context, it will not be shown to the user. Examples: "REF123".	MaxLength: 256
metadata	object	A merchant can add extra details such as notes, references etc, which are also pass to the transaction detail. Examples: `{"key1":"value1","key2":"value2"}`.

Example

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

{
    "type": "payout",
    "union": 0,
    "context": {
        "amount": 100,
        "currency": "USD",
        "reference": "REF123"
    },
    "features": {
        "description": "Some description",
        "reference": "REF123",
        "noDisplay": true
    }
}