Create a payout instruction set

Note: The reference content in this section documents the Payments
Engine endpoint. The Payments Engine endpoints include APIs available only
for customers with Payments Engine enabled on their accounts.

These endpoints are currently in beta and might be subject to
changes.

If you want to learn more about Fireblocks Payments Engine, please
contact your Fireblocks Customer Success Manager or email
[email protected].

Create a payout instruction set.

A payout instruction set is a set of instructions for distributing payments
from a single payment account to a list of payee accounts.

The instruction set defines:

  • the payment account and its account type (vault, exchange, or fiat).
  • the account type (vault account, exchange account, whitelisted address,
    network connection, fiat account, or merchant account), the amount, and the
    asset of payment for each payee account.

Learn more about Fireblocks Payments - Payouts in the following
guide.

Endpoint Permission: Admin, Non-Signing Admin.

Body Params
paymentAccount
object
required
instructionSet
array of objects
required
instructionSet*
Headers
string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json