Getting a list of invoices

The method allows you to get a list of invoices

Getting a list of invoices

POSThttps://ocp.onchainpay.io/api-gateway/get-invoices

Header parameters

Body

application/json

statusarray of enum

Array for filtering orders by status

limitinteger

Number of elements per page

offsetinteger

Number of items to skip

Response

200

Body

application/json

success*boolean

Request success indicator

response*GetInvoicesResponse (object)

The body of the response to the request for a list of invoices

Request

JavaScriptCurlPython

const response = await fetch('https://ocp.onchainpay.io/api-gateway/get-invoices', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "invoices": [
      {
        "id": "377e8ae7-2bd5-487d-8c54-b4a74b92e597",
        "advancedBalanceId": "882f4ed6-82c8-43c3-8dd6-d755cee5f1af",
        "externalId": "merchantExternalId123",
        "orderId": "c74ff3eb-5732-4ff5-be31-a03ef7f7f237",
        "orderLink": "https://payment.domain/c74ff3eb-5732-4ff5-be31-a03ef7f7f237",
        "invoiceLink": "https://invoices.domain/377e8ae7-2bd5-487d-8c54-b4a74b92e597",
        "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": false,
        "additionalFees": [
          "SEPA_WITHDRAWAL"
        ],
        "insurancePercent": "1",
        "slippagePercent": "2",
        "paymentTolerancePercent": "1.5",
        "webhookURL": "https://merchant.domain/webhooks/invoice",
        "returnUrl": "https://merchant.domain/",
        "expiresAt": "2024-11-07T12:41:39.824Z",
        "createdAt": "2024-11-07T12:41:09.824Z",
        "currencies": [
          {
            "currency": "USDT",
            "networks": [
              {
                "name": "ethereum",
                "amount": "25"
              }
            ]
          }
        ]
      }
    ],
    "total": "900"
  }
}