API Reference

🚀Introduction

Welcome !

🧮 Wallet Manager API

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
  • ⚡ Initiate Pix transfers
  • 🔗 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
    ACCOUNT ||--o{ MERCHANT : owns
    ACCOUNT ||--o{ WALLET : owns
    MERCHANT ||--o{ CHARGE : creates
    WALLET ||--o{ CHARGE : manages

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