Skip to main content
GET
Get invoice status

Authorizations

Authorization
string
header
required

Store-scoped API key. Prefix with sk_live_. Example: Authorization: Bearer sk_live_EXAMPLE_DO_NOT_USE

Path Parameters

id
string
required

Invoice ID from create or list responses (starts with inv_).

Pattern: ^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$

Response

Invoice status

Lightweight status for polling. Use this to check if a customer has paid.

id
string

Invoice ID (inv_...).

Pattern: ^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$
status
enum<string>

Where the invoice is in the payment flow:

  • pending: created, not yet ready for payment
  • quoted: price quote ready; customer can proceed to pay
  • awaiting_payment: waiting for the customer to send funds
  • paid: payment received and confirmed
  • underpaid: customer paid less than the requested amount
  • expired: not paid before the deadline
  • failed: payment or processing failed
  • refunded: payment was returned to the customer
  • cancelled: invoice was cancelled before completion
Available options:
pending,
quoted,
awaiting_payment,
paid,
underpaid,
expired,
failed,
refunded,
cancelled
swap_status
enum<string> | null

processing: customer paid; funds are being converted and sent to you. Only present during this step; omit or null otherwise.

Available options:
processing
Example:

"processing"

paid_amount
string | null

What the customer sent (e.g. "100.00"). null if not paid yet.

Example:

"100.00"

received_amount
string | null

What lands in your wallet after fees (e.g. "99.50"). null until settled.

Example:

"99.50"

difference_amount
string | null

Difference between received_amount and paid_amount (e.g. "-0.50" for fees). null if not paid.

Example:

"-0.50"

transaction_hash
string | null

Blockchain transaction ID once payment is confirmed.

paid_at
string<date-time> | null

When payment was confirmed (UTC). null if unpaid.

deposit_address
string | null

Address shown to the customer during checkout to send payment.

deposit_memo
string | null

Extra reference the customer must include with payment, if required by the network.

return_url
string<uri> | null

Redirect URL after checkout, if configured.