Program Funding
Use the Program Funding API to credit or debit your program funding account (sometimes referred to as a program reserve account), and to return program funding balances and transactions.
Retrieve funding account balances
Copy section link
Action: GET
Endpoint: /programreserve/balances
Use this endpoint to return balances for your program reserve account.
Response body
Copy section link
| Fields | Description |
|---|---|
available_balance
decimal
|
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: Format: 0.00 |
balances
object
|
Contains program funding account balance information, organized by currency code. Sometimes referred to as a program reserve account. Allowable Values: Existing |
credit_balance
decimal
|
Not currently in use. Allowable Values: Not applicable |
currency_code
string
|
The three-digit ISO 4217 currency code. Allowable Values: A valid three-digit ISO 4217 currency code |
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 |
pending_credits
decimal
|
ACH loads that have been accepted, but for which the funding time has not yet elapsed. Allowable Values: Format: 0.00 |
List program funding transactions
Copy section link
Action: GET
Endpoint: /programreserve/transactions
Use this endpoint to return a list of credits and debits to your program reserve account.
This endpoint supports sorting and pagination.
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources to retrieve. Allowable Values: 1-10 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
sort_by
string
|
Field on which to sort.
Use any field in the resource model, or one of the system fields Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources to retrieve. Allowable Values: 1-10 |
data
array of objects
|
A list of program funding transactions. Allowable Values: A valid program funding transaction array |
data[].amount
decimal
|
The amount of the program funding account credit or debit. Sometimes referred to as a program reserve account. Allowable Values: Format: 0.00 |
data[].created_time
datetime
|
The date and time when the resource was created, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
data[].currency_code
string
|
The three-digit ISO 4217 currency code. Allowable Values: A valid three-digit ISO 4217 currency code |
data[].last_modified_time
datetime
|
The date and time when the resource was last modified, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
data[].memo
string
|
Memo or note describing the transaction. Allowable Values: 99 char max |
data[].state
string
|
The state of the transaction. Allowable Values:
|
data[].tags
string
|
Comma-delimited list of tags describing the transaction. Allowable Values: 255 char max |
data[].token
string
|
The unique identifier of the transaction response. Allowable Values: 36 char max |
data[].transaction_token
string
|
The unique identifier of the transaction. Allowable Values: An existing transaction token |
data[].type
string
|
The type of transaction. Allowable Values:
|
end_index
integer
|
The sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |