FIfireblocks
Payments - Payout

Get the status of 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 CSM@fireblocks.com. Endpoint Permission: Admin, Non-Signing Admin.

get/payments/payout/{payoutId}

Request

Path parameters

payoutIdstring required

the payout id received from the creation of the payout instruction set

Response

Returns the current status of the payout instruction set, including the status of each payout instruction and the transactions created in the process.

payoutIdstring required
createdAtnumber required
state'CREATED' | 'FILE_FOUND' | 'REQUESTED' | 'TRANSLATED' | 'PROCESSING' | 'SUBMITTED' | 'FINALIZED' | 'INSUFFICIENT_BALANCE' | 'FAILED' required
  • CREATED - payout instruction set created with all its details
  • FILE_FOUND - new file found in the FTP
  • REQUESTED - payout requested with all its details
  • TRANSLATED - payout instruction account IDs identified and translated
  • PROCESSING - payout instruction set executed and is processing
  • SUBMITTED - transactions submitted for payout instructions
  • FINALIZED - payout finished processing, all transactions processed successfully
  • INSUFFICIENT_BALANCE - insufficient balance in the payment account (can be a temporary state)
  • FAILED - one or more of the payout instructions failed
status'REGISTERED' | 'VERIFYING' | 'IN_PROGRESS' | 'DONE' | 'INSUFFICIENT_BALANCE' | 'FAILED' required
  • REQUESTED payout requested with all its details
  • VERIFIED payout instruction set details were verified
  • PROCESSING payout instruction set executed and is processing
  • FINALIZED payout done (all payout instructions completed successfully)
  • INSUFFICIENT_BALANCE insufficient balance in the payment account (can be a temporary state)
  • FAILED one or more of the payout instructions failed
reasonOfFailurestring
  • INSUFFICIENT_BALANCE
  • SOURCE_TRANSLATION
  • SOURCE_NOT_UNIQUE
  • SOURCE_NOT_FOUND
  • SOURCE_TYPE_NOT_SUPPORTED
  • EMPTY_SOURCE
  • DESTINATION_TRANSLATION
  • DESTINATION_NOT_UNIQUE
  • DESTINATION_NOT_FOUND
  • EMPTY_DESTINATION
  • PARSING
  • UNKNOWN
  • FIREBLOCKS_CLIENT
  • TRANSACTION_SUBMISSION
initMethod'FILE' | 'API'
reportUrlstring

Changes

No recorded changes to this operation across all 1 revision of this API.