/balances endpoint to retrieve the following general purpose account (GPA) balance details for a user or business:
- Ledger balance - When using standard funding: The funds that are available to spend immediately, including funds from any authorized transactions that have not yet cleared. When using Just-in-Time (JIT) Funding: Authorized funds that are currently on hold, but not yet cleared.
- Available balance - The ledger balance minus any authorized transactions that have not yet cleared. Also known as the cardholder’s purchasing power. If you are using JIT Funding, this balance is usually 0.00.
- Cached balance - Not currently used.
- Credit balance - Not currently used.
- Pending credits - ACH loads that have been accepted, but for which the funding time has not yet elapsed.
Retrieve GPA balances
Action:GETEndpoint:
/balances/{token}
Use this endpoint to return general purpose account (GPA) balances for a user or a business. The response object includes a link to balances of related user GPAs.
URL path parameters
Response body
Sample response body
JSON