Pay: refunds

List refunds

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

Query parameters#

  • invoice_idstring · uuid
  • statusstring
    Values prepared pending succeeded failed canceled
  • limitinteger
    Default 50
    1 to 100
  • cursorstring

    Opaque next_cursor of the previous page.

Responses#

200One page of refunds.
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 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
  • has_morebooleanrequired
  • next_cursorstringrequirednullable
4xx · 5xxError.

Standard error format: see Errors.