Skip to main content
An invoice is the primary payment request object in Meum.

Invoice statuses

StatusDescription
pendingInitial or transitional state
awaiting_paymentCheckout URL active; waiting for customer
quotedCheckout quote active with deposit address
paidFull payment received and validated
underpaidPartial payment received
expiredInvoice expired before full payment
failedPayment failed
cancelledInvoice cancelled
refundedPlatform detected refund during status polling (platform-emitted)
The refunded invoice status is set by platform status polling, not by a merchant refund API. Merchant-initiated refunds are not yet available.

Key invoice fields

FieldDescription
amountRequested order amount
expected_amountAmount expected after quote (may differ with FX)
received_amount / paid_amountActual amount received
difference_amountDelta between expected and received
output_assetSettlement token identifier
checkout_urlHosted checkout URL
expires_atExpiration timestamp
tx_hashOn-chain transaction hash when paid

Idempotent creation

Creating an invoice with the same store_id + external_order_id returns the existing invoice instead of creating a duplicate.