API reference

API reference · Credits

Receipts for credited deposits

GET/api/credits/receiptsSigned in session

One receipt per credited deposit, rendered from the credit ledger rather than stored beside it: the chain, the token, the transaction hash and the amount. There are no invoices because there are no card payments. The number is stable, because the ledger row it names is.

Parameters

Path and query parameters
FieldTypeWhat it is
orgId (query)integerAn organization's receipts instead of your own.
number (query)stringDownload one receipt by number.

Answer 200

Receipts, newest first.

Fields of the 200 answer
FieldTypeWhat it is
receiptsarray of Receipt
receipts[].receiptNumberstringStable for the life of the credit.
receipts[].ledgerIdinteger
receipts[].sourcestringOne of "chain", "manual".
receipts[].chainstring or nullNetwork key, base, when the credit came from a chain.
receipts[].chainNamestring or null
receipts[].chainIdinteger or null
receipts[].tokenstring or nullUSDC or USDT.
receipts[].txHashstring or null
receipts[].amountMicrosintegerMicro USD credited.
receipts[].createdAtinteger
receipts[].orgIdinteger or null

Errors

  • 401OpenAI shaped error.
  • 403OpenAI shaped error.
  • 404OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter