Skip to content

Mercury: Receipts schemas

4 Mercury schemas with complete fields and constraints.

← Receipts operations · All schemas

Get a receipt — response body

FieldTypePresenceDescription and constraints
$objectRootPublic view of a receipt and its matching state.
createdAtJSONRequired within parent
createdAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
fileNamestringRequired within parentMaximum length: 299
Minimum length: 1
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the receipt
Format: uuid
matchedTransactionIdJSONOptional
matchedTransactionId (anyOf 1)JSONAlternative
matchedTransactionId (anyOf 1) (allOf 1)stringAll variants applyID for this transaction
Format: uuid
matchedTransactionId (anyOf 1) (allOf 2)JSONAll variants applyThe transaction this receipt was matched to, once matched.
matchedTransactionId (anyOf 2)nullAlternative
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown values: pending, matched, unmatched, notAttempted, failed
uploadedAtJSONOptional
uploadedAt (anyOf 1)JSONAlternative
uploadedAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
uploadedAt (anyOf 1) (allOf 2)JSONAll variants applyWhen Mercury began processing the direct upload; absent until matching starts.
uploadedAt (anyOf 2)nullAlternative

List receipts — response body

FieldTypePresenceDescription and constraints
$objectRootA page of receipts plus the cursor for the next page.
pageobjectRequired within parent
page.nextPagestringOptionalID for the receipt
Format: uuid
page.previousPagestringOptionalID for the receipt
Format: uuid
receiptsarrayRequired within parent
receipts[]ModelEach itemExpand Get a receipt — response body

Referenced models: Get a receipt — response body

Request a receipt upload URL — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest a presigned URL to upload a receipt file.
Additional keys: not allowed
fileNamestringRequired within parentMaximum length: 299
Minimum length: 1

Request a receipt upload URL — response body

FieldTypePresenceDescription and constraints
$objectRootThe presigned upload URL plus the id of the receipt now being tracked. Upload
the file to @upload@, then start matching via the match endpoint.
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the receipt
Format: uuid
uploadstringRequired within parentThe presigned URL to upload the receipt file to.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.