API Reference

Description

In IBEXHub, every time funds are sent or received, a transaction object is created.

The ID of the transaction can be used to get information about it, such as its status.

We recommend storing the transactionId every time funds are sent or received.

Transaction Fields

FieldTypeDescription
idstringThe id of the transaction. This id can be used to lookup details via the GET /transaction/{transaction_id} endpoint (here).
createdAtstring format: "2022-11-14T14:59:32.930083Z"The creation date of the transaction in UTC time.
settledAtstring format: "2022-11-14T14:59:32.930083Z"The date that the transaction was payed.
accountIdstringThe id of the account.
currencyIdintThe id of the currency of the transaction (equal to the currencyId of the account).
amountfloatThe amount of the transaction denominated in the currency of the transaction.
networkFeefloatThe network fees, denominated in the currency of the transaction.
transactionTypeIdintThe id of the type of transaction

Transaction Types

IDNameDescription
1Lightning receiveThis transaction has been received on the lightning network.
2Lightning sendThis transaction has been payed on the lightning network.
3On-Chain receiveThis transaction has been received On-Chain.
4On-Chain sendThis transaction has been sent On-Chain.

Note: Currently, there is a predefined send limit in place for security precautions, which can be adjusted based on your specific needs. To explore options for increasing this limit or for more detailed information, please reach out to our support team at [email protected].