Создание счета на оплату

Метод позволяет создать счет на оплату без строгого указания монеты и сети, вы можете указать оплату 30 USD и список доступных к оплате монет/сетей, пользователь сам выберет в чем ему удобнее оплатить. Сумма автоматически пересчитается в выбранную монету для оплаты

Создание счета на оплату

post

Header parameters

x-api-public-keystringOptional

Публичный API-ключ

x-api-signaturestringOptional

Подпись тела запроса приватным API-ключем

Content-typestringOptional

Тип тела запроса

Example: application/json

Body

Тело запроса для создания инвойса

advancedBalanceIdstringRequired

Идентификатор авансового баланса для списания комиссий

Example: f9565f73-eb15-4246-9954-169eeb9475fc

externalIdstringOptional

Уникальный идентификатор в системе мерчанта, для предотвращения дублирования создания инвойсов

Example: merchantExternalId123

orderstringOptional

Идентификатор ордера в системе мерчанта

Example: Order #123456

descriptionstringOptional

Описание ордера

Example: Payment by order #123456

externalUserIdstringOptional

Внешний идентификатор пользователя в вашей системе. При указании идентификатора будет использован функционал раздела "Персональные адреса" - будет зарезервирован статический адрес под данного пользователя, но вебхук придет на указанный в этом запросе адрес

Example: 10099

payerEmailstringOptional

Почта плательщика. Если указана в связке с параметром 'externalUserId' - будет создан пользователь с таким email в разделе "Персональные адреса"

Example: [e-mail]

currencystringRequired

Монеты для оплаты. Можно указывать любую доступную монету, в том числе фиатную. На странице инвойса сумма в указанной монете будет пересчитана к доступным для оплаты монет

Example: USD

amountstringRequired

Сумма к оплате в указанной монете. На странице инвойса сумма будет пересчитана по курсу к доступным для оплаты монетам

Example: 20

includeFeebooleanOptional

Флаг позволяет включить в сумму к оплате комиссию сети блокчейна выбранного для оплаты. Будет полезно чтобы заложить свои издержки на вывод монет после оплаты.

additionalFeesstring[]Optional

Массив с названиями тарифов, который позволяет включить в сумму к оплате комиссии по указанным тарифам

Example: SEPA_WITHDRAWAL

insurancePercentstringOptional

Позволяет добавить к сумме оплаты указанный процент

Example: 1

slippagePercentstringOptional

При открытия страници инвойса пользователь может провести на ней столько времени что курс смениться. Если после перехода к оплате сумма измениться больше указанного процента, то сумма к оплате будет пересчитана по текущему курсу

Example: 2

paymentTolerancePercentstringOptional

Допустимый процент недоплаты ОРДЕРА. Например, после выбора монеты инвойса был создан ордер на 100 USDT. Если параметр установлен как 1.5%, то ордер завершится с успехом при оплате 98.5 USDT

Example: 1.5

webhookURLstringOptional

URL для уведомлений при изменении статуса инвойса или полученной суммы

Example: https://merchant.domain/webhooks/invoice

returnURLstringOptional

URL для указания в качестве "Вернуться в магазин" на странице оплаты

Example: https://merchant.domain/

lifetimeintegerRequired

Время жизни инвойса в минутах

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /api-gateway/make-invoice HTTP/1.1
Host: app.apollopayment.io
Content-Type: application/json
Accept: */*
Content-Length: 507

{
  "advancedBalanceId": "f9565f73-eb15-4246-9954-169eeb9475fc",
  "externalId": "merchantExternalId123",
  "order": "Order #123456",
  "description": "Payment by order #123456",
  "externalUserId": "10099",
  "payerEmail": "[e-mail]",
  "currency": "USD",
  "amount": "20",
  "includeFee": true,
  "additionalFees": [
    "SEPA_WITHDRAWAL"
  ],
  "insurancePercent": "1",
  "slippagePercent": "2",
  "paymentTolerancePercent": "1.5",
  "webhookURL": "https://merchant.domain/webhooks/invoice",
  "returnURL": "https://merchant.domain/",
  "lifetime": 1,
  "currencies": [
    []
  ]
}

200Success

{
  "success": true,
  "response": {
    "id": "15f2d6ba-a7ab-4c71-9c59-3d3fb991dad0",
    "advancedBalanceId": "f9565f73-eb15-4246-9954-169eeb9475fc",
    "externalId": "merchantExternalId123",
    "externalUserId": "10099",
    "payerEmail": "[e-mail]",
    "orderId": "d73adeb9-0d7d-4b4a-8b5d-3e92eac70297",
    "orderLink": "https://payment.domain/d73adeb9-0d7d-4b4a-8b5d-3e92eac70297",
    "invoiceLink": "https://invoices.domain/15f2d6ba-a7ab-4c71-9c59-3d3fb991dad0",
    "status": "INIT",
    "order": "Order #123456",
    "description": "Payment by order #123456",
    "currency": "USD",
    "amount": "20",
    "receivedNetwork": "USDT",
    "receivedCurrency": "USDT",
    "receivedAmount": "100.32",
    "receivedAmountInInvoiceCurrency": "100.94",
    "rate": "100.32",
    "includeFee": true,
    "additionalFees": [
      "SEPA_WITHDRAWAL"
    ],
    "insurancePercent": "1",
    "slippagePercent": "2",
    "paymentTolerancePercent": "1.5",
    "webhookURL": "https://merchant.domain/webhooks/invoice",
    "returnUrl": "https://merchant.domain/",
    "expiresAt": "2024-12-26T08:22:23.357Z",
    "createdAt": "2024-12-26T08:21:53.357Z",
    "currencies": [
      {
        "currency": "USDT",
        "networks": [
          {
            "name": "ethereum",
            "amount": "25"
          }
        ]
      }
    ]
  }
}