Pay: invoices

List invoices

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

Query parameters#

  • statusstring
    Values waiting confirming paid underpaid overpaid expired paid_late canceled held
  • chain_idinteger · int64

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

  • external_refstring
  • created_afterstring

    ISO 8601 date or date-time, inclusive.

  • created_beforestring

    ISO 8601 date or date-time, exclusive.

  • limitinteger
    Default 50
    1 to 100
  • cursorstring

    Opaque next_cursor of the previous page.

Responses#

200One page of invoices.
Object fields
  • dataarray of objectrequired
    Fields of each item
    • idstring · uuid
    • objectstring
      Values invoice
    • statusstring
      Values waiting confirming paid underpaid overpaid expired paid_late canceled held
    • environmentstring
      Values test live
    • external_refstringnullable
    • variantstring
      Values A B
    • chain_idintegernullable

      Chain of the payment (set at creation when one chain is offered).

    • tokenstringnullable
    • decimalsintegernullable
    • amount_dueany
    • amount_receivedany
    • amount_pendingany
    • differencestringnullable

      Signed difference to the amount due, native units.

    • priceobjectnullable
      Object fields
      • currencystring
      • price_e6string
      • fx_rate_e6string

        Units of the currency for 1 USDT, in millionths, frozen at creation.

      • fx_sourcestring
      • fx_as_ofstring · date-time
    • chainsarray of object
      Fields of each item
      • amountstring

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

      • amount_formattedstring
      • decimalsinteger
      • chain_idinteger
      • tokenstring
      • deposit_addressstring

        Base58 T… on TRON.

      • payment_uristringnullable

        EIP-681 URI for a QR code (EVM chains).

    • expires_atstring · date-time
    • paid_atstring · date-timenullable
    • created_atstring · date-time
    • metadataobject
  • has_morebooleanrequired
  • next_cursorstringrequirednullable
4xx · 5xxError.

Standard error format: see Errors.