Appearance
Glossary
This glossary defines key terms and concepts used throughout the Stable Mint Payments documentation. Understanding these entities and their relationships is crucial for successful integration.
Key Entities
Partner
A Partner is a business or organization that integrates with Stable Mint's payment infrastructure to enable cryptocurrency payment processing for their users.
Characteristics:
- Has a unique API key for authentication
- Must be onboarded by Stable Mint
- Can be configured for either Stable Mint-managed or partner-managed customer flows
- Receives webhooks for payment events
- Has access to Stable Mint's dashboard
Used in:
- All API endpoints (via API key authentication)
- Webhook configurations
- Settlement and withdrawal processes
Customer
A Customer is an end-user who makes payments through Stable Mint's payment infrastructure. The ownership and management of customers depends on the chosen flow.
In Stable Mint-Managed Flow:
- Customer relationship is owned by Stable Mint
- Stable Mint handles KYC/AML requirements
- Customer data is stored in Stable Mint's systems
- Partners don't need to provide customer identification
In Partner-Managed Flow:
- Customer relationship is owned by the partner
- Partners provide customer identification (userId, email, country)
- Partners can optionally provide KYC data
- Customer data is linked to the partner's account
Used in:
- Payment session creation
- Transaction processing
- Saved payment methods (for partner-managed customers)
Partner-Customer
A Partner-Customer refers to a customer in the partner-managed flow. This represents a customer whose relationship is owned and managed by the partner rather than Stable Mint.
Characteristics:
- Identified by a unique
userId
provided by the partner - Requires email and country code
- Can have saved payment methods
- Transaction history is linked to both the partner and customer
- Partner maintains the customer relationship
Used in:
/session/hosted/partner-managed-customer
endpoint/session/embedded/partner-managed-customer
endpoint- Saved banks and payment preferences
- Recurring payment scenarios
Flow-Specific Usage
Stable Mint-Managed Customer Flow
Available for:
- Hosted sessions only (
/session/hosted
)
Entity relationships:
- Partner → Stable Mint → Customer
- Stable Mint owns the customer relationship
- Minimal customer data required from partner
Best for:
- Anonymous transactions
- One-time payments
- Partners who don't want to manage customer data
Partner-Managed Customer Flow
Available for:
- Hosted sessions (
/session/hosted/partner-managed-customer
) - Embedded sessions (
/session/embedded/partner-managed-customer
)
Entity relationships:
- Partner → Partner-Customer
- Partner owns the customer relationship
- Partner provides customer identification
Best for:
- Recurring payments
- Building customer loyalty
- Maintaining customer payment history
- Custom KYC/AML processes
Additional Terms
Session
A secure, time-limited context for processing a payment. Every payment must be associated with a session.
Webhook
HTTP callbacks sent by Stable Mint to notify partners about payment events and status changes.
Idempotency Key
A unique identifier used to prevent duplicate payment sessions when retrying requests.
KYC (Know Your Customer)
Optional customer identification data that partners can provide, including:
- Full name
- Date of birth
- Address
- Identity documents
Important Notes
- Partner Onboarding: Partners must be specifically configured by Stable Mint to use either customer management flow
- Flow Selection: The chosen flow (Stable Mint-managed or partner-managed) affects available endpoints and features
- Customer Ownership: In partner-managed flows, partners maintain full ownership of customer relationships
- Data Responsibility: Partners using partner-managed flows are responsible for customer data accuracy and compliance