Documentation
Log In
Documentation

This endpoint returns a list of all finalized operations. Offers various filtering options.

JSON Array of Query Params

balancesId
array of strings

Array of wallets UUID to get an informations about.

balanceCurrencies
array of strings

Array of currencies.

fromTime
date-time

Unix timestamp from which the operations start.

toTime
date-time

Unix timestamp for which they end.

fromValue
float

Minimal transaction price to be filtred.

toValue
float

Maximal transaction price to be filtred.

balanceTypes
string

Type of wallet: fiat / crypto.

types
array of strings

Array of operation types. The whole operations list is available below.

sort
array of objects

Array of sorting parameters: by - to which value sort by, order - type of sort: ASC/DESC.

📘

All parameters must be sent by query in JSON format.

Response details

KeyTypeDescription
itemsarray
historyIdUUIDOperation UUID.
balancearrayArray of data about balance.
* id UUIDWallet UUID.
* currencystringCryptocurrency symbol.
* type stringWallet type: crypto / fiat.
* userId UUIDUser UUID.
* name stringName of the wallet.
detailIdUUIDOperation detail UUID (if is available).
timeUNIX timestampTime of operation creation.
typestringOperation type. The whole operations list is available below.
valuedecimalOperation value.
fundsBefore / fundsAfter / changearrayArray of parameters for wallet.
* total decimalTotal amount of funds.
* avalilable decimalAvailable amount of funds.
* locked decimalLocked amount of funds.
hasNextPagebooleanTrue if there is a next page to fetch
fetchedRowsintegerNumber of received records.
limitintegerLimit of records per page.
settingsarrayArray of received parameters to filter.
* balancesId arrayArray of balances UUID.
* balanceCurrencies arrayArray of currencies.
* balanceTypes arrayArray of balance types.
* engine stringWallet application: BITBAY / BITBAYPAY.
* fromTime Unix TimestampFrom what time get operations.
* toTime Unix TimestampTo what time get operations.
* absValue booleanDo apply absolute values filter
to fromValue and toValue parameters.
* fromValue decimalMinimal value of cryptocurrency.
* toValue decimalMinimal value of cryptocurrency.
* sort arrayArray of parameters to sort: by - field to sort by, order - type of sort: ASC/DESC.
* limit integerLimit of records for page.
* types arrayArray types of operations. Available below.

Operation types

KeyDescription
CREATE_BALANCECreate new wallet balance.
ADD_FUNDSDeposit on balance.
SUBTRACT_FUNDSWithdrawal from balance.
TRANSFER_FROMInternal transfer from balance.
TRANSFER_TOInternal transfer to balance.
TRANSACTION_COMMISSION_OUTCOMEFee charge for transaction.
TRANSACTION_PRE_LOCKINGBlocking funds on balance.
LOCK_FUNDSBlocking funds on balance.
ADMIN_LOCK_FUNDSBlocking funds on balance by admin.
UNLOCK_FUNDSUnblocking funds.
ADMIN_UNLOCK_FUNDSUnblocking funds by admin.
TRANSACTION_POST_INCOMEReceived funds from transaction.
TRANSACTION_POST_OUTCOMETaken funds from transaction.
ADMIN_ADD_FUNDSCorrection: received funds from admin.
ADMIN_SUBTRACT_FUNDSCorrection: taken funds by admin.
TRANSACTION_OFFER_ABORTED_RETURNRefund funds for order cancel.
AFFILIATE_FUNDS_TRANSFERReceived funds from affiliate program.
PAY_WITHDRAW_LOCKLocking funds before withdrawal: {name}
TRANSACTION_OFFER_COMPLETED_RETURNCancelling order below minimum value.
TRANSACTION_FAIL_UNLOCKINGRefund after failed make order try.
WITHDRAWAL_LOCK_FUNDSLocking funds before withdrawal.
WITHDRAWAL_UNLOCK_FUNDSUnlocking funds.
WITHDRAWAL_SUBTRACT_FUNDSFunds withdrawal.
FUNDS_MIGRATIONFunds migration.
TRANSACTION_COMMISSION_RETURNFee refund.
ADD_FUNDS_ERROR_REFUNDCorrection refund.
OLD_ADDRESS_CRYPTO_DEPOSITTrying to deposit to old crypto address.
FIAT_DEPOSIT_MIGRATEDFiat funds migration.
ADMIN_WITHDRAWAL_REFUNDFunds refund after cancelling withdrawal.
SUBTRACT_FUNDS_ERROR_CORRECTIONFunds correction.
ADD_FUNDS_COMPENSATIONFunds compensation.
BITCOIN_GOLD_FORKFunds received because of fork.
BALANCE_DEPOSIT_CORRECTIONDeposit correction.
WITHDRAWAL_CUSTOM_COMMISSIONNetwork withdrawal fee for.

Deprecated operations related with cards which are unavailable right now

Key
CARD_ADMISSION
CARD_ORDER
INCOME
OUTCOME
LOCK_CARD_ADMISSION
UNLOCK_CARD_ADMISSION
SUBTRACT_CARD_ADMISSION
LOCK_ORDER_COMISSION
SUBTRACT_CARD_ORDER
UNLOCK_CARD_ORDER
Language
Credentials