Retrieve reserve account balances
Action:GETEndpoint:
/programreserve/balances
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
}
}
}
List program reserve transactions
Action:GETEndpoint:
/programreserve/transactions
Use this endpoint to return a list of credits and debits made to your program reserve account.
This endpoint supports sorting and pagination.
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of resources to retrieve. Allowable Values: 1-10 Default value: 5 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: Any integer Default value: 5 |
| sort_by string Optional | Field on which to sort. Use any field in the resource model, or one of the system fields lastModifiedTime or createdTime. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.Allowable Values: createdTime, lastModifiedTime, or any field in the resource modelDefault value: -createdTime |
Response body
| Fields | Description |
|---|---|
| count integer Conditionally returned | Number of resources to retrieve. This field is returned if there are resources in your returned array. Allowable Values: 1-10 |
| data array of objects Conditionally returned | List of program reserve transactions. Objects are returned as appropriate to your query. Allowable Values: Valid array of one or more program reserve transaction objects |
| data[].amount decimal Conditionally returned | Amount of the program reserve account credit or debit. Sometimes referred to as a program funding account. Allowable Values: decimal Format: 0.00 |
| data[].created_time datetime Returned | Date and time when the resource was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].currency_code string Conditionally returned | Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
| data[].last_modified_time datetime Returned | The date and time when the resource was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].memo string Conditionally returned | Memo or note describing the transaction. Allowable Values: 99 char max |
| data[].state string Conditionally returned | Transaction state. Allowable Values: PENDING, COMPLETE |
| data[].tags string Conditionally returned | Comma-delimited list of tags describing the transaction. Allowable Values: 255 char max |
| data[].token string Conditionally returned | The unique identifier of the transaction response. Allowable Values: 36 char max |
| data[].transaction_token string Conditionally returned | Unique identifier of the transaction. Allowable Values: Existing transaction token |
| data[].type string Conditionally returned | Transaction type. Allowable Values: CREDIT, DEBIT, PENDING_CREDIT, PENDING_DEBIT |
| end_index integer Conditionally returned | Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
| is_more boolean Conditionally returned | A value of true indicates that more unreturned resources exist. A value of false indicates that no more unreturned resources exist.This field is returned if there are resources in your returned array. Allowable Values: true, false |
| start_index integer Conditionally returned | Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
Sample response body
JSON
{
"count": 2,
"start_index": 0,
"end_index": 1,
"is_more": false,
"data": [
{
"created_time": "2024-02-10T21:52:18Z",
"last_modified_time": "2024-02-10T21:52:18Z",
"token": "my_deposit_02",
"amount": 120,
"currency_code": "USD",
"memo": "my_memo",
"tags": "my, tags",
"transaction_token": "154",
"type": "CREDIT"
},
{
"created_time": "2024-02-10T21:51:28Z",
"last_modified_time": "2024-02-10T21:51:28Z",
"token": "my_deposit_01",
"amount": 100,
"currency_code": "USD",
"memo": "my_memo",
"tags": "my, tags",
"transaction_token": "153",
"type": "CREDIT"
}
]
}