Aicscan Documentation
FrançaisEnglish

Pay: invoices

Get an invoice with its payments, sweeps and refunds

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

Path parameters#

  • idstring · uuidrequired

Responses#

200Invoice.
Object fields
  • 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
  • descriptionstringnullable
  • paymentsarray of object
    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
  • sweepsarray of object
    Fields of each item
    • idstring · uuid
    • objectstring
      Values sweep
    • chain_idinteger
    • tx_hashstring
    • log_indexinteger
    • block_numberinteger
    • tokenstringnullable
    • grossobject

      Token amount (native units as a string, formatted value and decimals).

      Object fields
      • amountstring

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

      • amount_formattedstring
      • decimalsinteger
    • feeobject

      Token amount (native units as a string, formatted value and decimals).

      Object fields
      • amountstring

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

      • amount_formattedstring
      • decimalsinteger
    • netobject

      Token amount (native units as a string, formatted value and decimals).

      Object fields
      • amountstring

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

      • amount_formattedstring
      • decimalsinteger
    • payoutstring
    • statusstring
      Values pending confirmed orphaned
    • shared_depositboolean

      Variant B: the sweep may cover several invoices.

    • created_atstring · date-time
  • refundsarray of object
    Fields of each item
    • amountstring

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

    • amount_formattedstring
    • decimalsinteger
    • idstring · uuid
    • objectstring
      Values refund
    • environmentstring
      Values test live
    • invoice_idstring · uuidnullable
    • chain_idinteger
    • tokenstringnullable
    • to_addressstring
    • statusstring
      Values prepared pending succeeded failed canceled
    • tx_hashstringnullable
    • warningsarray of string
      Values origin_address exchange_address
    • created_atstring · date-time
    • updated_atstring · date-time
4xx · 5xxError.

Standard error format: see Errors.