API reference

API reference · API

This key's account's payments

GET/v1/pay/paymentsAPI key

Newest first; on an agent's key, the agent's own. Needs the pay or the read scope.

Parameters

Path and query parameters
FieldTypeWhat it is
limit (query)integerFrom 1 to 500.
before (query)integerUnix ms.

Answer 200

The payments.

Fields of the 200 answer
FieldTypeWhat it is
objectstring
dataarray of object
data[].idstringpay_ and 24 hex digits.
data[].statusstringrefused: the terms or the rules said no and nothing was signed. unconfirmed: the signed authorization went to the service and the chain has not yet said whether it moved; the charge is held. paid: the chain shows it moved, charged once. not_paid: it lapsed unused and the hold was released. paid_unverified: its chain could not be read for three days, so it was charged its hold. One of "refused", "signing", "unconfirmed", "paid", "paid_unverified", "not_paid".
data[].hoststring
data[].agent_idinteger or null
data[].networkstring or nullCAIP-2, such as eip155:8453.
data[].paid_microsintegerWhat the service was paid, micro USD.
data[].charged_microsintegerWhat the balance was charged; 0 until paid.
data[].hold_microsinteger
data[].markup_bpsinteger
data[].transactionstring or null
data[].transaction_urlstring or nullThe transaction on the chain's explorer.
data[].service_statusinteger or null
data[].reasonstring or null
data[].created_atinteger
data[].settled_atinteger 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