CryptiumPayDocs
API reference

Get a public invoice

Read the current checkout projection without exposing merchant credentials.

GET/api/invoices/{id}

Read the customer-facing invoice projection. Public endpoint. Merchant credentials are not required.

Request fields from the OpenAPI specification
FieldTypeRequiredDescription
idpathstringYesInvoice ID returned at creation.

Source: download OpenAPI 3.1. Examples below use illustrative values.

Set CRYPTIUM_API_URL to your API origin. Authenticated examples also use CRYPTIUM_MERCHANT_ID and CRYPTIUM_API_KEY from your server environment. Replace the example IDs and asset codes with values from your deployment.

cURL
curl --silent --show-error --fail-with-body --max-time 15 \
  --request GET "${CRYPTIUM_API_URL%/}/api/invoices/22222222-2222-4222-8222-222222222222"

cURL requires OpenSSL and cURL 7.76+. JavaScript uses Node.js 18+; Python 3 uses the standard library; PHP requires the cURL extension. JSON bodies are compact UTF-8: sign the serialization described in authentication.

Public representation

This is the checkout representation. It includes the invoice ID, saved order_id (nullable), optional description, amount string, pricing currency and type, status, expiry, merchant branding, and eligible tokens and networks. Saved pricing, return URL and item snapshot can also be present.

It does not include metadata, webhook_url, the API key, or internal accounting data. Keep your own order-to-invoice mapping; order_id and description are customer-visible and must not contain secrets.

Payment instructions

Before a method is issued, pay can be absent. When present, it is a single object containing the selected network and token, address, exact expected and received amounts, and confirmation information.

{
  "network": { "code": "ETHEREUM", "name": "Ethereum" },
  "token": { "code": "ETH", "networks": [0] },
  "contract_address": null,
  "address": "0x0000000000000000000000000000000000000001",
  "amount_expected": "0.01",
  "paid_amount": "0",
  "confirmations_required": 12,
  "confirmations": 0
}

This example only illustrates the shape of pay. It does not declare a production asset list or a fixed confirmation requirement. Use the actual values returned by the service.

tokens[].networks contains numeric indexes into the top-level networks array. An already issued route can remain visible after it is removed from the merchant's newly offered methods.

Reconciliation

Use the current status to reconcile a stored invoice. Handle PAID and OVERPAID under your fulfilment policy and keep order changes idempotent. Read payment statuses for partial and late transfers.

Treat a checkout URL as customer-facing information. Do not use public invoice retrieval as a substitute for authenticating your own customers or checking order ownership.

On this page