GET//
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
| Fields | Description |
|---|---|
| token string Required | 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
| Fields | Description |
|---|---|
| gpa object Returned | Returns general purpose account (GPA) balances for a user or business. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| gpa.available_balance decimal Returned | 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 Returned | Contains GPA balance information, organized by currency code. Allowable Values: One or more balances objects |
| gpa.cached_balance decimal Returned | Not currently in use. Allowable Values: Not applicable |
| gpa.credit_balance decimal Returned | Not currently in use. Allowable Values: Not applicable |
| gpa.currency_code string Returned | Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code. |
| gpa.impacted_amount decimal Conditionally returned | Balance change based on the amount of the transaction. Allowable Values: Format: 0.00 |
| gpa.last_updated_time datetime Returned | Date and time when the resource was last updated, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| gpa.ledger_balance decimal Returned | 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 Returned | 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 Returned | Array of links to balances of related user GPAs. Allowable Values: Valid array of one or more links objects |
| links[].href string Returned | URL of the requested /balances resource.Allowable Values: A valid URL |
| links[].method string Returned | The HTTP method of the link. Allowable Values: GET currently supported |
| links[].rel string Returned | Specifies the relationship between the current resource and the linked resource. Allowable Values: gpa currently supported |
Sample response body
JSON
{
"gpa": {
"currency_code": "USD",
"ledger_balance": 1000,
"available_balance": 990,
"pending_credits": 0,
"balances": {
"USD": {
"currency_code": "USD",
"ledger_balance": 1000,
"available_balance": 990,
"pending_credits": 0
}
}
},
"links": {
"rel": "gpa",
"method": "GET",
"href": "/v3/balances/my_user_01/gpa"
}
}