Skip to main content

Create crypto invoice

POST 

/api/invoice/crypto-invoice/deposit

Creates a cryptocurrency deposit invoice for a merchant order.

Use this method when the customer is ready to pay: the response contains the address and the exact amount to show them. To preview the amounts without creating anything, use Check crypto invoice.

  • Show senderAmount, senderCurrency, address, and destinationTag if it is returned, exactly as the response gives them.
  • Pass your orderId and sciName to find the payment later with Get payment order. With sciName, a second invoice with the same orderId is rejected.
  • After a timeout or a 5xx error, look up the order before you create another invoice: the first one may already exist.

Step by step: Step 2: Create a crypto invoice.

Request​

Bodyrequired

Crypto deposit invoice creation payload.

    receiverCurrencystringrequired

    Receiver Currency.

    Possible values: [USD, EUR, USDT, USDC]

    Example: USD
    senderCurrencystringrequired

    Sender Currency.

    Possible values: [BTC, ETH, SOL, TRX, XRP, TON, LTC, AVAX, BNB, POL, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, USDT_TON, USDC, USDC_ERC20, USDC_BEP20, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]

    Example: USD
    amountnumberrequired

    Amount.

    Possible values: >= 0

    Example: 10.25
    transferActionstringrequired

    Transfer Action.

    Possible values: [GIVE, GET]

    Example: GIVE
    notestringnullable

    Note.

    Possible values: <= 255 characters

    Example: Sandbox transfer note
    sciNamestringnullable

    Hosted Checkout name set in your Volet.com account.

    Example: test-value
    orderIdstringnullable

    Order Id.

    Possible values: <= 64 characters

    Example: ORDER_123456
    subMerchantURLstringnullable

    Sub Merchant URL.

    Example: test-value

Responses​

OK

Schema
    receiverCurrencystringrequired

    Receiver Currency.

    Possible values: [USD, EUR, BTC, BNB, BNB_BEP20, BNB_BEP2, BNB_ERC20, BCH, DAI, DOGE, DOGE_DOGENT, DOGE_BEP2, DOGE_BEP20, ETH, LTC, USDP, XRP, SHIB, SHIB_BEP20, SHIB_ERC20, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, TUSD, USDC, USDC_ERC20, USDC_BEP20, USDC_BEP2, ZEC, BUSD, BUSD_BEP20, BUSD_ERC20, BUSD_TRC20, TON, SOL, ADA, AVAX, DOT, LINK, NEAR, POL, DASH, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]

    Example: USD
    senderCurrencystringrequired

    Sender Currency.

    Possible values: [USD, EUR, BTC, BNB, BNB_BEP20, BNB_BEP2, BNB_ERC20, BCH, DAI, DOGE, DOGE_DOGENT, DOGE_BEP2, DOGE_BEP20, ETH, LTC, USDP, XRP, SHIB, SHIB_BEP20, SHIB_ERC20, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, TUSD, USDC, USDC_ERC20, USDC_BEP20, USDC_BEP2, ZEC, BUSD, BUSD_BEP20, BUSD_ERC20, BUSD_TRC20, TON, SOL, ADA, AVAX, DOT, LINK, NEAR, POL, DASH, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]

    Example: USD
    amountnumberrequired

    Amount.

    Possible values: >= 0

    Example: 10.25
    transferActionstringrequired

    Transfer Action.

    Possible values: [GIVE, GET]

    Example: GIVE
    notestringnullable

    Note.

    Possible values: <= 255 characters

    Example: Sandbox transfer note
    sciNamestringnullable

    Hosted Checkout name set in your Volet.com account.

    Example: test-value
    orderIdstringnullable

    Order Id.

    Possible values: <= 64 characters

    Example: ORDER_123456
    subMerchantURLstringnullable

    Sub Merchant URL.

    Example: test-value
    addressstringnullable

    Address.

    Example: test-value
    addressOldFormatstringnullable

    Address Old Format.

    Example: test-value
    destinationTagstringnullable

    Destination Tag.

    Example: test-value
    senderAmountnumbernullable

    Sender Amount.

    Example: 10.25
    receiverAmountnumbernullable

    Receiver Amount.

    Example: 10.25
    expirationDatedate-timenullable

    Expiration Date.

    expirationDateMillisint64nullable

    Expiration Date Millis.