Using a Wallet

🚧

To begin using the Wallet API, please contact [email protected] so you can be given access to our test mode wallet!

Overview

This guide provides an overview of the PayMongo Wallet, detailing essential attributes such as wallet identifiers, balance information, and environment status. It covers components like Wallet ID, type, account number, transaction limits, and operational states. Whether you’re enabling wallet top-ups, checking balances, or managing access, this guide will help ensure smooth integration.

Use it alongside our Authorization and Wallet Account Resource documentation for a secure and seamless implementation.

Definition of Terms

TermDefinition
Wallet IDThe unique identifier assigned to an individual PayMongo Wallet.
Wallet TypeClassification of wallet based on purpose and business type.
Account NumberUnique number assigned to the PayMongo Wallet. Use this to cash in or top up your PayMongo Wallet.
Available BalanceAmount of money currently accessible for use in the wallet or account.
LimitsPredefined thresholds on transactions and balances, based on Wallet Type. See limits here.
LivemodeIndicates whether the wallet is operating in a real (live) environment or in sandbox mode.
StatusThe operational state of the wallet (active, deactivated). Availability of the services depends on this status.
Created & Updated atTimestamps showing when the wallet was initially created and when it was last modified.

Implementation

Authorization

Authenticate your API requests using your PayMongo secret key. This ensures that your transactions and data are secure. To learn more about PayMongo’s authentication, you can check it out here.

Getting Started

To get relevant Wallet information (such as Wallet ID, account number, balances, etc), our guide on the Wallet Account Resource should help.

📘

# Test Mode Guidelines

  • Once you have been provisioned a test mode wallet, you can view your test keys in your PayMongo dashboard.
  • Your test wallet will have a limit of Php 100,000.00, but this is a test value to play around our sandbox.
  • When authorizing your use of our APIs, you may use this Authorization Guide using your secret key.
  • When testing outward transactions, you may use this guide for Wallet API test cases.
  • To retrieve your wallet transactions, you may use this guide for Retrieving Wallet transactions.