Получение списка счетов

Метод позволяет получить список счетов

Получение списка счетов

post

/api-gateway/get-invoices

Header parameters

x-api-public-keystring

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

x-api-signaturestring

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

Content-typestring

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

Example: application/json

Body

statusstring · enum[]

Статус инвойса. CREATED - создан; INIT - пользователь перешел к оплате; PENDING - ожидаение полной суммы или ожидание подтверждений транзакции в блокчейне; PROCESSED - исполнен; PARTIAL - частичная оплата; REJECTED - инвойс отклонен, свяжитесь с поддержкой для уточнения; ERROR - ошибка в процессе создания или обработки; EXPIRED - скрок действия инвойса истек; OVERPAID - счет был оплачен сверх указанной суммы;

Example: INIT

limitinteger

Количество элементов на странице

offsetinteger

Количество элементов для пропуска

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.apollopayment.io/api-gateway/get-invoices' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": [
      "INIT"
    ],
    "limit": 1,
    "offset": 1
  }'

200

200

{
  "success": true,
  "response": {
    "invoices": [
      {
        "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"
              }
            ]
          }
        ]
      }
    ],
    "total": "900"
  }
}