Skip to content

docs(ack-pay): align receipt API examples #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EfeDurmaz16 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(ack-pay): align receipt API examples #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/ack-pay/receipt-verification.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ _Example ACK Receipt Verifiable Credential:_
"https://agentcommercekit.org/contexts/payment/v1" // Example ACK context
],
"id": "urn:uuid:5c358383-1d93-4956-8d0c-6e41e4d29901", // Unique receipt ID
"type": ["VerifiableCredential", "ACKPaymentReceipt"],
"type": ["VerifiableCredential", "PaymentReceiptCredential"],
"issuer": "did:web:receipts.example.com", // DID of the trusted Receipt Service
"issuanceDate": "2025-04-04T14:22:18Z",
"credentialSubject": {
Expand Down
10 changes: 5 additions & 5 deletions packages/ack-pay/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,23 +77,23 @@ import { getDidResolver } from "@agentcommercekit/did"

const verified = await verifyPaymentReceipt(receipt, {
resolver: getDidResolver(),
trustedIssuers: ["did:web:merchant.example.com"],
trustedReceiptIssuers: ["did:web:receipt-service.example.com"],
})
```

### Type Guards for Validation

```ts
import { isPaymentRequest } from "@agentcommercekit/ack-pay"
import {
isPaymentReceiptCredential,
isPaymentRequest,
} from "@agentcommercekit/ack-pay"

// Check if a value is a valid payment request
isPaymentRequest(unknownObject)

// Check if a credential is specifically a payment receipt credential
isPaymentReceiptCredential(credential)

// Check if a credential subject has the payment receipt claim structure
isPaymentReceiptClaim(credential.credentialSubject)
```

## API Reference
Expand Down