Getting a list of invoices

The method allows you to get a list of invoices

Getting a list of invoices

post

/api-gateway/get-invoices

Header parameters

x-api-public-keystring

Public API-key

x-api-signaturestring

Signing the request body with a private API-key

Content-typestring

Request content type

Example: application/json

Body

limitinteger

Number of elements per page

offsetinteger

Number of items to skip

statusstring · enum[]

Invoice status. CREATED - created; INIT - the user proceeded to payment; PENDING - waiting for the full amount or waiting for transaction confirmations in the blockchain; PROCESSED - completed; PARTIAL - partial payment; REJECTED - the invoice was rejected, contact support for clarification; ERROR - error during creation or processing; EXPIRED - the invoice has expired; OVERPAID - the invoice was paid in excess of the specified amount;

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 '{
    "limit": 1,
    "offset": 1,
    "status": [
      "INIT"
    ]
  }'

200

200

{
  "success": true,
  "response": {
    "total": "900",
    "invoices": [
      {
        "id": "15f2d6ba-a7ab-4c71-9c59-3d3fb991dad0",
        "advancedBalanceId": "f9565f73-eb15-4246-9954-169eeb9475fc",
        "externalId": "merchantExternalId123",
        "externalUserId": "10099",
        "payerEmail": "[e-mail]",
        "invoiceLink": "https://invoices.domain/15f2d6ba-a7ab-4c71-9c59-3d3fb991dad0",
        "order": "Order #123456",
        "description": "Payment by order #123456",
        "currency": "USD",
        "amount": "20",
        "receivedAmount": "100.32",
        "receivedAmountInInvoiceCurrency": "100.94",
        "rate": "100.32",
        "includeFee": true,
        "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",
        "orderId": "d73adeb9-0d7d-4b4a-8b5d-3e92eac70297",
        "orderLink": "https://payment.domain/d73adeb9-0d7d-4b4a-8b5d-3e92eac70297",
        "status": "INIT",
        "receivedNetwork": "USDT",
        "receivedCurrency": "USDT",
        "additionalFees": [
          "SEPA_WITHDRAWAL"
        ],
        "currencies": [
          {
            "currency": "USDT",
            "networks": [
              {
                "name": "ethereum",
                "amount": "25"
              }
            ]
          }
        ]
      }
    ]
  }
}