In this section you will find all actual ENUM's used in Paykilla API.
Currency
All possible crypto currencies:
| ENUM value | Description |
|---|---|
| BTC | Bitcoin |
| LTC | Litecoin |
| XDG | Dogecoin |
| ETH | Ethereum |
| USDT | Tether USD (ERC-20) |
| USDC | USD Coin (ERC-20) |
| FRAX | Frax (ERC-20) |
| DAI | DAI (ERC-20) |
| POL (prev. MATIC) | Polygon |
| USDT_POL | Tether USD (Polygon) |
| USDC_POL | USD Coin (Polygon) |
| TRX | Tron |
| USDT_TRX | Tether USD (TRC-20) |
| BNB | Binance Coin |
| USDT_BSC | Tether USD (BEP-20) |
| TON | Toncoin |
| USDT_TON | Tether USD (TON) |
All possible fiat currencies:
| ENUM value | Description |
|---|---|
| USD | Dollar USA |
| EUR | Euro |
| UAH | Ukrainian hryvnia |
| KZT | Kazakhstani tenge |
| RUB | Russian ruble |
Blockchain
| ENUM value |
|---|
| BITCOIN |
| ETHEREUM |
| BINANCE_SMART_CHAIN |
| TRON |
| DOGECOIN |
| POLYGON |
| LITECOIN |
| TONCOIN |
Invoice state
ENUM value | Description |
|---|---|
PENDING_PAYMENT | • A new unpaid invoice. • Client has transferred funds, but the funds has not yet been credited to the account. |
MEM_POOL_FOUND | Incoming transaction to invoice wallet is found in blockchain mempool. |
PAID | Invoice 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. |
COMPLETED | Funds are transferred to merchant wallet. |
ARCHIVED | Invoice is deleted by merchant. |
PENDING_COMPLIANCE_CHECK | Invoice is being reviewed by compliance |
DECLINED | Invoice has been suspended due to compliance policy |
Invoice type
| ENUM value | Description |
|---|---|
| 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 |
| BOUND | allows to receive payment in crypto-currency with any amount but not less than configured while creation |
| UNLIMITED | allows to receive unlimited amount of payments in crypto-currency |
| UNLIMITED_LINKED | allows to receive unlimited amount of payments in crypto-currency but only from one client using payment widget |
Payment widget type
| ENUM value | Description |
|---|---|
| SINGLE_FIAT | Creates SINGLE_FIAT invoices for one payment in fiat currency |
| UNLIMITED_LINKED | Creates UNLIMITED_LINKED invoices for many payments in crypto-currency |
Payment widget state
| ENUM value | Description |
|---|---|
| IN_PROGRESS | The payment widget has been created and is active |
| COMPLETED | The invoice created from payment widget has been payed |
| ARCHIVED | The payment widget has expired and was automatically archived |
Payout state
ENUM value | Description |
|---|---|
CREATION_IN_PROGRESS | Payout started creation (only for mass payouts) |
PENDING_CONFIRMATION | A 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. |
COMPLETED | Funds are successfully credited to destination wallet. |
FAILED | An error occurred when sending funds. There can be many reasons of the error. You may follow these remediation steps:
|
CANCELED | A payout has been canceled by merchant. |
Payout withdrawal state
| ENUM value |
|---|
| DRAFT |
| IN_PROGRESS |
| COMPLETED |
| REPLACED |
| FAILED |
| CANCELED |
Withdrawal error state
| ENUM value | Description |
|---|---|
| SUCCESS | The error was resolved |
| NO_PERMISSION | No permission for operation |
| NOT_ENOUGH_FUNDS | Not enough funds for operation processing |
| EXCEEDING_LIMIT | Limits for operation was exceeded |
notificationServiceTypes
| ENUM value |
|---|
| PAYOUT |
| INVOICE |
sort
| ENUM value |
|---|
| ASC |
| DESC |