Create a payout

Request a payout during a workflow execution.

Path Params
string
required

Path parameter to specify the workflow code.

uuid
required

Identifier of the resource in Payrails.

Body Params
amount
object
required

The amount to payout in recipient account currency.

uuid

Unique identifier of the Payment Instrument that the customer selected for the Payment.

meta
object

Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our Meta Fields guide.

Headers
uuid
required

Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.

Responses

Language
Credentials
Bearer
JWT
Response
Choose an example:
application/json