Balances
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.
-
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
Copy section link
Action: GET
Endpoint: /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
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the user or business for which you want to return GPA balances. Allowable Values: Existing user or business resource token |
Response body
Copy section link
| Fields | Description |
|---|---|
gpa
object
|
Returns general purpose account (GPA) balances for a user or business. Allowable Values:
|
gpa.available_balance
decimal
|
Ledger balance minus any authorized transactions that have not yet cleared. Also known as the cardholder’s purchasing power. When using JIT Funding, this balance is usually equal to $0.00. Allowable Values: Format: 0.00 |
gpa.balances
object
|
Contains GPA balance information, organized by currency code. Allowable Values: One or more balances objects |
gpa.cached_balance
decimal
|
Not currently in use. Allowable Values: Not applicable |
gpa.credit_balance
decimal
|
Not currently in use. Allowable Values: Not applicable |
gpa.currency_code
string
|
Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code. |
gpa.impacted_amount
decimal
|
Balance change based on the amount of the transaction. Allowable Values: Format: 0.00 |
gpa.last_updated_time
datetime
|
Date and time when the resource was last updated, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
gpa.ledger_balance
decimal
|
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. Allowable Values: Format: 0.00 |
gpa.pending_credits
decimal
|
ACH loads that have been accepted, but for which the funding time has not yet elapsed. Allowable Values: Format: 0.00 |
links
array of objects
|
Array of links to balances of related user GPAs. Allowable Values: Valid array of one or more |
links[].href
string
|
URL of the requested Allowable Values: A valid URL |
links[].method
string
|
The HTTP method of the link. Allowable Values:
|
links[].rel
string
|
Specifies the relationship between the current resource and the linked resource. Allowable Values:
|