🚀Introduction

Welcome !

Wallet Manager API

[!INFO] Quick Overview
The Wallet Manager API is your gateway to embedding financial services directly into your platform. Process payments, manage wallets, and handle the complete transaction lifecycle with a single, unified API.


What You Can Do

With this API, your system can:

CapabilityDescription
🧑‍💼 Digital WalletsCreate and manage wallets tied to customer accounts
💳 Card PaymentsProcess credit and debit card transactions
PIX & QR CodesGenerate instant payment links and QR codes
🔐 3DS AuthenticationBuilt-in 3D Secure flows for enhanced security
📬 Real-time WebhooksReceive instant notifications on transaction status
🔄 SubscriptionsManage recurring billing and payment schedules

Architecture Overview

erDiagram
    PARTNER ||--o{ ACCOUNT : manages
    ACCOUNT ||--o{ MERCHANT : contains
    MERCHANT ||--o{ WALLET : owns
    WALLET ||--o{ CHARGE : processes
    WALLET ||--o{ SUBSCRIPTION : manages
    
    PARTNER {
        uuid partner_uuid PK
        string name
        string client_id
        datetime created_at
    }
    
    ACCOUNT {
        uuid entity_uuid PK
        uuid partner_uuid FK
        string company_name
        string document
        enum status
    }
    
    MERCHANT {
        uuid merchant_uuid PK
        uuid entity_uuid FK
        string soft_descriptor
        boolean active
    }
    
    WALLET {
        uuid wallet_uuid PK
        uuid merchant_uuid FK
        string currency
        decimal balance
        enum type
    }
    
    CHARGE {
        uuid charge_uuid PK
        uuid wallet_uuid FK
        decimal amount
        enum payment_method
        enum status
        datetime created_at
    }
    
    SUBSCRIPTION {
        uuid subscription_uuid PK
        uuid wallet_uuid FK
        decimal amount
        string interval
        enum status
    }

Required Credentials

Before using the API, you need credentials from our technical team:

CredentialDescriptionUsage
entity_uuidUnique account identifierRequired for wallet creation
merchant_uuidMerchant IDUsed in charges and transactions
client_idOAuth2 application IDToken requests via Cognito
client_secretOAuth2 secret keyKeep secure - never expose in frontend!
wallet_uuidWallet identifierManaging funds and transactions

[!WARNING] Security Notice
The client_secret must be stored securely on your backend. Never include it in client-side code, mobile apps, or public repositories.


Request Access

[!TIP] Contact Our Team
To request your credentials, email us at **

The Wallet Manager API is a secure and scalable solution for managing digital wallets and executing financial transactions. Tailored for payment facilitators, it enables complete control of the transaction lifecycle — from wallet creation to payment processing and settlement.


🚀 What You Can Do

With this API, your system can:

  • 🧑‍💼 Create digital wallets tied to customer accounts
  • 💳 Process credit card payments
  • 🔗 Generate custom payment links (QR, checkout, etc.)

The API is built on top of a high-availability cloud infrastructure, integrated with Amazon Cognito for secure OAuth2 authentication — ensuring performance, compliance, and resilience by design.


🔐 Getting Access

Before using the Wallet Manager API, you’ll need a set of credentials provisioned by our technical team:

CredentialDescription
entity_uuidUnique account identifier (customer-level). Required for wallet creation.
merchant_uuidMerchant identifier tied to the account. Used in charges and transactions.
client_idPublic identifier of your application (via Cognito). Used for token requests.
client_secretPrivate secret used with client_id. Must be stored securely and never exposed on the frontend.
💡

To request access, contact: [email protected]

Our team will guide you through onboarding, testing, and production deployment.


📘 Glossary

TermDescription
entity_uuidUnique ID of the end-customer account. Required to create wallets.
merchant_uuidUnique ID of the merchant associated with the account. Used for transactions.
client_idPublic identifier used for authentication with Cognito.
client_secretPrivate key used with client_id for secure authentication.
wallet_uuidUnique ID of the wallet associated with the account. Used for managing funds.

🧩 Entity Diagram

The following diagram illustrates the core relationships between entities in the Wallet Manager API:

erDiagram
    direction TB
    ACCOUNT ||--o{ MERCHANT : owns
    MERCHANT ||--o{ WALLET : manages
    WALLET ||--o{ CHARGE : funds
    MERCHANT ||--o{ CHARGE : creates

    ACCOUNT {
        string account_uuid
        string name
    }
    MERCHANT {
        string merchant_uuid
        string soft_description
        string account_uuid
    }
    WALLET {
        string wallet_uuid
        string currency
        float balance
        string merchant_uuid
    }
    CHARGE {
        string charge_uuid
        string wallet_uuid
        string merchant_uuid
        float amount
    }