GET//
Use this endpoint to return balances for your program reserve account (sometimes referred to as a program funding account).
Response body
| Fields | Description |
|---|---|
| available_balance decimal Conditionally returned | Ledger balance, minus any authorized transactions that have not yet cleared. When using JIT Funding, this balance is usually equal to $0.00. Allowable Values: decimal Format: 0.00 |
| balances object Conditionally returned | Contains program reserve account balance information, organized by currency code. Sometimes referred to as a program funding account. Allowable Values: Valid balances object |
| credit_balance decimal Conditionally returned | Not currently in use. Allowable Values: Not applicable |
| currency_code string Conditionally returned | Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
| ledger_balance decimal Conditionally 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: decimal Format: 0.00 |
| pending_credits decimal Conditionally returned | ACH loads that have been accepted, but for which the funding time has not yet elapsed. Allowable Values: decimal Format: 0.00 |
Sample response body
JSON
{
"currency_code": "USD",
"ledger_balance": 10100,
"available_balance": 10100,
"pending_credits": 0,
"balances": {
"USD": {
"currency_code": "USD",
"ledger_balance": 10100,
"available_balance": 10100,
"pending_credits": 0
}
}
}