User Interactions & Access Levels
Convenient Checkout Gateway (CCG) provides flexible options for integrating payment capabilities into your application. Choose between a low-code Widget integration for fast setup, or a direct API integration for fine-grained customization—both supporting the same core capabilities.
Capabilities
| Capability | Description |
|---|---|
| Payment | Supports payment using stored payment methods, one-time payments, and the option to pay and save for future transactions. |
| Wallet | Allows authenticated users to manage a personal collection of payment methods, streamlining recurring transactions. |
| Refund | Enables issuing refunds for previous transactions and processing unlinked refunds. |
| Migration | Facilitates the transfer of customer data and payment methods from existing systems to the CCG platform. |
| Reporting | Generates reconciliation reports to track and verify transactions. |
User Types
- Authenticated User
- Agent
- Guest User
Authenticated User — A user the system recognizes uniquely (e.g., a logged-in customer).
- Payments: Use stored payment methods, make one-time payments, save payment details for future use.
- Wallet: Add, edit, delete, and set default payment methods.
Agent — Merchant agents or back-office staff who assist users or act on their behalf.
- Payments: Use stored payment methods, make one-time payments, save payment details.
- Wallet: Add, edit, delete, and set default payment methods.
- Refunds: Initiate refunds on behalf of users.
Guest User — Unauthenticated or anonymous users.
- Payments: One-time payments only. No wallet access.
Merchants & Treasury
| Role | Description |
|---|---|
| Merchant | Provides services to users and collects payments. CCG acts as an intermediary between the end-user and the merchant. |
| Treasury Team | Responsible for tracking and monitoring all transaction activities within the system. |
Capabilities Overview Diagram
PlantUML source code
Copy and paste into PlantText to render.
@startuml
left to right direction
skinparam usecase<<main>> {
BackgroundColor LightGreen
BorderColor DarkGreen
}
skinparam actor {
BackgroundColor CornflowerBlue
BorderColor MidnightBlue
Shape component
}
actor User as user
actor "Authenticated user" as auth_user
actor "Guest user" as guest_user
actor Agent as agent
actor Merchant as merchant #LightBlue
actor Treasury as treasury_team #LightBlue
rectangle Capabilities {
usecase "Payment(s)" as payments <<main>>
usecase "Manage Wallet" as wallet <<main>>
usecase "Add Payment Method" as add_payment_method <<include>>
usecase "Edit Payment Method" as edit_payment_method <<include>>
usecase "Delete Payment Method" as delete_payment_method <<include>>
usecase "View Payment Method(s)" as view_payment_methods <<include>>
usecase "Refund" as refunds <<main>>
usecase "Reporting" as reporting <<main>>
usecase "Migration" as migration <<main>>
}
auth_user --|> user
guest_user --|> user
agent --|> user
user -- wallet
user -- payments
wallet -- add_payment_method
wallet -- edit_payment_method
wallet -- delete_payment_method
wallet -- view_payment_methods
agent -- refunds
reporting -- merchant
migration -- merchant
reporting -- treasury_team
@enduml
Interaction Methods
CCG supports two integration approaches:
| Approach | Best For | Effort |
|---|---|---|
| Widget | Fast setup, pre-built UI, reduced PCI scope | Low |
| API | Custom flows, full control, advanced use cases | High |
Widget Integration
A plug-and-play UI component that can be embedded into your website or application. The widget handles the payment flow, user authentication, and UI, reducing development effort and PCI compliance scope.
Supported Widget Modes
| Widget Mode | User Types | Supported Actions |
|---|---|---|
PAYMENT | authUser, agent | One-Time Payment, Pay and Store |
PAYMENT | guestUser | One-Time Guest Payment |
PAYMENT_WITH_WALLET | authUser, agent | Payment with stored methods; Wallet: Add, Edit, Remove |
PAYMENT_METHOD_ENTRY | authUser, agent | Wallet: Add Payment Method |
WALLET | authUser, agent | Wallet: Add, Edit, Remove Payment Method |
PAYMENT_METHOD_SELECT | authUser, agent | Wallet: Add and Select Payment Method |
PAYMENT_METHOD_DISPLAY | authUser, agent | Wallet: Display Payment Method |
Widget Mode Flow
API Integration
For businesses needing more control or custom experiences, CCG offers a comprehensive REST API to build custom payment flows, manage wallets, and integrate advanced features.
API Access Levels
CCG's API supports multiple OAuth scopes to ensure security and proper segregation of duties:
| Access Level | Scope | Description | Supported Actions |
|---|---|---|---|
| Merchant | merchant | Make and manage payments | Payment (Stored Card, Capture, Cancel, Refund), Wallet (Edit, Remove) |
| Wallet Management | merchant-wallet-management | Manage digital wallets | Wallet: Retrieve, Edit, Remove Payment Method |
| PCI (Self Service) | merchant-pci | PCI-compliant merchants handling card data directly | One-Time Pay, Pay and Store, Add Payment Method |
Access to certain API scopes may require additional onboarding or compliance verification.