Limited invoice report

Column name in report	Description
invoiceId	System id of the invoice.
invoiceAddress	Crypto address of the invoice for deposit.
invoiceAmount	Amount of the invoice. Merchant receives this amount of money.
amountToPay	Amount the client need to pay for the invoice. It can be bigger than invoice amount if transaction fee for transfer from invoice address to merchant address is included (field upperCommission = true in the invoice creation request).
blockchainTransactionFee	Transaction fee for transfer from invoice address to merchant address.
tokenTransactionFee	Transaction fee for transfer of base currency from merchant wallet to invoice wallet in order to transfer tokens from invoice address to merchant wallet (only for invoices in tokens).
currency	Currency of the invoice.
invoiceState	Status of the invoice processing [MEM_POOL_FOUND, PENDING_PAYMENT, PAID, COMPLETED, PENDING_INTERVENTION, CANCEL, ARCHIVED]. See description of states on Limited Invoice
description	Description of the invoice.
createdDate	Time of invoice creation.
idempotencyKey	The id in the uuid format that can be generated by merchant while creating the invoice. It forms link to the invoice.
type	Type of the invoice. SINGLE - allows to receive one payment in crypto-currency. SINGLE_FIAT - allows to receive one payment in crypto-currency but amount to pay is set in fiat currency.
expirationDate	Timestamp of invoice expiration moment.
hotWalletAddress	Address of the merchant wallet.
amountInFiat	Amount of the invoice if invoice was created with type SINGLE_FIAT.
fiatCurrency	Fiat currency of the invoice if invoice was created with type SINGLE_FIAT.
invoiceTransactionId	System id of the deposit transaction to invoice.
incomingAmount	Amount of the deposit transaction.
incomingCurrency	Currency of the deposit transaction.
incomingTransactionHash	Hash of the deposit transaction in blockchain.
addressFrom	Wallet address of deposit transaction sender.
incomingTransactionDate	Date and time of the deposit transaction.
invoicePaymentId	System id of transaction from invoice wallet to merchant wallet (withdrawal).
invoicePaymentState	State of the withdrawal [ INIT, REQUEST_FOUNDS_FOR_FEE, REQUEST_FOUNDS_FOR_FEE_FAILED, MAKE_WITHDRAWAL, PENDING_WITHDRAWAL_COMPLETED, WITHDRAWAL_FAILED, WITHDRAWAL_COMPLETED, CANCELED ]
notEnoughFundsForTokenFeeAmount	Amount of money that needed for processing withdrawal. More than 0 if there is not enough money on merchant wallet in base currency.
transactionComments	Comments for this invoice.
serviceFee	Service fee for the operation.
serviceFeeCurrency	Currency of the service fee.
feeType	System name of operation for which service fee was charged.
externalId	Merchant ID that can be assigned to invoice or several invoices in string format.

Unlimited invoice report

Column name in report	Description
invoiceId	System id of the invoice.
invoiceAddress	Crypto address of the invoice for deposit.
currency	Currency of the invoice.
invoiceState	Status of the invoice processing [PENDING_PAYMENT, ARCHIVED]. See description of states on Unlimited Invoice
description	Description of the invoice.
createdDate	Time of invoice creation.
idempotencyKey	The id in the uuid format that can be generated by merchant while creating the invoice. It forms link to the invoice.
expirationDate	Timestamp of invoice expiration moment.
hotWalletAddress	Address of the merchant wallet.
invoiceTransactionIds	System ids of the deposit transactions to invoice for the period.
incomingAmountForPeriod	Amount of the deposit transactions for the period.
incomingTransactionHashes	Hashes of the deposit transactions in blockchain for the period.
addressesFrom	Wallet addresses of deposit transaction senders for all transactions for the period.
withdrawalAmountForPeriod	Amount that was withdrawn from unlimited invoice for the period.
blockchainFeeForPeriod	Transaction fee for transfers from invoice address to merchant address for the period.
tokenFeeForPeriod	Transaction fee for transfers of base currency from merchant wallet to invoice wallet in order to transfer tokens from invoice address to merchant wallet (only for invoices in tokens) for the period.
transactionComments	Comments for this invoice.
serviceFee	Service fee for the operation.
serviceFeeCurrency	Currency of the service fee.
feeType	System name of operation for which service fee was charged.
amountInInvoiceWallet	Balance of the invoice wallet on the moment of report creation.
externalId	Merchant ID that can be assigned to invoice or several invoices in string format.

Payout report

