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[]

Array for filtering orders by status

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/api-gateway/get-invoices' \
  --header 'Content-Type: application/json' \
  --data '{"status":["INIT"]}'

200

200

{
  "success": true,
  "response": {
    "total": "900",
    "invoices": [
      {
        "id": "411f57b6-224d-4bf6-8ded-740fd3a7f3c9",
        "advancedBalanceId": "1503cf18-597f-447f-b172-112dfe377e1b",
        "externalId": "merchantExternalId123",
        "externalUserId": "10099",
        "payerEmail": "[e-mail]",
        "invoiceLink": "https://invoices.domain/411f57b6-224d-4bf6-8ded-740fd3a7f3c9",
        "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:03.213Z",
        "createdAt": "2024-12-26T08:21:33.213Z",
        "orderId": "a7ff7a80-dd8e-40e7-a262-4599b007211b",
        "orderLink": "https://payment.domain/a7ff7a80-dd8e-40e7-a262-4599b007211b",
        "status": "INIT",
        "receivedNetwork": "USDT",
        "receivedCurrency": "USDT",
        "additionalFees": [
          "SEPA_WITHDRAWAL"
        ],
        "currencies": [
          {
            "currency": "USDT",
            "networks": [
              {
                "name": "ethereum",
                "amount": "25"
              }
            ]
          }
        ]
      }
    ]
  }
}