API Reference

ENUM description

In this section you will find all actual ENUM's used in Calypso API.

Currency

All possible crypto currencies:

ENUM valueDescription
BTCBitcoin
XDGDoge Coin
ETHEthereum
MATICMatic (Polygon)
USDTTether USD (ERC-20)
FRAXFrax (ERC-20)
DAIDAI (ERC-20)
USDCUSD Coin (ERC-20)
TRXTronix
USDT_TRXTether USD (TRC-20)
USDC_TRXUSD Coin (TRC-20)
BNBBinance Coin
USDT_BSCTether USD (BEP-20)
USDT_MATICTether USD (Matic)
LTCLitecoin

All possible fiat currencies:

ENUM valueDescription
USDDollar USA
EUREuro

Blockchain

ENUM value
BITCOIN
ETHEREUM
BINANCE_SMART_CHAIN
TRON
DOGECOIN
POLYGON
LITECOIN

Invoice state

ENUM valueDescription
PENDING_PAYMENT• A new unpaid invoice.
• Client has transferred funds, but the funds has not yet been credited to the account.
MEM_POOL_FOUNDIncoming transaction to invoice wallet is found in blockchain mempool.
PAIDInvoice is paid.
PENDING_INTERVENTION• Intervention from the merchant is awaited.
• Client transferred insufficient amount.
• Client has transferred an amount exceeding an invoice amount.
• Funds were transferred from different client accounts.
COMPLETEDFunds are transferred to merchant wallet.
ARCHIVEDInvoice is deleted by merchant.
PENDING_COMPLIANCE_CHECKInvoice is being reviewed by compliance
DECLINEDInvoice has been suspended due to compliance policy

Invoice type

ENUM valueDescription
SINGLEallows to receive one payment in crypto-currency
SINGLE_FIATallows to receive one payment in crypto-currency but amount to pay is set in fiat currency
BOUNDallows to receive payment in crypto-currency with any amount but not less than configured while creation
UNLIMITEDallows to receive unlimited amount of payments in crypto-currency
UNLIMITED_LINKEDallows to receive unlimited amount of payments in crypto-currency but only from one client using payment widget

Payment widget type

ENUM valueDescription
SINGLE_FIATCreates SINGLE_FIAT invoices for one payment in fiat currency
UNLIMITED_LINKEDCreates UNLIMITED_LINKED invoices for many payments in crypto-currency

Payment widget state

ENUM valueDescription
IN_PROGRESSThe payment widget has been created and is active
COMPLETEDThe invoice created from payment widget has been payed
ARCHIVEDThe payment widget has expired and was automatically archived

Payout state

ENUM valueDescription
CREATION_IN_PROGRESSPayout started creation (only for mass payouts)
PENDING_CONFIRMATIONA payout is created via UI and is awaiting confirmation from other process participants.
CONFIRMED• A payout is created via UI and confirmed by other process participants.
• A payout created via API is automatically created with this status.
IN_PROGRESS• Transaction for a payout is created and is awaiting to be sent to the network.
•Transaction for a payout is sent to the network to be sent to a block and is awaiting confirmation from nodes.
COMPLETEDFunds are successfully credited to destination wallet.
FAILEDAn error occurred when sending funds. There can be many reasons of the error. You may follow these remediation steps:
1. Wait a while and create a new similar payout.
2. Contact our technical support.
CANCELEDA payout has been canceled by merchant.

Payout withdrawal state

ENUM value
DRAFT
IN_PROGRESS
COMPLETED
REPLACED
FAILED
CANCELED

Withdrawal error state

ENUM valueDescription
SUCCESSThe error was resolved
NO_PERMISSIONNo permission for operation
NOT_ENOUGH_FUNDSNot enough funds for operation processing
EXCEEDING_LIMITLimits for operation was exceeded

notificationServiceTypes

ENUM value
PAYOUT
INVOICE

sort

ENUM value
ASC
DESC