Проверка криптоинвойса

POST 
/api/invoice/crypto-invoice/check

Проверяет параметры криптоинвойса на пополнение и рассчитанные значения до создания инвойса.

Запрос

application/json

Body

Тело запросаобязательно

Данные для проверки криптоинвойса на пополнение.

receiverCurrencystringобязательно
Валюта получателя.
Возможные значения: [USD, EUR, USDT, USDC]
Пример: USD
senderCurrencystringобязательно
Валюта отправителя.
Возможные значения: [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]
Пример: USD
amountnumberобязательно
Сумма.
Возможные значения: >= 0
Пример: 10.25
transferActionstringобязательно
Действие перевода.
Возможные значения: [GIVE, GET]
Пример: GIVE
notestringnullable
Примечание.
Возможные значения: <= 255 символов
Пример: Sandbox transfer note
sciNamestringnullable
Название SCI.
Пример: test-value
orderIdstringnullable
ID заказа.
Возможные значения: <= 64 символов
Пример: ORDER_123456
subMerchantURLstringnullable
URL субмерчанта.
Пример: test-value

Пример

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

Ответы

200

OK

application/json

Схема

Схема

receiverCurrencystringобязательно
Валюта получателя.
Возможные значения: [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]
Пример: USD
senderCurrencystringобязательно
Валюта отправителя.
Возможные значения: [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]
Пример: USD
amountnumberобязательно
Сумма.
Возможные значения: >= 0
Пример: 10.25
transferActionstringобязательно
Действие перевода.
Возможные значения: [GIVE, GET]
Пример: GIVE
notestringnullable
Примечание.
Возможные значения: <= 255 символов
Пример: Sandbox transfer note
sciNamestringnullable
Название SCI.
Пример: test-value
orderIdstringnullable
ID заказа.
Возможные значения: <= 64 символов
Пример: ORDER_123456
subMerchantURLstringnullable
URL субмерчанта.
Пример: test-value
senderAmountnumbernullable
Сумма отправителя.
Пример: 10.25
receiverAmountnumbernullable
Сумма получателя.
Пример: 10.25
expirationDatedate-timenullable

Срок действия.

expirationDateMillisint64nullable

Срок действия в миллисекундах.

Пример

{
  "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

Некорректный запрос. Запрос сформирован неверно или содержит недопустимые параметры.

application/json

Схема

Схема

statusstringобязательно
Статус ответа.
Возможные значения: [error]
Пример: error
data objectобязательно
Данные ответа с ошибкой.
errors object[]обязательно
Список ошибок, возвращённых для запроса.
Array [
errorMessagestringобязательно
Постоянный машиночитаемый код ошибки.
Пример: disabled
errorTypestringобязательно
Категория ошибки.
Пример: FORM
errorIdstringобязательно
Короткий уникальный идентификатор ошибки для поддержки и логов.
Пример: errTest1234
errorDescriptionstringобязательно
Описание ошибки для человека.
Пример: REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API
errorFieldstringnullable
Поле запроса, к которому относится ошибка, если есть.
Пример: null
paramsobject[]обязательно
Дополнительные параметры ошибки.
requestParamsobjectобязательно
Параметры запроса, сохранённые для диагностики.
]

Пример

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

401

Не авторизован. Заголовки аутентификации мерчанта отсутствуют или недействительны.

application/json

Схема

Схема

statusstringобязательно
Статус ответа.
Возможные значения: [error]
Пример: error
data objectобязательно
Данные ответа с ошибкой.
errors object[]обязательно
Список ошибок, возвращённых для запроса.
Array [
errorMessagestringобязательно
Постоянный машиночитаемый код ошибки.
Пример: userDoesNotExistException
errorTypestringобязательно
Категория ошибки.
Пример: GENERAL
errorIdstringобязательно
Короткий уникальный идентификатор ошибки для поддержки и логов.
Пример: errTest1234
errorDescriptionstringобязательно
Описание ошибки для человека.
Пример: NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]
errorFieldstringnullable
Поле запроса, к которому относится ошибка, если есть.
Пример: null
paramsobject[]обязательно
Дополнительные параметры ошибки.
requestParamsobjectобязательно
Параметры запроса, сохранённые для диагностики.
]

Пример

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

404

Не найдено. Запрошенный ресурс не существует.

application/json

Схема

Схема

statusstringобязательно
Статус ответа.
Возможные значения: [error]
Пример: error
data objectобязательно
Данные ответа с ошибкой.
errors object[]обязательно
Список ошибок, возвращённых для запроса.
Array [
errorMessagestringобязательно
Постоянный машиночитаемый код ошибки.
Пример: resourceNotFound
errorTypestringобязательно
Категория ошибки.
Пример: GENERAL
errorIdstringобязательно
Короткий уникальный идентификатор ошибки для поддержки и логов.
Пример: errTest1234
errorDescriptionstringобязательно
Описание ошибки для человека.
Пример: Resource not found
errorFieldstringnullable
Поле запроса, к которому относится ошибка, если есть.
Пример: null
paramsobject[]обязательно
Дополнительные параметры ошибки.
requestParamsobjectобязательно
Параметры запроса, сохранённые для диагностики.
]

Пример

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

500

Внутренняя ошибка сервера. Непредвиденная ошибка, обратитесь в поддержку

application/json

Схема

Схема

statusstringобязательно
Статус ответа.
Возможные значения: [error]
Пример: error
data objectобязательно
Данные ответа с ошибкой.
errors object[]обязательно
Список ошибок, возвращённых для запроса.
Array [
errorMessagestringобязательно
Постоянный машиночитаемый код ошибки.
Пример: internalServerError
errorTypestringобязательно
Категория ошибки.
Пример: GENERAL
errorIdstringобязательно
Короткий уникальный идентификатор ошибки для поддержки и логов.
Пример: errTest1234
errorDescriptionstringобязательно
Описание ошибки для человека.
Пример: Internal server error
errorFieldstringnullable
Поле запроса, к которому относится ошибка, если есть.
Пример: null
paramsobject[]обязательно
Дополнительные параметры ошибки.
requestParamsobjectобязательно
Параметры запроса, сохранённые для диагностики.
]

Пример

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