Check crypto invoice

POST 
/api/invoice/crypto-invoice/check

Checks cryptocurrency deposit invoice details and calculated values before invoice creation.

Request

application/json

Body

Bodyrequired

Crypto deposit invoice check 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

Example

{
  "receiverCurrency": "USD",
  "senderCurrency": "USD",
  "amount": 10.25,
  "transferAction": "GIVE",
  "note": "Sandbox transfer note",
  "sciName": "test-value",
  "orderId": "ORDER_123456",
  "subMerchantURL": "test-value"
}

Responses

200

OK

application/json

Schema

Schema

receiverCurrencystringrequired
Receiver Currency.
Possible values: [USD, EUR, GBP, RUB, UAH, KZT, BRL, TRY, AZN, ARS, AUD, BDT, CAD, CLP, COP, DOP, EGP, HKD, INR, IDR, JPY, MYR, MXN, MAD, NPR, NZD, PKR, PEN, PHP, SGD, ZAR, KRW, LKR, THB, AED, VND, CNY, CNH, 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, GBP, RUB, UAH, KZT, BRL, TRY, AZN, ARS, AUD, BDT, CAD, CLP, COP, DOP, EGP, HKD, INR, IDR, JPY, MYR, MXN, MAD, NPR, NZD, PKR, PEN, PHP, SGD, ZAR, KRW, LKR, THB, AED, VND, CNY, CNH, 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
senderAmountnumbernullable
Sender Amount.
Example: 10.25
receiverAmountnumbernullable
Receiver Amount.
Example: 10.25
expirationDatedate-timenullable

Expiration Date.

expirationDateMillisint64nullable

Expiration Date Millis.

Example

{
  "receiverCurrency": "USD",
  "senderCurrency": "USD",
  "amount": 10.25,
  "transferAction": "GIVE",
  "note": "Sandbox transfer note",
  "sciName": "test-value",
  "orderId": "ORDER_123456",
  "subMerchantURL": "test-value",
  "senderAmount": 10.25,
  "receiverAmount": 10.25,
  "expirationDate": "2026-01-15T10:30:00",
  "expirationDateMillis": "2026-01-15T10:30:00"
}

400

Bad request. The request is malformed or contains invalid parameters.

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: disabled
errorTypestringrequired
Error category.
Example: FORM
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "disabled",
        "errorType": "FORM",
        "errorId": "errTest1234",
        "errorDescription": "REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

401

Unauthorized. Merchant authentication headers are missing or invalid.

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: userDoesNotExistException
errorTypestringrequired
Error category.
Example: GENERAL
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "userDoesNotExistException",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

404

Not found. The requested resource does not exist.

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: resourceNotFound
errorTypestringrequired
Error category.
Example: GENERAL
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: Resource not found
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "resourceNotFound",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Resource not found",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

500

Internal server error. Unexpected error please contact support

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: internalServerError
errorTypestringrequired
Error category.
Example: GENERAL
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: Internal server error
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "internalServerError",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Internal server error",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}