/
5 minute read
September 30, 2021

Balances

Hidden

Use the /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.

  • Credit balance – Not currently used.

  • Pending credits – ACH loads that have been accepted, but for which the funding time has not yet elapsed.

Retrieve transaction and balance information for the program reserve account using the /programreserve/balances and /programreserve/transactions endpoints.

Retrieve GPA balances

Action: GET
Endpoint: /balances/{token}

Use this endpoint to return general purpose account (GPA) balances for a user or business. The return object includes a link to balances of related user GPAs.

URL path parameters
Fields Description

token

string
Required

The token identifying the user or business whose GPA balances you want to retrieve.

Allowable Values: Existing user or business token.

Send a GET request to /users or /businesses to retrieve user or business tokens.

Sample response body
Copied

Is this helpful?

Yes
No

Retrieve reserve account balances

Action: GET
Endpoint: /programreserve/balances

Use this endpoint to return balances for your program’s reserve account. See Balances for descriptions of each balance.

Sample response body
Copied

Is this helpful?

Yes
No

List reserve account transactions

Action: GET
Endpoint: /programreserve/transactions

Use this endpoint to return a list of credits and debits to your program’s reserve account.

This endpoint supports sorting and pagination.

Sample response body
Copied

Is this helpful?

Yes
No

Feedback on this page?

If you feel we can do anything better, please let our team know.