Invoice information request

The method allows you to get information about the invoice

Invoice information request

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

The body of the request for obtaining information about the invoice

invoiceIdstringoptional

Invoice ID

Example: 411f57b6-224d-4bf6-8ded-740fd3a7f3c9

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/api-gateway/get-invoice' \
  --header 'Content-Type: application/json' \
  --data '{
    "invoiceId": "411f57b6-224d-4bf6-8ded-740fd3a7f3c9"
  }'

200

200

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