/
5 minute read
March 24, 2022

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

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
Fields Description

token

string
Required

The unique identifier of the user or business for which you want to return GPA balances.

Allowable Values:

Existing user or business token

Response body
Fields Description

gpa

object
Returned

Returns general purpose account (GPA) balances for a user or business.

Allowable Values:

Valid gpa object

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:

Existing balances object

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

The three-digit ISO 4217 currency code.

Allowable Values:

A 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

The date and time when the resource was last updated, in UTC. 2022-01-26T20:03:15Z, for example.

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

An array of links to balances of related user GPAs.

Allowable Values:

Valid links array

links[].href

string
Returned

The URL of the requested /balances resource.

Allowable Values:

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
Copied

Is this helpful?

Yes
No
Join our developer newsletter