Expand description
Protocol types for Versa communication including customer registration, webhooks, and misuse reporting. Core protocol types for Versa communication.
This module contains the fundamental types used in the Versa Protocol for communication between senders (merchants) and receivers (inbox providers).
§Key Types
- [
VersaMode]: Environment mode (prod/test) for Versa operations - [
TransactionHandles]: Identifiers for routing receipts to the correct receivers - [
ReceiptRegistrationRequest]/[ReceiptRegistrationResponse]: Receipt registration flow - [
Receiver]/[ReceiverInstruction]: Receiver endpoint information - [
Sender]: Merchant/sender information with branding details - [
Checkout]: Receipt checkout information for receivers
§Submodules
- [
customer_registration]: Customer email verification and registration - [
webhook]: Webhook delivery payloads and events - [
misuse]: Misuse reporting functionality
Modules§
Structs§
- Address
- Asset
Registration Response - Check
Registry Response Deprecated - DEPRECATED: This struct is deprecated and will be removed in a future version.
- Checkout
- Checkout
Request - Client
Metadata - Encryption
Key - Envelope
- Event
Registration Request - Request to register a receipt with the Versa registry.
- Event
Registration Response - Response from the Versa registry after registering a receipt.
- Event
Registration Summary - Handling
- Information about how a receiver handles transactions
- Initial
Event Registration Request - Org
- Public
Org - Public organization information
- Receipt
Registration Response - Response from the Versa registry after registering a receipt.
- Receipt
Registration Summary - Receiver
- Information about a receipt receiver.
- Receiver
Info Deprecated - Receiver
Instruction - Receiver
Payload - Receiver
Query Request - Request body for querying receivers
- Receiver
Query Response - Response from receiver query
- Receiver
Query Result - Result of a receiver query
- Sender
- Information about the sender (merchant) of a receipt.
- Transaction
Handles - Identifiers for routing receipts to the correct receivers.
- Transaction
Handles Iter - Update
Event Registration Request
Enums§
- Customer
RefManaged By - Receiver
Category - Receiver category classification
- Receiver
Filter - Filter for querying receivers
- Versa
Mode - Environment mode for Versa operations.