Pay: invoices

List received payments

GET/v1/payments
Authentication
API key (Authorization: Bearer)
Required scope
pay:read

Query parameters#

  • chain_idinteger · int64

    EVM chain id: 56 BNB Chain, 1 Ethereum, 8453 Base, 42161 Arbitrum One, 137 Polygon, 728126428 TRON.

  • invoice_idstring · uuid
  • statusstring
    Values pending confirmed orphaned
  • unattributedboolean

    true: only payments matching no open invoice (variant B).

  • limitinteger
    Default 50
    1 to 100
  • cursorstring

    Opaque next_cursor of the previous page.

Responses#

200One page of payments.
Object fields
  • dataarray of objectrequired
    Fields of each item
    • amountstring

      Native units, e.g. 12500000 for 12.5 USDT with 6 decimals.

    • amount_formattedstring
    • decimalsinteger
    • idstring · uuid
    • objectstring
      Values payment
    • invoice_idstring · uuidnullable

      null: unattributed payment.

    • environmentstring
      Values test live
    • chain_idinteger
    • tx_hashstring
    • log_indexinteger
    • block_numberinteger
    • block_timestring · date-time
    • fromstring
    • tokenstringnullable
    • statusstring
      Values pending confirmed orphaned
    • ignored_reasonstringnullable
      Values dust unattributed other_chain other_token null
    • sanction_hitboolean
    • created_atstring · date-time
  • has_morebooleanrequired
  • next_cursorstringrequirednullable
4xx · 5xxError.

Standard error format: see Errors.