Fireblocks API Documentation
Get the status of a payout instruction set
GET {{baseUrl}}/payments/payout/:payoutId
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.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
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": "<string>",
"assetId": "<string>"
},
"payeeAccount": {
"id": "<string>",
"type": "EXCHANGE_ACCOUNT"
},
"state": "NOT_STARTED",
"transactions": [
{
"id": "<string>",
"state": "PENDING_AML_SCREENING",
"timestamp": "<number>",
"instructionId": "<string>"
},
{
"id": "<string>",
"state": "PENDING",
"timestamp": "<number>",
"instructionId": "<string>"
}
],
"id": "<string>"
}
],
"reasonOfFailure": "<string>",
"initMethod": "API",
"reportUrl": "<string>"
} |
Curl
curl -X GET 'https://api.fireblocks.io/v1/payments/payout/:payoutId' -H 'Accept: application/json'
ENDPOINTS