Invoices

Retrieve an invoice by its public id

get/invoices/{id}

Request

  • Base URL: https://shieldz.cash/api/v1
  • URL: https://shieldz.cash/api/v1/invoices/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

OK

idstring
object'invoice'
amount_usd_centsinteger
memostring nullable
status'pending' | 'paid' | 'expired' | 'failed'
pay_urlstring uri
expires_atinteger

Unix milliseconds.

paid_atinteger nullable
mode'live' | 'test'
metadataunknown
payment_linkstring nullable

The payment link this invoice came from.

client_reference_idstring nullable

Example response

{
  "settlement": {
    "chain": "BASE",
    "asset": "USDC"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.