Invoices

Create an invoice

post/invoices

Request

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

Request body

amount_usd_centsinteger

Amount in USD cents. Omit when sending line_items.

client_reference_idstring

Your order or cart id, echoed on the invoice and webhooks.

return_urlstring uri

Public https URL the paid checkout returns the buyer to. success_url is accepted as an alias.

memostring
customer_emailstring email
expires_in_secondsinteger
idempotency_keystring

Replaying the same key returns the original invoice.

metadataobject

Arbitrary JSON, echoed back on webhooks.

Example request

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

Response

Created

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.