Create a payout instruction set
POST {{baseUrl}}/payments/payout
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 CSM@fireblocks.com.
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:
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Idempotency-Key
|
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. | |
Content-Type
|
string | ||
Accept
|
string |
RESPONSES
status OK
| {
"payoutId": "<string>",
"createdAt": "<number>",
"state": "TRANSLATED",
"status": "REGISTERED",
"paymentAccount": {
"id": "<string>",
"type": "FIAT_ACCOUNT"
},
"instructionSet": [
{
"amount": {
"amount": "<string>",
"assetId": "<string>"
},
"payeeAccount": {
"id": "<string>",
"type": "EXCHANGE_ACCOUNT"
},
"state": "NOT_STARTED",
"transactions": [
{
"id": "<string>",
"state": "PENDING_3RD_PARTY",
"timestamp": "<number>",
"instructionId": "<string>"
},
{
"id": "<string>",
"state": "PENDING_AML_SCREENING",
"timestamp": "<number>",
"instructionId": "<string>"
}
],
"id": "<string>"
},
{
"amount": {
"amount" Curl curl -X POST 'https://api.fireblocks.io/v1/payments/payout' -H 'Idempotency-Key: <string>' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"paymentAccount":{"id":"\u003cstring\u003e","type":"EXCHANGE_ACCOUNT"},"instructionSet":[{"amount":{"amount":"\u003cstring\u003e","assetId":"\u003cstring\u003e"},"payeeAccount":{"id":"\u003cstring\u003e","type":"EXTERNAL_WALLET"},"id":"\u003cstring\u003e"},{"amount":{"amount":"\u003cstring\u003e","assetId":"\u003cstring\u003e"},"payeeAccount":{"id":"\u003cstring\u003e","type":"NETWORK_CONNECTION"},"id":"\u003cstring\u003e"}]}' ENDPOINTS |