Skip to content

Mercury: Get a receipt

Mercury receipts.getReceipt: arguments, response, policy and SDK examples.

← Receipts operations · Get started

Operation mercury.getreceipt

Provider route: GET /spend/receipts/{receiptId}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/mercury with npm, or alter-sdk-mercury with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["receipts"]["getReceipt"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.receipts.getReceipt(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_mercury import MercuryIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.receipts.get_receipt(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.receiptIdstringRequired within parentID for the receipt
Format: uuid

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get a receipt — response body

Referenced models: Get a receipt — response body

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

SDK function policy ID: mercury.getreceipt. Catalog operation: mercury:getReceipt. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

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.