Column name in report	Description
payoutId	System ID of the payout.
numberOfConfirmations	Number of confirmations by users that are needed for payout sending.
payoutState	Status of the payout. [ PENDING_CONFIRMATION, CONFIRMED, IN_PROGRESS, COMPLETED, FAILED, CANCELED ]. See description of states on Single Payout
cancellationMessage	Message that was sent when payout was cancelled.
cancellationAuthor	First and last name of user who cancelled the payout.
payoutCreatedDate	Date and time of payout creation.
payoutComment	Comment of the author of payout.
payoutType	System type of payout.
executionDate	Time and date of the payout execution.
idempotencyKey	The ID in the uuid format that can be generated by merchant while creating the payout.
withdrawalId	System ID of the payout transaction.
nonce	Nonce in blockchain transaction.
hash	Hash of the blockchain transaction.
networkFeeCurrency	Currency of the network transaction fee.
networkFee	Network transaction fee that is charged to users when performing crypto transactions.
networkFeeRatio	Network fee coefficient.
withdrawalState	State of the system payout transaction. The same as payout state.
payoutCurrency	The currency of the payout.
amount	Amount of the payout.
depositAddress	Wallet address of the payout receiver.
withdrawalAddress	Wallet address of the payout sender.
transactionComments	Comments for this invoice.
serviceFee	Service fee for the operation.
serviceFeeCurrency	Currency of the service fee.
feeType	System name of operation for which service fee was charged.
amountInInvoiceWallet	Balance of the invoice wallet on the moment of report creation.
externalId	Merchant ID that can be assigned to invoice or several invoices in string format.
clientId	System ID of the client.
clientName	Client name of the receiver of payout.

Mass payout report

Column name in report	Description
payoutId	System ID of the payout.
payoutState	Status of the payout. [ PENDING_CONFIRMATION, CONFIRMED, IN_PROGRESS, COMPLETED, FAILED, CANCELED ]. See description of states on Mass payout
cancellationMessage	Message that was sent when payout was cancelled.
cancellationAuthor	First and last name of user who cancelled the payout.
payoutCreatedDate	Date and time of payout creation.
payoutComment	Comment of the author of payout.
executionDate	Time and date of the payout execution.
idempotencyKey	The ID in the uuid format that can be generated by merchant while creating the payout.
totalPayoutAmount	Total amount of the mass payout (to all addresses).
totalNetworkFee	Total network fee for all transactions.
withdrawalId	System ID of the payout transaction.
nonce	Nonce in blockchain transaction.
hash	Hash of the blockchain transaction.
networkFeeCurrency	Currency of the network transaction fee.
networkFee	Network transaction fee that is charged to users when performing crypto transactions.
networkFeeRatio	Network fee coefficient.
withdrawalState	State of the system payout transaction. The same as payout state.
payoutCurrency	The currency of the payout.
externalId	Merchant ID that can be assigned to the transaction in mass payout or several transactions in string format.
amount	Amount of the transaction.
depositAddress	Wallet address of the payout receiver.
withdrawalAddress	Wallet address of the payout sender.
withdrawalComment	Comment for the mass payout transaction (when created).
transactionComments	Comments for this transaction.
totalServiceFeeForPayout	Service fee for the operation.
totalServiceFeeCurrencyForPayout	Currency of the service fee.

Exchange report

Column name in report	Description
id	System ID of the exchange.
sourceAddress	Wallet address money were sent from.
sourceCurrency	Currency that was exchanged.
sourceAmount	Amount of money that was exchanged.
destinationAddress	Wallet address of the exchange service money were sent to.
destinationCurrency	Currency that was received after exchange.
destinationAmount	Amount of money that was received after exchange.
state	Status of the exchange [ CREATED, PAYOUT_PENDING, PAYOUT_COMPLETED, EXCHANGE_PENDING, COMPLETED, CANCELED, FAILED ] CREATED - exchange has been created. PAYOUT_PENDING - money are sending to exchange service. PAYOUT_COMPLETED - money are sent to exchange service. EXCHANGE_PENDING - waiting for money from exchange service. COMPLETED - the exchange was finished successfully. CANCELED - the exchange was cancelled. FAILED - the exchange was failed due to the system error.
payinHash	Blockchain hash of the transaction to the exchange service.
payoutHash	Blockchain hash of the transaction from the exchange service.
createdDate	Date and time of the exchange creation.
modifiedDate	Date and time of the exchange updating.
networkFee	Network fee in destination currency that service provider subtracted from the exchange amount.
payinTransactionComments	Comments for the outgoing transaction.
payoutTransactionComment	Comments for the incoming transaction.
serviceFee	Service fee for the operation.
serviceFeeCurrency	Currency of the service fee.

Calypso fee report

Column name in report	Description
currency	Currency of fee withdrawal.
type	Type of fee withdrawal. In the moment there is only one type - MUTUAL_SETTLEMENT.
state	The status of fee withdrawal [ NEW, PENDING, CANCEL, DONE ] NEW - the fee withdrawal was created. PENDING - the fee withdrawal is in progress. CANCEL - the fee withdrawal was cancelled. DONE - the fee withdrawal was completed successfully.
amount	Amount of fee withdrawal.
createdDate	Date and time of fee withdrawal creation.

Top-up report

Column name in report	Description
amount	Amount of the top-up transaction.
currency	Currency of the top-up transaction.
transactionHash	Hash of the top-up transaction.
blockDate	Date of mining transaction in blockchain.
createdDate	Date of receiving transaction in Calypso.
senderAddress	Wallet address of transaction sender.
receiverAddress	Wallet address of transaction receiver.
transactionComments	Comments for this transaction.
serviceFee	Service fee for the operation.
serviceFeeCurrency	Currency of the service fee.