Calypso | Docs

Overview

Calypso is a technical platform for accepting payments and making payout in cryptocurrency. It enables a quick start of sales for businesses by completing easy integration and setup.

Products:

• Invoice is a commercial document issued by a merchant to a client relating to a sale transaction. It includes provided products and services, their quantities and agreed costs.
• Payment Link is a link to a one-time invoice. Payment links can be sent by email, messenger or in any other way.
• Unlimited invoice is an invoice without a fixed amount. Payments to the invoice of this type can be accepted in unlimited quantities for any amount for an unlimited time. Funds are transferred to the hot wallet if necessary.
• Payout is a payment of a reward, dividend, insurance compensation, etc. (i.e. you may need to pay dividends to partners). Withdrawal of funds is performed by Payment Processor.
• Mass Payout is a method of paying multiple recipients simultaneously. Since mass payouts are submitted online, they are processed instantly which helps organizations to save time, money and resources.

The purpose and target audience of this documentation

This documentation is targeted at:

• Developers using Calypso
• Merchants needing to integrate their system with the Calypso platform using the API for accepting payments
• Merchants needing payment API documentation and other technical documentation

Need help?

If you did not find the required information in this documentation, please contact us to get help.

Integration

Invoice

Overview

What is a cryptocurrency invoice?

In common interpretation, invoice is a commercial document that includes products and services provided by a merchant to a client, product quantities and its agreed costs.

Cryptocurrency invoice is also a document used for settlement between partners. The only difference from a regular invoice is that a cryptocurrency one is issued in cryptocurrency.

If you are going to accept payments in cryptocurrency, invoices must include the following data:

• Exact amount to be paid in fiat currency or in cryptocurrency
• Exact wallet address the client is going to transfer money

After sending an invoice, a client will only have to pay. You can get payment information both in the Calypso web interface and through the API.

Terminology and entities

Merchant is a participant of technical and financial interaction who provides goods and services, issues invoices and has the access to withdraw the funds.

Features:

• Add a payment form (payment widget) on the site
• Issue an invoice for payment of goods and send it directly to the client
• Pay using the Payment Link
• Monitor receipts
• Withdraw funds in fiat currency to a card, as a bank transfer, etc.

Client (buyer) is a person purchasing products/services.

Features:

• Pay for a product/service in cryptocurrency.
• Get a confirmation that purchase is completed and money are received by a merchant
• Resolve disputed issues

Invoice wallet is a unique wallet designed to receive payment from one end customer. It is generated when creating an invoice.

Features:

• Accept payments
• Identify a payment and confirm a user made this payment

API

Calypso enables external developers to programmatically interact with the service. One way to do this is to use Calypso APIs.

API access key

The API access key is used to authenticate operations required for making payments and payouts.

If passing incorrect API key in requests to Calypso API, the platform returns an authentication error (HTTP/401).

Please do not share your Calypso API key with anyone!

More details on API access keys are available on the Invoice API page.

Payment by invoice

To transfer funds for provided products/services to a merchant account, an invoice must be paid.

To make a payment from the Calypso payment form, there are the following steps to be performed:

