Upon creating a wallet, the client is assigned an internal ID that identifies their wallet within the system.While this process does not inherently provide funds to the client, it equips them with the necessary infrastructure to receive, store, and manage funds.The digital wallet serves as a foundational element for clients to participate in various financialactivities, facilitating the seamless execution of transactions.

🔗 Endpoint

POST /api/v1/bank/wallet/

📥 Payload (JSON)

{
  "entity_uuid": "fead5d6f-0125-44e0-a26c-1b7ddsd9bf1",
  "customer_id": "[email protected]",
  "name": "Jhon Does",
  "email": "[email protected]",
  "create_credentials": true
}

🧾 Fields

Field	Type	Required	Description
`entity_uuid`	string	Yes	UUID of the entity (the account or company that owns the wallet)
`customer_id`	string	Yes	Unique identifier for the customer (can be an email or internal ID)
`name`	string	Yes	Customer's full name
`email`	string	Yes	Customer's email address
`create_credentials`	boolean	No	Whether to generate OAuth2 credentials for the wallet

✅ Response

Success – 201 Created

{
  "wallet_uuid": "3ecea5d7-4f06-4485-ab38-a5f9c05678",
  "credentials": {
    "client_id": "6vhvv7vid945667856cm",
    "client_secret": "264568ld10u39ektjjd7686783cob8v6vq8h1vd4phi18v",
    "grant_type": "client_credentials",
    "scopes": [
      "product_manager/bank.wallet.read",
      "product_manager/bank.wallet.write"
    ]
  }
}

🔐 Response Fields

Field	Type	Description
`wallet_uuid`	string	Unique identifier of the created wallet
`credentials`	object	OAuth2 credentials (only returned if `create_credentials` is true)
`client_id`	string	Client ID used for OAuth2 authentication
`client_secret`	string	Client secret used for OAuth2 authentication
`grant_type`	string	Authentication type (always `client_credentials`)
`scopes`	array	Permissions granted to the credentials

⚠️ Notes

The client_secret is returned only once. Make sure to store it securely.
These credentials should be used for authenticated requests related to the wallet.
If create_credentials is omitted or set to false, the wallet will be created without any credentials.

📘 Get Wallet

Retrieve the details of an existing wallet by providing the wallet_uuid, email, and customer_id.

🔗 Endpoint

GET /api/v1/bank/wallet/?

📤 Query Parameters

Parameter	Type	Required	Description
`wallet_uuid`	string	No	The unique identifier of the wallet
`email`	string	No	The email associated with the wallet
`customer_id`	string	No	The customer identifier (usually matches the email)

✅ Response

Success – 200 OK

{
  "wallet_uuid": "80x80dfa-7044-4492-a695-b3916b43b2da",
  "email": "[email protected]",
  "customer_id": "[email protected]",
  "local_balance": 0,
  "currency": "BRL",
  "date": "2025-06-16T00:00:00"
}

🔍 Response Fields

Field	Type	Description
`wallet_uuid`	string	Unique identifier of the wallet
`email`	string	Email address linked to the wallet
`customer_id`	string	Identifier of the customer (can be same as email)
`local_balance`	number	Current balance in the wallet
`currency`	string	Currency used for the wallet (e.g., `BRL`)
`date`	string	Date of the latest wallet status

ℹ️ Notes

All three parameters (wallet_uuid, email, and customer_id) must be included in the query for the request to succeed.
This endpoint is useful for retrieving wallet balances and confirming wallet ownership.