Getting a list of invoices

The method allows you to get a list of invoices

Getting a list of invoices

post

Header parameters

x-api-public-keystringOptional

Public API-key

x-api-signaturestringOptional

Signing the request body with a private API-key

Content-typestringOptional

Request content type

Example: application/json

Body

application/json

Request body for getting a list of invoices

limitintegerOptional

Number of elements per page

offsetintegerOptional

Number of items to skip

Responses

200Success

application/json

post

/api-gateway/get-invoices

HTTPcURLJavaScriptPython

POST /api-gateway/get-invoices HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "status": [
    "INIT"
  ],
  "limit": 1,
  "offset": 1
}

200Success

{
  "success": true,
  "response": {
    "invoices": [
      {
        "id": "2076e88f-547a-4437-9ece-68c99731ab42",
        "externalId": "merchantExternalId123",
        "externalUserId": "10099",
        "payerEmail": "[email protected]",
        "orderId": "602f03ec-ed7e-458a-b61a-6b05b0f1a5af",
        "orderLink": "https://payment.domain/602f03ec-ed7e-458a-b61a-6b05b0f1a5af",
        "invoiceLink": "https://invoices.domain/2076e88f-547a-4437-9ece-68c99731ab42",
        "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": "2025-07-15T10:51:16.078Z",
        "createdAt": "2025-07-15T10:50:46.078Z",
        "currencies": [
          {
            "currency": "USDT",
            "networks": [
              {
                "name": "ethereum",
                "amount": "25"
              }
            ]
          }
        ]
      }
    ],
    "total": "900"
  }
}