Вывод фиата

Получить список фиатных способов вывода

GET/api/v1/integration/merchant/fiat-withdraw-config/{currency}

Path parameters

currency*string

Header parameters

Response

200400401403500

Эндпоинт позволяет получить список доступных способов для вывода фиатных средств для мерчанта.
Эти данные необходимы для формирования запроса API метода fiat-withdraw

Body

application/json

message*string

Сообщение статуса

Example: "ok"

dataobject

Данные

countnumber

Общее кол-во элементов в БД

Example: 1

dataarray of ClientFiatWithdrawSettingsSerializer (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/integration/merchant/fiat-withdraw-config/{currency}', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200400401403500

{
  "message": "ok",
  "count": 1,
  "data": [
    {
      "name": "Все карты",
      "code": "RUB_CARD_32",
      "paymentMethod": "card",
      "currency": "RUB",
      "providersOut": [
        {
          "name": "Сбербанк",
          "code": "111000011",
          "aliasCode": "sber"
        }
      ],
      "amountMin": "10.00",
      "amountMax": "1000.00",
      "feePercent": "1.5"
    }
  ]
}

Создание фиатного вывода

Эндпоинт позволяет создать заявку на вывод фиатных средств для мерчанта.
Основные параметры вывода:
currency - валюта
amount - сумма
paymentMethod - метод вывода,
providerOutAliasCode - код банка вывода
code - код способа вывода
Для получения данных по доступным способам, банкам, лимитам, кодам вывода и тд. обратитесь к API методу fiat-withdraw-config.

POST/api/v1/integration/orders/fiat-withdraw

Header parameters

Body

application/json

currency*enum

Валюта

Example: "CODE"

RUBUSDEURKZT

paymentMethod*enum

Платежный метод

Example: "card"

cardphonesbpwallet

providerOutAliasCodestring

Код банка вывода

Example: "BANK"

codestring

Способ вывода

Example: "CURRENCY_CARD_65"

amount*string

Сумма выхода

Example: 10

commentstring

Комментарий к переводу. Опциональное поле

Example: "Оплата сервера за 07.2023"

recipient*string

Реквизиты реципиента

Example: "CARD NUMBER"

callbackUrlstring

Callback url для отправки хуков

Example: "https://api.myip.com"

detailsobject

Доп поля для вывода

Example: "{\"email\":\"[e-mail]\"}"

Response

200400401403500

Успешное создание фиатного вывода

Body

application/json

message*string

Сообщение статуса

Example: "ok"

dataobject

Данные

countnumber

Общее кол-во элементов в БД

Example: 1

dataOrderSerializer (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/integration/orders/fiat-withdraw', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "currency": "CODE",
      "paymentMethod": "card",
      "amount": 10,
      "recipient": "CARD NUMBER"
    }),
});
const data = await response.json();

Response

200400401403500

{
  "message": "ok",
  "count": 1,
  "data": {
    "id": 1,
    "uid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "createdAt": "2024-12-21T16:03:31.457Z",
    "updatedAt": "2024-12-21T16:03:31.457Z",
    "deletedAt": "2024-12-21T16:03:31.457Z",
    "comment": "Комментарий",
    "publicComment": "Публичный комментарий",
    "merchantUid": "3422b448-2460-4fd2-9183-8000de6f8343",
    "merchantName": "Тестовый мерчант",
    "merchantId": 6547,
    "type": "invoice",
    "status": "created",
    "invoiceCurrencyCode": "BTC",
    "currencyInCode": "USDTERC20",
    "currencyOutCode": "USDT",
    "invoiceAmount": "10.2334",
    "amountInExpected": "43.11",
    "amountInFact": "44",
    "amountOutExpected": "43.11,",
    "amountOutFact": "44",
    "hedgeRate": "44",
    "paymentTiming": "onTime",
    "amountValidity": "valid",
    "isDone": false,
    "apiMode": "ui",
    "risk": "24",
    "requisites": "0xD72901047ffd7Ad0f581016E6B8cF563E02E44bB",
    "requisitesMemoTag": "80576",
    "billingTag": "[e-mail]",
    "requisitesQrCode": "https://example.com/img-name.png",
    "serviceCommission": "0.565",
    "netCommission": "0.565",
    "serviceFeeCurrencyCode": "USDT",
    "netFeeCurrencyCode": "USDT",
    "balanceAfter": "44",
    "callbackUrl": "https://example/myCallback",
    "invoicePublicUrl": "https://example/myInvoice",
    "txId": "afda7a230080dee2119ce5d0a4a83980071eef6e5b14f1dc9ec7e510e63983fd",
    "expirationTime": "2024-12-21T16:03:31.457Z",
    "isImPayed": false,
    "relatedJiraIssueKey": "SUPPAY-93"
  }
}