• Send API request to create an invoice (POST https://public-gateway.calypso.finance/api/v1/pub/invoice/create)
• Redirect a browser of a user to the link of the following format: https://ui.calypso.finance/invoices/{idempotencyKey}

Example of the create invoice request:

{
  "nonce": 13292792792,
  "request": {
    "amount": 1,
    "currency": "ETH",
    "description": "invoice for client 1",
    "hotWalletAddress": "0x3c1f886e5edf475980bea31c5e05d2e457b7e752",
    "idempotencyKey": "c15b5eb6-e01d-4161-9dfa-a1193ad0371e",
    "type": "SINGLE"
  }
}

Further steps to complete payment are performed by a user in the payment form.

If using a payment form designed on your side, interaction with the Calypso platform will look as shown in the scheme of information process interaction.

Invoice statuses

Diagram nodes indicate invoice statuses, arrows indicate processes a successful completion of which transfers an invoice from one status to another.

Withdrawal of funds

There are two scenarios of fund withdrawal:

1. If using invoices and payouts:
   1. Funds are credited to an invoice wallet and transferred to a payout hot wallet
   2. Payment can be made from a payout hot wallet
2. If using invoices separately from payouts:
   1. Funds are credited to an invoice wallet
   2. Funds are transferred to a Calypso hot wallet

Payment Link

What is a Payment Link?

Payment Link is a link to a one-time invoice. Payment links can be sent by email, messenger or in any other way.

How does it work?

• Creating a Payment Link.

You can use payment links to sell products/services,

launch subscriptions or collect donations.

• Share the link.

Send the Payment Link via email, messenger or in any other way.

• Invoice payment.

Use the Calypso UI, email or webhooks to be notified about successful payment and crediting of funds.

How to implement this via API?

Calypso API enables you with creating your own Payment links

To use Calypso Payment Link:

• Send API request to create an invoice (POST https://public-gateway.calypso.finance/api/v1/pub/invoice/create)
• Copy generated idempotencyKey from the response
• Redirect a browser of a user to the link of the following format: https://ui.calypso.finance/invoices/{idempotencyKey}

Further steps to complete payment are performed by a user in the payment form.

Below is a scheme demonstrating the listed steps.

Names of requests on the scheme indicate certain payment API methods.

To create your own payment links using Calypso:

• Send API request to create an invoice (POST https://public-gateway.calypso.finance/api/v1/pub/invoice/create)
• Copy generated invoice ID from the response
• Send API request POST https://public-gateway.calypso.finance/api/v1/pub/invoice and copy the data required for a user to complete this invoice payment
• Add copied data to a payment page and share a page link with a user

Further steps to complete payment are performed by a user in the payment form.

Below is a scheme demonstrating the listed steps.

Names of requests on the scheme indicate certain payment API methods.

Unlimited invoice (or client wallet)

Unlimited invoice is an invoice without a fixed amount. Payments to the invoice of this type can be accepted in unlimited quantities for any amount for an unlimited time. Funds are transferred to the hot wallet if necessary.

Example of the create unlimited invoice request:

{
  "nonce": 13292792793,
  "request": {
    "currency": "ETH",
    "description": "wallet of client 1",
    "hotWalletAddress": "0x3c1f886e5edf475980bea31c5e05d2e457b7e752",
    "idempotencyKey": "c15b5eb6-e01d-4161-9dfa-a1193ad0371e",
    "type": "UNLIMITED"
  }
}

Unlimited invoices can be used as clients wallets:

• Send API request to create an invoice with type "UNLIMITED" (POST https://public-gateway.calypso.finance/api/v1/pub/invoice/create)
• Provide the generated address and other data from the responce to the client
• Client can top up this wallet whenever he wants without any restrictions
• To withdrawal money from this client wallet you can send the request "Funds withdrawal" (POST https://public-gateway.calypso.finance/api/v1/pub/invoice/unlimited/withdrawal)

Payment Widget

Overview

Calypso provides users with the ability to generate widgets for invoice payment, which can be sent to the client or embedded on any web page. The widget indicates the amount to be paid, the available cryptocurrencies and description of payment. When paying the amount specified in the fiat currency, the exchange rate is fixed for 15 minutes (60 minutes for BTC) from the moment the invoice is created.

There are 3 types of payment widget depending on use case you need:

• A single payment for a product with a fixed price. The price customer needs to pay is defined by merchant in fiat currency.
• A single payment with a customer-defined price. The customer inputs the amount he wants to pay.
• Several payments with a customer-defined price. The customer can pay many times any amount of money for one invoice.

Features:

• Payment of an invoice without the need to create it specifically in the system
• Allows to specify the payment amount in a fiat currency or to give a posibility to define the payment amount to customer
• Exchange rate is fixed for 15 minutes
• Flexible parameter setting: the ability to choose a different cryptocurrency, full or reduced frame of widget, add a description
• The possibility to pay for one invoice unlimited number of time

How does it work?

There are two possible use cases for payment widget functionality.

Using a static payment widget link (recommended way):

1. The merchant specifies the currencies, description, expiration and other options and creates payment widget using Calypso APIs.
2. The merchant receives payment widget unique idempotencyKey in response and forms a static link using this value. The static link means that client will always be able to open earlier created payment widget to see its state.
3. A client follows the link and specifies the cryptocurrency he wants to pay with.
4. The client clicks the button "Proceed to payment".
5. Clicking the button triggers a call to Calypso Invoice API to create a new invoice.
6. When the invoice is created, the widget shows to the client a payment page.
7. The client completes the payment.
8. The client sees the message that transaction is processing.
9. Transaction is completed by a network.
10. The client sees the notification that payment is complete successfully.

Using a dynamic payment widget link (not recommended):

1. The merchant forms the link to create dynamic payment widget link. The dynamic link means that each time the client follows the link a new payment widget will be created with no way to see the state of previous payment.
2. A client follow the link and specify the cryptocurrency he wants to pay with.
3. The client clicks the button "Proceed to payment".
4. Clicking the button triggers a call to Calypso Invoice API to create a new invoice.
5. When the invoice is created, the widget shows to the client a payment page.
6. The client completes the payment.
7. The client sees the message that transaction is processing.
8. Transaction is completed by a network.
9. The client sees the notification that payment is complete successfully.

The examples of how you can use it in your service to accept different types of payments are provided on the page

How to create and use a static payment widget? (recommended)

To create a static payment widget, there are the following steps to be performed:

• Send an API request to create SINGLE_FIAT or UNLIMITED_LINKED payment widget (POST https://public-gateway.calypso.finance/api/v1/pub/payment-widget/single-fiat/create or POST https://public-gateway.calypso.finance/api/v1/pub/payment-widget/unlimited-linked/create)
• Form a payment widget static link for sharing it with client using earlier received idempotencyKey in response
• Send formed link to the client or embed in the web site.

Pay attention! Order the currencies will be transmitted to the request will be saved in the widget interface.

Example of the create SINGLE_FIAT payment widget request:

{
  "nonce": 13292792792,
  "request": {
    "description": "Payment Widget №1",
        "fiatAmount": 100,
        "fiatCurrency": "EUR",
        "hotWallets": [
            {
                "address": "reprehenderit ad",
                "cryptoCurrency": "USDC"
            },
            {
                "address": "tempor v",
                "cryptoCurrency": "USDT"
            },
            {
                "address": "tempor v",
                "cryptoCurrency": "USDT_TRX"
            }
        ],
        "upperCommission": true,
        "useLiquidity": false,
        "returnUrl": "https://google.com/",
        "supportUrl": "https://google.com/",
        "idempotencyKey": "e73ed7b1-a941-429e-9d59-315591bfeb68"
  }
}

Example of the create UNLIMITED_LINKED payment widget request:

{
  "nonce": 13292792792,
  "request": {
    "cryptoCurrencies": [
      "MATIC",
      "FRAX",
      "USDT",
      "USDT_TRX",
      "ETH",
      "BTC"
    ],
    "description": "Unlimited Linked Payment Widget 1",
    "upperCommission": true,
    "useLiquidity": false,
    "returnUrl": "https://google.com/",
    "supportUrl": "https://google.com/",
    "idempotencyKey": "3eea9433-d545-479f-95e1-0be86c7c8b59"
  }
}

To access the widget, a static link is formed. This link allows you to always get access to the widget to see it's current payment state.

The method of link generation is the same for both widget types (SINGLE_FIAT and UNLIMITED_LINKED):

https://ui.calypso.finance/pay?widgetKey={idempotencyKey}

Example of static payment widget embedded in the web site:

<!-- Put this code to the file index.html and open in browser to see how it works -->
<html>
<head>
    <title>Pay</title>
</head>
<body>
    <style>
        .button_1661340660317 {
            display: inline-block !important;
            text-decoration: none !important;
            background-color: #1e37ff !important;
            color: #ffffff !important;
            border: 3px solid #3967ff !important;
            border-radius: 5px !important;
            font-size: 16px !important;
            padding: 17px 50px !important;
            transition: all 1.6s ease !important;
        }
        .button_1661340660317:hover{
            text-decoration: none !important;
            background-color: #8294ff !important;
            color: #ffffff !important;
            border-color: #4e67ff !important;
        }
        </style>
        <a href="https://ui.calypso.finance/pay?widgetKey={*idempotencyKey*}" class="button_1661340660317" target="_blank">
            Pay fix amount in crypto
        </a>
</body>

</html>

Payment widget statuses

Diagram nodes indicate subscription statuses, arrows indicate processes of changing payment widget's state.

How to create and use a dynamic payment widget? (not recommended)

To create a dynamic payment widget, there are the following steps to be performed:

• Send an API request to create SINGLE_FIAT or UNLIMITED_LINKED payment widget (POST https://public-gateway.calypso.finance/api/v1/pub/reusable-key-service)
• Send link with payment widget and configured parameters to the client or embed it to the web-site where the payment is needed.

Example of dynamic payment widget embedded in the web site:

<!-- Put this code to the file index.html and open in browser to see how it works -->
<html>
<head>
    <title>Pay</title>
</head>
<body>
    <style>
        .button_1661340660317 {
            display: inline-block !important;
            text-decoration: none !important;
            background-color: #1e37ff !important;
            color: #ffffff !important;
            border: 3px solid #3967ff !important;
            border-radius: 5px !important;
            font-size: 16px !important;
            padding: 17px 50px !important;
            transition: all 1.6s ease !important;
        }
        .button_1661340660317:hover{
            text-decoration: none !important;
            background-color: #8294ff !important;
            color: #ffffff !important;
            border-color: #4e67ff !important;
        }
        </style>
        <a href="https://ui.calypso.finance/payment?currency=EUR&amount=1&description=Pay amount determined by merchant&key=fd441c87-3939-44d0-b0d3-6f7cbceda44c&full=true&btc_wallet=bc1ql3k0gh0ysvyxtfuntvrjmtp4r266s4wpspse67&eth_wallet=0xf857cf4be74a7b97e8bca24c53507773f60ed5fe&usdt_wallet=0xf857cf4be74a7b97e8bca24c53507773f60ed5fe&usdc_wallet=0xf857cf4be74a7b97e8bca24c53507773f60ed5fe&trx_wallet=TYqokfymRRWQLN6J2uvwzf3SCLp5jKcDUe&usdt_trx_wallet=TYqokfymRRWQLN6J2uvwzf3SCLp5jKcDUe&xdg_wallet=DSZnQMhM6p6MrUXfdYY3tMn38nYo5rYM41&dai_wallet=0xf857cf4be74a7b97e8bca24c53507773f60ed5fe&frax_wallet=0xf857cf4be74a7b97e8bca24c53507773f60ed5fe&busd_eth_wallet=0xf857cf4be74a7b97e8bca24c53507773f60ed5fe" class="button_1661340660317" target="_blank">
            Pay fix amount in crypto
        </a>
</body>

</html>

To access the widget, a link is formed with a certain set of parameters. Depending on the specified parameters you can create different types of payment widget for particular use case you need.

A single payment for a product with a fixed price

https://ui.calypso.finance/payment?currency={fiat_currency}&amount={payment_amount}&description={text}&btc_wallet={btc_address}&eth_wallet={eth_address}&usdt_wallet={usdt_address}&trx_wallet={trx_address}&usdt_trx_wallet={usdt_trx_address}&xdg_wallet={xdg_address}&dai_wallet={dai_address}&frax_wallet={frax_address}&usdc_wallet={usdc_address}&busd_eth_wallet={busd_eth_address}&bnb_wallet={bnb_address}&busd_wallet={busd_address}&matic_wallet={matic_address}&usdt_matic_wallet={usdt_matic_address}&key={genereted_reusable_key}&full={true_or_false}&idempotency_key={idempotency_key}&logo_url={logo_logo}&return_url={url_to_return_page}&support_url={support_url}

A single payment with a customer-defined price

https://ui.calypso.finance/payment?currency={fiat_currency}&description={text}&btc_wallet={btc_address}&eth_wallet={eth_address}&usdt_wallet={usdt_address}&trx_wallet={trx_address}&usdt_trx_wallet={usdt_trx_address}&xdg_wallet={xdg_address}&dai_wallet={dai_address}&frax_wallet={frax_address}&usdc_wallet={usdc_address}&busd_eth_wallet={busd_eth_address}&bnb_wallet={bnb_address}&busd_wallet={busd_address}&matic_wallet={matic_address}&usdt_matic_wallet={usdt_matic_address}&key={genereted_reusable_key}&full={true_or_false}&idempotency_key={idempotency_key}&logo_url={logo_logo}&return_url={url_to_return_page}&support_url={support_url}

Several payments with a customer-defined price

https://ui.calypso.finance/payment?type=unlimited&description={text}&key={genereted_reusable_key}&full={true_or_false}&idempotency_key={idempotency_key}&logo_url={logo_logo}&return_url={url_to_return_page}&support_url={support_url}

Depending on the specified parameters you can create different types of payment widget for particular use case you need.

Description of parameters

• currency - the currency in which the payment is made. Not obligatory for unlimited payments; string, optional.
• amount - the amount for which the payment is made. Don't specify it if you want to give possibility to customer to difine the amount of money he will pay; number, optional.
• type - type of payment widget. Default value is "fiat". Set value "unlimited" if you want to create widget for unlimited payments; string, optional.
• description - description or comment that is displayed in the widget; string, obligatory.
• btc_wallet - the address of the bitcoin wallet to which the funds from the invoice payment will be received. Not obligatory for unlimited payments; string, optional.
• eth_wallet - the address of the ethereum wallet to which the funds from the invoice payment will be received.Not obligatory for unlimited payments; string, optional.
• usdt_wallet - the address of the ethereum wallet to which the funds from the invoice payment will be received in USDT. Not obligatory for unlimited payments; string, optional.
• trx_wallet - the address of the tron wallet to which the funds from the invoice payment will be received. Not obligatory for unlimited payments; string, optional.
• usdt_trx_wallet - the address of the tron wallet to which the funds from the invoice payment will be received in USDT (TRC20). Not obligatory for unlimited payments; string, optional.
• xdg_wallet - the address of the doge wallet to which the funds from the invoice payment will be received. Not obligatory for unlimited payments; string, optional.
• dai_wallet - the address of the ethereum wallet to which the funds from the invoice payment will be received in DAI. Not obligatory for unlimited payments; string, optional.
• frax_wallet - the address of the ethereum wallet to which the funds from the invoice payment will be received in FRAX. Not obligatory for unlimited payments; string, optional.
• usdc_wallet - the address of the ethereum wallet to which the funds from the invoice payment will be received in USDT. Not obligatory for unlimited payments; string, optional.
• busd_eth_wallet - the address of the ethereum wallet to which the funds from the invoice payment will be received in BUSD (ERC20). Not obligatory for unlimited payments; string, optional.
• bnb_wawllet - the address of the binance smart chain wallet to which the funds from the invoice payment will be received. Not obligatory for unlimited payments; string, optional.
• busd_wallet - the address of the binance smart chain wallet to which the funds from the invoice payment will be received in BUSD. Not obligatory for unlimited payments; string, optional.
• matic_wallet - the address of the polygon wallet to which the funds from the invoice payment will be received. Not obligatory for unlimited payments; string, optional.
• usdt_matic_wallet - the address of the polygon wallet to which the funds from the invoice payment will be received in USDT. Not obligatory for unlimited payments; string, optional.
• key - a reusable key with a limited validity period, which is generated by the user via the Public API using the api key; string, obligatory.
• full - if true, the full version of the widget is displayed, if false, the mini version of the widget is shown; boolean; optional.
• idempotencyKey - idempotency key in the uuid4 format, that allows to get created invoice by idempotencyKey field; string, optional.
• logo_url - link to the logo of merchant which will be shown in the payment widget. The logo must be in PNG format. Recommended size 100*24 px; string, optional.
• return_url - link to the web page where client can come back to from payment widget; string, optional.
• support_url - link to the merchant support page where client can go to from payment widget; string, optional.

Quick guide on payment widget type

To summarize, here is a quick guide on what type of payment widget you need to use for your purposes.

1. If you want to receive a single payment for your product with a fixed predetermined price you'll need to use:

• A SINGLE_FIAT static payment widget (recommended)
• A dynamic payment widget with fixed price set of parameters

1. If you want to receive a single payment for your product with a customer-defined price you'll need to use:

• A dynamic payment widget with a customer-defined price set of parameters

1. If you want to receive several payments with a customer-defined price you'll need to use:

• An UNLIMITED_LINKED static payment widget (recommended)
• A dynamic payment widget with several payments & customer-defined price set of parameters

Payout

Overview

Payout is a payment of a reward, dividend, insurance compensation, etc. (i.e. a client may request to withdraw funds won in a casino). Withdrawal of funds is performed by Payment Processor.

Terminology and entities

• Payout is an object with data about a payout: payout ID, its status and data on the amount to be paid. The difference between the payment amount and the payout amount is the sum of all commissions.
• Wallet allows you to deposit and withdraw funds, as well as receive all information on payments made. A wallet in the Calypso system is set up in the context of the company.
• Client is a payee. Client data can be re-included in the payment.

API

Calypso enables external developers to programmatically interact with the service. One way to do this is to use Calypso APIs.

API access key

The API access key is used to authenticate operations required for making payments and payouts.

If passing incorrect API key in requests to Calypso API, the platform returns an authentication error (HTTP/401).

Please do not share your Calypso API key with anyone!

More details on API access keys are available on the Invoice API page.

Payout wallets

Hot wallet is a wallet designed to deposit and withdraw funds by creating a payout. It can be created via interface in Wallets section.

Features:

• View a balance
• Deposit funds
• Withdraw funds
• View transactions
• View statistics

Working with payout wallets via API:

Data on wallets and available assets in them can be received by using the method POST https://public-gateway.calypso.finance/api/v1/pub/payout/asset/all;

Example:

To get a payout wallet address to deposit funds:

1. Send API request POST https://public-gateway.calypso.finance/api/v1/pub/payout/asset/all
2. In the response, find the link for payout in required currency by navigating through the “currency” fields in the “assets” array
3. Copy a wallet address for required currency from the field “address” and transfer funds to this address

Creating payout via API

1. Check wallet balance and ensure enough funds for payouts are available by using the method POST https://public-gateway.calypso.finance/api/v1/pub/payout/asset/all;
2. Before creating a payout, get a network commission coefficient by using the method POST https://public-gateway.calypso.finance/api/v1/pub/payout/fee. The received value must be passed in the parameter networkFeeRatio of the payout creation method.
3. Create the payout by using the method POST https://public-gateway.calypso.finance/api/v1/pub/payout/create;
4. Get the data on the payout and its status by using the method POST https://public-gateway.calypso.finance/api/v1/pub/payout;

Scheme of information process interaction

Below is an example of creating a payout from a client’s site or application.

Names of requests on the scheme indicate certain payment API methods.

Payout statuses:

Diagram nodes indicate payout statuses, arrows indicate processes a successful completion of which transfers a payout from one status to another.

Notifications about events

Currently, notifications are displayed only in the Calypso UI in transaction details. There are the following notification types:

1. Price has been changed during a transaction.
2. There are not enough funds in the account to pay a commission after the payout creation and confirmation.

Payout limits

Currently, the limit is 10,000 payouts per day. There are no limits for transaction amounts in the total payout amount.

How long will it take for the funds to be credited to the account?

When a request is confirmed, some time is required to confirm transactions in the blockchain.

Confirmation time depends on the following factors:

• Blockchain type and current network load
• Specificities of the cryptocurrency provider wallet accepting payments. Since the very last blocks on the blockchain are not considered completely secure, services often wait for additional block confirmations before considering a transaction to be successful and irreversible.

Then, it is required to wait for the transaction to complete. The funds will be credited to your wallet shortly.

Mass Payouts

What are Mass Payouts?

Mass Payout is a method of paying up to 10,000 recipients simultaneously. Since mass payouts are submitted online, they are processed instantly which helps organizations to save time, money and resources.

How does it work?

The principle of Mass Payout is based on the use of the API:

• First, the company sends a request for a balance to check if funds are available.
• Next, you need to get the network commission coefficient. This value is required to create a request for Mass Payout.
• Next, the company sends a request to Calypso Payout API to conduct a Mass Payout.
• Next, Calypso handles a request.
• Next, Calypso verifies if there are enough funds on the balance.
• Next, the funds are sent to the recipients.

The Calypso Payout API is great for merchants needing to automate sending payments in real time. The company provides the ability to simultaneously make up to 10,000 payments.

Mass payouts are perfect for sending salaries to subordinates, payouts to partners or e-commerce marketplaces.

How to implement this via API?

Below is an example of creating Mass Payout from the client’s site or application.

Names of requests on the scheme indicate certain payment API methods.

Limits

Currently, there is a limit for quantity of transactions in one mass payout:

• 1000 transactions for ETH and tokens ERC-20;
• 100 transactions for other currencies.

Recurrent payments

Overview

Recurrent payments is a way to receive payments by merchant from a client on a regular basis via subscription.

This functionality allows you to create, manage and receive information about a subscription for your client.

For now we allow merchants and their clients to use recurrent payments functionality for ERC-20 (Ethereum, Binance Smart Chain, Polygon blockchains) tokens.

Merchant features:

• Add a subscription form on the site
• Customize your clients subscription: change duration, periodicity and free period options
• Monitor your client payments
• Receive funds directly to merchant’s wallet address

Client features:

• Subscribe for a product/service and pay for it in cryptocurrency
• Get a confirmation that subscription is active and money are received by a merchant
• Cancel the subscription any time you want

API

Calypso enables external developers to programmatically interact with the service. One way to do this is to use Calypso APIs.

API access key

The API access key is used to authenticate operations required for making payments and payouts.

If passing incorrect API key in requests to Calypso API, the platform returns an authentication error (HTTP/401).

Please do not share your Calypso API key with anyone!

More details on API access keys are available on the Invoice API page.

Payment by subscription

To regularly transfer funds for provided products/services to a merchant account, the subscription must be created.

To allow a client to subscribe to your service from the Calypso subscription form, there are the following steps to be performed:

• Send API request to create a subscription (POST https://public-gateway.calypso.finance/api/v1/pub/recurrent/create)
• Redirect a browser of a user to the link of the following format: https://ui.calypso.finance/subscription?uuid={linkId}

Example of the create subscription request:

{
  "nonce": 0,
  "request": {
    "amount": 1,
    "currency": "USDT",
    "depositAddress": "0x45aafbde1243ab39eccea1b4ba0174bc7bd130c7",
    "description": "subscription for client 1",
    "duration": 60,
    "freePeriod": 3,
    "name": "Subscription Extra",
    "periodicity": 30,
    "redirectUrl": "https://google.com/",
    "supportUrl": "https://google.com/"
  }
}

Further steps to complete payment are performed by a user in the subscription form.

Subscription statuses

Diagram nodes indicate subscription statuses, arrows indicate processes of a successful completion of subscription steps or occurring errors.

Authentication

Example

const crypto = require("crypto-js");
const request = require('request');

const body = JSON.stringify({
  "nonce": 0,
  "request": {
    "stateNames": "string",
    "pageNumber": 0,
    "size": 0,
    "direction": "ASC",
    "properties": "string"
    }
});

const apiKey = '<your_api_key>';
const secretKey = '<your_secret_key>'

function sign(message, secretKey) {
  return crypto.HmacSHA512(message, secretKey).toString(crypto.enc.hex);
}

var signature = sign(body, secretKey);

const headers = {
  'Key': apiKey,
  'Sign': signature,
  'Content-Type': 'application/json'
}

request({
  url: `https://public-gateway.calypso.finance/api/v1/pub/invoice/all,
  method: 'POST',
  headers: headers,
  json: true,
  body: body
}, (error, response, body) => {
  console.log('statusCode:', response && response.statusCode)
  console.log('body:', body)
});

Create API key

Calypso uses API keys to allow access to the API. You can contact Technical Support to generate a new pair of API keys for you (public and secret keys).

All requests must contain the following headers:

Signing a Request

Sign — POST data (in the same format in which you want to send) encrypted with method HMAC-SHA512 using secret key and the result object is converted to a HEX string.

The body is the request body string (in all cases this is JSON stringified request params object).

All the requests should also include the obligatory POST parameter nonce with incremental numerical value (>0). The incremental numerical value should never reiterate or decrease.

Invoice API

Get All Invoices

Request

curl --location --request POST 'https://public-gateway.calypso.finance/api/v1/pub/invoice/all' \
--header 'Key: <your_api_key>' \
--header 'Sign: <your_sign>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "nonce": 0,
  "request": {
    "stateNames": [
      "PENDING_PAYMENT"
    ],
    "typeNames": [
      "SINGLE", "UNLIMITED"
    ],
    "pageNumber": 0,
    "size": 0,
    "direction": "ASC",
    "property": "DATE"
  }
}'

Response

{
  "page": 0,
  "result": [
    {
      "amount": 0,
      "amountInInvoiceWallet": 0,
      "cartItems": [
        {
          "currency": "BNB",
          "price": 0,
          "product": "string",
          "quantity": 0
        }
      ],
      "createdDate": "2022-07-27T14:24:14.955Z",
      "currency": "BNB",
      "description": "string",
      "expiration": "2022-07-27T14:24:14.955Z",
      "externalId": "string",
      "fee": 0,
      "fiat": {
        "additionalProp1": 0,
        "additionalProp2": 0,
        "additionalProp3": 0
      },
      "fiatAmount": 0,
      "fiatCurrency": "USD",
      "fiatInInvoiceWallet": {
        "additionalProp1": 0,
        "additionalProp2": 0,
        "additionalProp3": 0
      },
      "hotWallet": {
        "address": "string",
        "name": "string"
      },
      "id": 0,
      "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "interventionType": "OVERPAY",
      "invoiceAddress": "string",
      "invoicePayments": [
        {
          "amount": 0,
          "blockchainTransactionFee": 0,
          "currency": "BNB",
          "feeCurrency": "BNB",
          "hotWallet": {
            "address": "string",
            "name": "string"
          },
          "notEnoughFundsForTokenFee": false,
          "notEnoughFundsForTokenFeeAmount": 0,
          "payAmount": 0,
          "state": "CANCELED",
          "toHotWalletHash": "string",
          "tokenFeeRequestHash": "string",
          "tokenTransactionFee": 0
        }
      ],
      "isInterventionResolved": false,
      "lastDepositHash": "string",
      "lastFiatUpdated": "2022-07-27T14:24:14.955Z",
      "logoUrl": "string",
      "payAmount": 0,
      "returnUrl": "string",
      "state": "ARCHIVED",
      "subscriptionEnabled": false,
      "supportUrl": "string",
      "totalDebitAmount": 0,
      "type": "SINGLE",
      "upperCommission": false,
      "useLiquidity": false
    }
  ],
  "size": 0,
  "total": 0,
  "totalElements": 0
}

This endpoint retrieves all invoices.

HTTP Request

POST https://public-gateway.calypso.finance/api/v1/pub/invoice/all

Header

Request Body

Response Body

Get Invoices By External ID

Request

curl --location --request POST 'https://public-gateway.calypso.finance/api/v1/pub/invoice/external' \
--header 'Key: <your_api_key>' \
--header 'Sign: <your_sign>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "nonce": 0,
  "request": {
    "pageNumber": 0,
    "size": 0,
    "direction": "ASC"
    "externalId": "string"
  }
}'

Response

{
  "page": 0,
  "result": [
    {
      "amount": 0,
      "amountInInvoiceWallet": 0,
      "cartItems": [
        {
          "currency": "BNB",
          "price": 0,
          "product": "string",
          "quantity": 0
        }
      ],
      "createdDate": "2022-07-27T14:24:14.955Z",
      "currency": "BNB",
      "description": "string",
      "expiration": "2022-07-27T14:24:14.955Z",
      "externalId": "string",
      "fee": 0,
      "fiat": {
        "additionalProp1": 0,
        "additionalProp2": 0,
        "additionalProp3": 0
      },
      "fiatAmount": 0,
      "fiatCurrency": "USD",
      "fiatInInvoiceWallet": {
        "additionalProp1": 0,
        "additionalProp2": 0,
        "additionalProp3": 0
      },
      "hotWallet": {
        "address": "string",
        "name": "string"
      },
      "id": 0,
      "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "interventionType": "OVERPAY",
      "invoiceAddress": "string",
      "invoicePayments": [
        {
          "amount": 0,
          "blockchainTransactionFee": 0,
          "currency": "BNB",
          "feeCurrency": "BNB",
          "hotWallet": {
            "address": "string",
            "name": "string"
          },
          "notEnoughFundsForTokenFee": false,
          "notEnoughFundsForTokenFeeAmount": 0,
          "payAmount": 0,
          "state": "CANCELED",
          "toHotWalletHash": "string",
          "tokenFeeRequestHash": "string",
          "tokenTransactionFee": 0
        }
      ],
      "isInterventionResolved": false,
      "lastDepositHash": "string",
      "lastFiatUpdated": "2022-07-27T14:24:14.955Z",
      "logoUrl": "string",
      "payAmount": 0,
      "returnUrl": "string",
      "state": "ARCHIVED",
      "subscriptionEnabled": false,
      "supportUrl": "string",
      "totalDebitAmount": 0,
      "type": "SINGLE",
      "upperCommission": false,
      "useLiquidity": false
    }
  ],
  "size": 0,
  "total": 0,
  "totalElements": 0
}

This endpoint retrieves invoices by specified externalId.

HTTP Request

POST https://public-gateway.calypso.finance/api/v1/pub/invoice/external

Header

Request Body

Response Body

Get a Specific Invoice

Request

curl --location --request POST 'https://public-gateway.calypso.finance/api/v1/pub/invoice' \
--header 'Key: <your_api_key>' \
--header 'Sign: <your_sign>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "nonce": 0,
  "request": {
    "id": 0,
    "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}'

Response

{
  "amount": 0,
  "amountInInvoiceWallet": 0,
  "cartItems": [
    {
      "currency": "BNB",
      "price": 0,
      "product": "string",
      "quantity": 0
    }
  ],
  "createdDate": "2022-07-27T14:24:14.955Z",
  "currency": "BNB",
  "description": "string",
  "expiration": "2022-07-27T14:24:14.955Z",
  "externalId": "string",
  "fee": 0,
  "fiat": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "fiatAmount": 0,
  "fiatCurrency": "USD",
  "fiatInInvoiceWallet": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "hotWallet": {
    "address": "string",
    "name": "string"
  },
  "id": 0,
  "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "interventionType": "OVERPAY",
  "invoiceAddress": "string",
  "invoicePayments": [
    {
      "amount": 0,
      "blockchainTransactionFee": 0,
      "currency": "BNB",
      "feeCurrency": "BNB",
      "hotWallet": {
        "address": "string",
        "name": "string"
      },
      "notEnoughFundsForTokenFee": false,
      "notEnoughFundsForTokenFeeAmount": 0,
      "payAmount": 0,
      "state": "CANCELED",
      "toHotWalletHash": "string",
      "tokenFeeRequestHash": "string",
      "tokenTransactionFee": 0
    }
  ],
  "isInterventionResolved": false,
  "lastDepositHash": "string",
  "lastFiatUpdated": "2022-07-27T14:24:14.955Z",
  "logoUrl": "string",
  "payAmount": 0,
  "returnUrl": "string",
  "state": "ARCHIVED",
  "subscriptionEnabled": false,
  "supportUrl": "string",
  "totalDebitAmount": 0,
  "type": "SINGLE",
  "upperCommission": false,
  "useLiquidity": false
}

This endpoint retrieves a specific invoice.

HTTP Request

POST https://public-gateway.calypso.finance/api/v1/pub/invoice

Header

Request Body

Response Body

New Invoice

Request

curl --location --request POST 'https://public-gateway.calypso.finance/api/v1/pub/invoice/create' \
--header 'Key: <your_api_key>' \
--header 'Sign: <your_sign>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "nonce": 0,
  "request": {
    "amount": 0,
    "expiration": "2022-07-19T08:30Z",
    "externalId": "string",
    "currency": "BTC",
    "description": "string",
    "type": "SINGLE",
    "cartItems": [
      {
        "currency": "BTC",
        "price": 0,
        "product": "string",
        "quantity": 0
      }
    ],
    "hotWalletAddress": "string",
    "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "logoUrl": "string",
    "returnUrl": "string",
    "supportUrl": "string",
    "type": "SINGLE",
    "upperCommission": true,
    "useLiquidity": false
  }
}'

Response

{
  "amount": 0,
  "amountInInvoiceWallet": 0,
  "cartItems": [
    {
      "currency": "BNB",
      "price": 0,
      "product": "string",
      "quantity": 0
    }
  ],
  "createdDate": "2022-07-27T14:24:14.955Z",
  "currency": "BNB",
  "description": "string",
  "expiration": "2022-07-27T14:24:14.955Z",
  "externalId": "string",
  "fee": 0,
  "fiat": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "fiatAmount": 0,
  "fiatCurrency": "USD",
  "fiatInInvoiceWallet": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "hotWallet": {
    "address": "string",
    "name": "string"
  },
  "id": 0,
  "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "interventionType": "OVERPAY",
  "invoiceAddress": "string",
  "invoicePayments": [
    {
      "amount": 0,
      "blockchainTransactionFee": 0,
      "currency": "BNB",
      "feeCurrency": "BNB",
      "hotWallet": {
        "address": "string",
        "name": "string"
      },
      "notEnoughFundsForTokenFee": false,
      "notEnoughFundsForTokenFeeAmount": 0,
      "payAmount": 0,
      "state": "CANCELED",
      "toHotWalletHash": "string",
      "tokenFeeRequestHash": "string",
      "tokenTransactionFee": 0
    }
  ],
  "isInterventionResolved": false,
  "lastDepositHash": "string",
  "lastFiatUpdated": "2022-07-27T14:24:14.955Z",
  "logoUrl": "string",
  "payAmount": 0,
  "returnUrl": "string",
  "state": "ARCHIVED",
  "subscriptionEnabled": false,
  "supportUrl": "string",
  "totalDebitAmount": 0,
  "type": "SINGLE",
  "upperCommission": false,
  "useLiquidity": false
}

This endpoint creates a new invoice.

HTTP Request

POST https://public-gateway.calypso.finance/api/v1/pub/invoice/create

Header

Request Body

Response Body

Funds Withdrawal (from unlimited invoice)

Request

curl --location --request POST 'https://public-gateway.calypso.finance/api/v1/pub/invoice/unlimited/withdrawal' \
--header 'Key: <your_api_key>' \
--header 'Sign: <your_sign>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "nonce": 0,
  "request": {
    "hotWalletAddress": "string",
    "id": 0,
    "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}'

Response

{
  "amount": 0,
  "amountInInvoiceWallet": 0,
  "cartItems": [
    {
      "currency": "BNB",
      "price": 0,
      "product": "string",
      "quantity": 0
    }
  ],
  "createdDate": "2022-07-27T14:24:14.955Z",
  "currency": "BNB",
  "description": "string",
  "expiration": "2022-07-27T14:24:14.955Z",
  "externalId": "string",
  "fee": 0,
  "fiat": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "fiatAmount": 0,
  "fiatCurrency": "USD",
  "fiatInInvoiceWallet": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "hotWallet": {
    "address": "string",
    "name": "string"
  },
  "id": 0,
  "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "interventionType": "OVERPAY",
  "invoiceAddress": "string",
  "invoicePayments": [
    {
      "amount": 0,
      "blockchainTransactionFee": 0,
      "currency": "BNB",
      "feeCurrency": "BNB",
      "hotWallet": {
        "address": "string",
        "name": "string"
      },
      "notEnoughFundsForTokenFee": false,
      "notEnoughFundsForTokenFeeAmount": 0,
      "payAmount": 0,
      "state": "CANCELED",
      "toHotWalletHash": "string",
      "tokenFeeRequestHash": "string",
      "tokenTransactionFee": 0
    }
  ],
  "isInterventionResolved": false,
  "lastDepositHash": "string",
  "lastFiatUpdated": "2022-07-27T14:24:14.955Z",
  "logoUrl": "string",
  "payAmount": 0,
  "returnUrl": "string",
  "state": "ARCHIVED",
  "subscriptionEnabled": false,
  "supportUrl": "string",
  "totalDebitAmount": 0,
  "type": "SINGLE",
  "upperCommission": false,
  "useLiquidity": false
}

This endpoint allow withdraw funds to internal crypto address.

HTTP Request

POST https://public-gateway.calypso.finance/api/v1/pub/invoice/unlimited/withdrawal

Header

Request Body

Response Body

Generate reusable api key

Request

curl --location --request POST 'https://public-gateway.calypso.finance/api/v1/pub/reusable-key-service' \
--header 'Key: <your_api_key>' \
--header 'Sign: <your_sign>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "nonce": 0,
  "request": {
    "expirationDate": "2022-02-10T11:04:24.435Z",
    "quantity": 1
    }
}'

Response

{
  "expirationDate": "2022-02-10T11:04:24.435Z",
  "key": "<reusable_api_key>",
  "quantity": 1
}

This endpoint allows to create reusable api key for payment widget

HTTP Request

POST https://public-gateway.calypso.finance/api/v1/pub/reusable-key-service

Header

Request Body

Response Body

Mark that intervention is resolved in invoice

Request

curl --location --request POST 'https://public-gateway.calypso.finance/api/v1/pub/invoice/close-intervention' \
--header 'Key: <your_api_key>' \
--header 'Sign: <your_sign>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "nonce": 0,
  "request": {
    "id": 0,
    "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}'

Response

{
  "amount": 0,
  "amountInInvoiceWallet": 0,
  "cartItems": [
    {
      "currency": "BNB",
      "price": 0,
      "product": "string",
      "quantity": 0
    }
  ],
  "createdDate": "2022-07-27T14:24:14.955Z",
  "currency": "BNB",
  "description": "string",
  "expiration": "2022-07-27T14:24:14.955Z",
  "externalId": "string",
  "fee": 0,
  "fiat": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "fiatAmount": 0,
  "fiatCurrency": "USD",
  "fiatInInvoiceWallet": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "hotWallet": {
    "address": "string",
    "name": "string"
  },
  "id": 0,
  "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "interventionType": "OVERPAY",
  "invoiceAddress": "string",
  "invoicePayments": [
    {
      "amount": 0,
      "blockchainTransactionFee": 0,
      "currency": "BNB",
      "feeCurrency": "BNB",
      "hotWallet": {
        "address": "string",
        "name": "string"
      },
      "notEnoughFundsForTokenFee": false,
      "notEnoughFundsForTokenFeeAmount": 0,
      "payAmount": 0,
      "state": "CANCELED",
      "toHotWalletHash": "string",
      "tokenFeeRequestHash": "string",
      "tokenTransactionFee": 0
    }
  ],
  "isInterventionResolved": false,
  "lastDepositHash": "string",
  "lastFiatUpdated": "2022-07-27T14:24:14.955Z",
  "logoUrl": "string",
  "payAmount": 0,
  "returnUrl": "string",
  "state": "ARCHIVED",
  "subscriptionEnabled": false,
  "supportUrl": "string",
  "totalDebitAmount": 0,
  "type": "SINGLE",
  "upperCommission": false,
  "useLiquidity": false
}

This endpoint changes the value isInterventionResolved to true. The invoice must be in state COMPLETED.

HTTP Request

POST https://public-gateway.calypso.finance/api/v1/pub/invoice/close-intervention

Header

Request Body

Response Body

Resolve intervention and receive money to the wallet

Request

curl --location --request POST 'https://public-gateway.calypso.finance/api/v1/pub/invoice/return-to-paid' \
--header 'Key: <your_api_key>' \
--header 'Sign: <your_sign>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "nonce": 0,
  "request": {
    "id": 0,
    "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}'

Response

{
  "amount": 0,
  "amountInInvoiceWallet": 0,
  "cartItems": [
    {
      "currency": "BNB",
      "price": 0,
      "product": "string",
      "quantity": 0
    }
  ],
  "createdDate": "2022-07-27T14:24:14.955Z",
  "currency": "BNB",
  "description": "string",
  "expiration": "2022-07-27T14:24:14.955Z",
  "externalId": "string",
  "fee": 0,
  "fiat": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "fiatAmount": 0,
  "fiatCurrency": "USD",
  "fiatInInvoiceWallet": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "hotWallet": {
    "address": "string",
    "name": "string"
  },
  "id": 0,
  "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "interventionType": "OVERPAY",
  "invoiceAddress": "string",
  "invoicePayments": [
    {
      "amount": 0,
      "blockchainTransactionFee": 0,
      "currency": "BNB",
      "feeCurrency": "BNB",
      "hotWallet": {
        "address": "string",
        "name": "string"
      },
      "notEnoughFundsForTokenFee": false,
      "notEnoughFundsForTokenFeeAmount": 0,
      "payAmount": 0,
      "state": "CANCELED",
      "toHotWalletHash": "string",
      "tokenFeeRequestHash": "string",
      "tokenTransactionFee": 0
    }
  ],
  "isInterventionResolved": false,
  "lastDepositHash": "string",
  "lastFiatUpdated": "2022-07-27T14:24:14.955Z",
  "logoUrl": "string",
  "payAmount": 0,
  "returnUrl": "string",
  "state": "ARCHIVED",
  "subscriptionEnabled": false,
  "supportUrl": "string",
  "totalDebitAmount": 0,
  "type": "SINGLE",
  "upperCommission": false,
  "useLiquidity": false
}

This endpoint allows to transfer money from invoice in internvention to merchant wallet.

HTTP Request

POST https://public-gateway.calypso.finance/api/v1/pub/invoice/return-to-paid

Header

Request Body

Response Body

Get all deposits for the invoice

Request

curl --location --request POST 'https://public-gateway.calypso.finance/api/v1/pub/invoice/deposit/all' \
--header 'Key: <your_api_key>' \
--header 'Sign: <your_sign>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "nonce": 0,
  "request": {
    "id": 0,
    "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "pageNumber": 0,
    "size": 0,
    "direction": "ASC",
    "property": "AMOUNT"
  }
}'

Response

{
  "result": [
    [
      {
        "amount": 0,
        "currency": "BTC",
        "transactionHash": "string",
        "createdDate": "2022-09-13T07:03:05.423Z",
        "addressFrom": "string"
      }
    ]
  ],
  "page": 0,
  "size": 0,
  "total": 0,
  "totalElements": 0
}

This endpoint retreaves all deposits for the particular invoice.

HTTP Request

POST https://public-gateway.calypso.finance/api/v1/pub/invoice/deposit/all

Header

Request Body

Response Body

Archive Invoice

Request

curl --location --request POST 'https://public-gateway.calypso.finance/api/v1/pub/invoice/archive' \
--header 'Key: <your_api_key>' \
--header 'Sign: <your_sign>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "nonce": 0,
  "request": {
    "id": 0,
    "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}'

Response

{
  "amount": 0,
  "amountInInvoiceWallet": 0,
  "cartItems": [
    {
      "currency": "BNB",
      "price": 0,
      "product": "string",
      "quantity": 0
    }
  ],
  "createdDate": "2022-07-27T14:24:14.955Z",
  "currency": "BNB",
  "description": "string",
  "expiration": "2022-07-27T14:24:14.955Z",
  "externalId": "string",
  "fee": 0,
  "fiat": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "fiatAmount": 0,
  "fiatCurrency": "USD",
  "fiatInInvoiceWallet": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "hotWallet": {
    "address": "string",
    "name": "string"
  },
  "id": 0,
  "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "interventionType": "OVERPAY",
  "invoiceAddress": "string",
  "invoicePayments": [
    {
      "amount": 0,
      "blockchainTransactionFee": 0,
      "currency": "BNB",
      "feeCurrency": "BNB",
      "hotWallet": {
        "address": "string",
        "name": "string"
      },
      "notEnoughFundsForTokenFee": false,
      "notEnoughFundsForTokenFeeAmount": 0,
      "payAmount": 0,
      "state": "CANCELED",
      "toHotWalletHash": "string",
      "tokenFeeRequestHash": "string",
      "tokenTransactionFee": 0
    }
  ],
  "isInterventionResolved": false,
  "lastDepositHash": "string",
  "lastFiatUpdated": "2022-07-27T14:24:14.955Z",
  "logoUrl": "string",
  "payAmount": 0,
  "returnUrl": "string",
  "state": "ARCHIVED",
  "subscriptionEnabled": false,
  "supportUrl": "string",
  "totalDebitAmount": 0,
  "type": "SINGLE",
  "upperCommission": false,
  "useLiquidity": false
}

This endpoint archives invoice by id or idempotency key.

HTTP Request

POST https://public-gateway.calypso.finance/api/v1/pub/invoice/archive

Header

Request Body

Response Body

Payout API

Get Assets And Wallet Addresses

Request

curl --silent --location --request POST "https://public-gateway.calypso.finance/api/v1/pub/payout/asset/all" \
--header 'Key: <your_api_key>' \
--header 'Sign: <your_sign>' \
--header "Content-Type: application/json" \
--data-raw "{
  "nonce": 0
}"

Response

{
  "overallBalance": {
    "availableTotalInFiat": {
      "additionalProp1": 0,
      "additionalProp2": 0,
      "additionalProp3": 0
    },
    "totalInPercentage": {
      "additionalProp1": 0,
      "additionalProp2": 0,
      "additionalProp3": 0
    }
  },
  "assets": [
    {
      "currency": "BTC",
      "isToken": true,
      "serviceFee": 0,
      "totalAvailable": 0,
      "totalAvailableInFiat": {
        "additionalProp1": 0,
        "additionalProp2": 0,
        "additionalProp3": 0
      },
      "wallets": [
        {
          "name": "string",
          "address": "string",
          "currency": "BTC",
          "mainCurrencyAsset": {
            "name": "string",
            "address": "string",
            "currency": "BTC",
            "availableAmount": 0,
            "availableAmountInFiat": {
              "additionalProp1": 0,
              "additionalProp2": 0,
              "additionalProp3": 0
            }
          },
          "availableAmount": 0,
          "availableAmountInFiat": {
            "additionalProp1": 0,
            "additionalProp2": 0,
            "additionalProp3": 0
          }
        }
      ]
    }
  ]
}