Reading invoice

GET /api/public/v1/invoices/:id

This endpoint returns details of a particular invoice by its ID.

Headers

NameValue

Content-Type

application/json

Path Parameters

NameValue

id

Invoice ID

Response

{
  "data": {
    "id": "55f7832f-9745-4553-8548-1a06e30fb251",
    "type": "invoices",
    "attributes": {
      "amountBilled": "1000.00",
      "amountCharged": "1011.233592",
      "billedCurrency": "usd",
      "chargedCurrency": "usdt",
      "reference": "9556e207-b785-4faf-9486-8e79fb442e76",
      "statusContext": "unpaid",
      "network": "ttrx:usdt",
      "networkName": "Tron (TRC20)",
      "status": "pending",
      "paymentStatus": "expecting",
      "exchangeRate": "0.9888912",
      "expiresAt": "2024-06-14T12:50:53.637Z",
      "createdAt": "2024-06-14T12:30:53.693Z"
    },
    "relationships": {
      "address": {
        "data": {
          "type": "addresses",
          "id": "b5c97775-1378-4170-a7f0-78c2c5d60720"
        }
      },
      "invoiceTransactions": {
        "meta": {
          "included": false
        }
      },
      "coinDeposits": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "included": [
    {
      "id": "b5c97775-1378-4170-a7f0-78c2c5d60720",
      "type": "addresses",
      "attributes": {
        "label": "USDT TTRX",
        "value": "TBq5k63KV9q4reE6JEF9e7wTYGo3RUkMQU",
        "createdAt": "2024-06-14T12:18:47.095Z"
      },
      "relationships": {
        "account": {
          "meta": {
            "included": false
          }
        },
        "network": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}

Last updated