Retrieve prefund balances
What is a Prefund?
In the context of a financial platform, a prefund refers to the capital deposited in advance by a partner into a centralized reserve—specifically, the partner pool account.
This pre-allocated funding acts as working capital to ensure smooth, real-time operations across the platform. Instead of processing bank transfers or settling funds for every individual user transaction one by one, the platform draws directly from this prefunded pool. This allows for instant authorization and seamless processing of everyday activities, such as onboarding users, provisioning accounts, and facilitating transactions.
In short, it is the upfront balance required to ensure all subsequent financial movements within the program are fully backed and can execute immediately.
Prefund Balances
Program (Credit) Prefund Balance
The Program Prefund Balance represents the partner's central pool account or their primary institutional account within the platform. It serves as the overarching funding source for the partner's program operations.
Debit Prefund Balance
The Debit Prefund Balance represents the cumulative total of all individual user account balances within the platform. As new users are onboarded, they are provisioned with their own individual accounts; the debit prefund balance acts as the aggregate sum of the funds held across all of these specific user accounts. In simpler terms, the debit prefund balance is the balance of all your users in the platform.
Use Cases
- You want to know the current program prefund balance of the partner pool account.
- You want to know the current debit prefund balance, which is the cumulative balance of all the user accounts in the platform.
Prerequisites
- The program has been configured, and the staging stack has been provisioned.
- The program staging stack has already been handed over to the partner.
- The partner is already in possession of the API credentials to access the endpoints.
API Workflow
1
Retrieve the program prefund balance
Call the Get Program Credit (Partner) Prefund (GET /oauth/consumer/{{consumer_key}}/prefund/credit ) to retrieve the current outstanding balance of the program prefund in the platform.
Get Program Credit (Partner) Prefund request
curl --location 'https://{{accounts_base_url}}/{{program_code}}/v1/oauth/consumer/{{consumer_key}}/prefund/credit' \
--header 'Authorization: ••••••''
consumer_keyis one of the keys from your API credentials. More details can be found here.
Get Program Credit (Partner) Prefund response
{
"balance": "91224459.010000"
}
2
Retrieve the debit prefund balance
Call the Get Program Debit (Users) Prefund (GET /oauth/consumer/{{consumer_key}}/prefund/debit ) to retrieve the current outstanding balance of all the user accounts in the platform.
Get Program Debit (Users) Prefund request
curl --location 'https://{{accounts_base_url}}/{{program_code}}/v1/oauth/consumer/{{consumer_key}}/prefund/debit' \
--header 'Authorization: ••••••''
consumer_keyis one of the keys from your API credentials. More details can be found here.
Get Program Debit (Users) Prefund response
{
"balance": "7222159.010000"
}
3
Keeping track of your prefund balances
Keeping a close eye on your prefund balances is crucial to maintaining seamless program operations. Because your platform activities draw directly from this central pool, maintaining an adequate balance ensures that your incoming transactions—such as card and wallet transactions, domestic and cross-border payouts, and other payments within the platform—are always fully funded and can be processed without interruption.
To help you manage your funds effectively, we provide two layers of monitoring:
1. Automated Alerts via AdminNet You can easily monitor your funds by setting up custom email notification events directly within AdminNet, your administrator dashboard. By configuring specific balance thresholds, you will receive immediate automated email alerts whenever your prefund is running low, allowing you to top up your account proactively.
2. Proactive Monitoring by Our Finance Department As an added layer of assurance, our Finance Department actively monitors your prefund levels. Using a monthly velocity forecast based on your specific program volume, our team will keep track of your balance trajectory and personally notify your assigned contact if your funds are at risk of running too low.
On this page
- Retrieve prefund balances