Deposits

Manage and retrieve deposit related information

Deposits are an essential aspect of your financial operations on Graph, and here you can access endpoints for managing and retrieving deposit-related information.

Available endpoints here include:

  • Fetch Deposit: Use this endpoint to retrieve detailed information about a specific deposit. Whether you need to confirm a successful transaction or verify deposit details, the "Fetch Deposit" endpoint provides you with comprehensive data.
  • List Deposits: With the "List Deposits" endpoint, you can obtain a summary of all deposits associated with your Graph account. This feature is particularly useful for tracking your deposit history and staying informed about your financial activities.
  • Mock Deposit (Sandbox Only): The "Mock Deposit" endpoint is designed for testing purposes in the sandbox environment. It allows you to fund your test master account with simulated funds, enabling you to test Graph's card or account APIs without real transactions. Deposit in production may be done via transfer to the generated bank account details.

🚧

Important considerations for mocking a deposit:

  • Graph follows the ISO 4217 format for currency codes. When initiating deposits or charges, ensure that your payment amount is in subunits of the currency. For example, if you intend to deposit USD 100, you should send 10000 (100 * 100) in your request. The same applies to NGN transactions.
  • To fund an account, you'll need the account ID. You can easily retrieve this ID by using the "List Accounts" endpoint, which provides a list of your available accounts.
  • Test bank accounts labeled with terms such as "wallet funding type" are considered master accounts suitable for mock deposits. These accounts are ideal for simulating deposits and charges during your testing phase.

Testing Mobile Money

When integrating Mobile Money in the sandbox environment, you can predictably trigger successful and failed transaction states using specific phone numbers. Using any phone number outside of the specific "Failed" numbers listed below will default to a Successful transaction.

Testing Pay-ins (Deposits)

To test the full deposit lifecycle, initiate a mobile money deposit in the sandbox using the phone numbers below.

If the currency flow requires an OTP (e.g., GHS, TZS, XOF), you must provide 123456 as the OTP when calling the Verify endpoint.

ScenarioMobile NumberCurrencyAuth Model
Successful Payment+254700000000 (or any random number)KESSTK Prompt
Failed Payment+254734611986KESSTK Prompt
Successful Payment+233240000000 (or any random number)GHSOTP (123456)
Failed Payment+233274611986GHSOTP (123456)
Successful Payment+237655123456 (or any random number)XAFSTK Prompt
Failed Payment+237677123456XAFSTK Prompt
Successful Payment+2250500000000 (or any random number)XOFOTP (123456)
Failed Payment+2250123456789XOFOTP (123456)
Successful Payment+255780000000 (or any random number)TZSOTP (123456)
Failed Payment+255780000002TZSOTP (123456)

📘

Note on Background Settlement

In the sandbox, after successfully verifying a mobile money deposit, the system will wait approximately 2 seconds before automatically transitioning the deposit to its final state (successful or failed) and firing the respective webhook.