@receiptprotocol/partner-sdk
v0.2.0-beta.1
Published
Server-side TypeScript SDK for the Receipt Partner Authority Gateway.
Readme
Receipt Partner SDK
Public Developer Preview TypeScript client for the provider-neutral Receipt Partner Authority Gateway.
Requires Node.js 20 or newer.
Use this package only in a trusted server process. A partner credential is a server-side secret; never bundle it into browser or mobile code. Provider credentials remain in the partner's own execution environment and are never sent to Receipt.
Receipt Authority API is one product: Test and Live are operating modes, not separate products. Test mode currently begins with the Reference Economic Action profile. Code-first custom action profiles are not yet self-serve. Receipt's Standard Action Library is upcoming. Live access remains available by request.
Package release pending. Until the beta is published, build and test this package from the repository.
import { ReceiptPartnerClient } from "@receiptprotocol/partner-sdk";
const receipt = new ReceiptPartnerClient({
baseUrl: process.env.RECEIPT_PARTNER_BASE_URL!,
partnerKey: process.env.RECEIPT_PARTNER_KEY!,
});Mutating methods are attempted exactly once. The SDK does not implicitly retry mandate, proposal, admission, execution-report, reconciliation, webhook, or credential mutations.
