Billing

Read one top-up (the Lightning waiting client's poll)

lightning-cash-topup: the stored state of a top-up — pending, paid, paid_late (paid after the invoice expired; still credited), or expired. Authorized like the organization's billing read: any active member, or a grant key for one of its projects. An unauthorized caller receives the same not-found as a nonexistent id. Never carries the provider's credential or identifiers.

get/orgs/v1/{org_id}/checkouts/{topup_id}

Request

  • Base URL: https://api.run402.com
  • URL: https://api.run402.com/orgs/v1/{org_id}/checkouts/{topup_id}
  • Auth: one of:
    • API key in header SIGN-IN-WITH-X
    • HTTP bearer
    • API key in header x-admin-key

Path parameters

org_idstring uuid required

Organization UUID

topup_idstring uuid required

Top-up UUID from the create response

Response

The top-up

org_idstring uuid required
product'balance_topup' required
rail'lightning' required
topup_idstring uuid required
bolt11string nullable required

The payable invoice, verbatim (a standards-owned wire artifact).

payment_hashstring nullable required
amount_satsinteger nullable required
amount_usd_microsinteger required

The quoted USD value in micro-dollars; credited as-is on settlement.

usd_value_is_quotetrue required
quoted_rateobject nullable

usd_per_btc, source, observed_at, amount_sats

invoice_expires_atstring date-time nullable required
status'pending' | 'paid' | 'paid_late' | 'expired' required
paid_atstring date-time nullable required
credited_ledger_idstring uuid nullable required
created_atstring date-time nullable
next_actionsobject[] required

Changes

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