/
5 minute read
March 24, 2022

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

Action: GET
Endpoint: /programreserve/balances

Use this endpoint to return balances for your program reserve 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:

Format: 0.00

balances

object
Conditionally returned

Contains program funding account balance information, organized by currency code. Sometimes referred to as a program reserve account.

Allowable Values:

Existing balances object

credit_balance

decimal
Conditionally returned

Not currently in use.

Allowable Values:

Not applicable

currency_code

string
Conditionally returned

The three-digit ISO 4217 currency code.

Allowable Values:

A 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:

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:

Format: 0.00

Sample response body
JSON
Copied

Is this helpful?

Yes
No

List program funding transactions

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

count

integer
Optional

The number of resources to retrieve.

Allowable Values:

1-10

start_index

integer
Optional

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

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:

lastModifiedTime, createdTime, or any field in the resource model

Response body
Fields Description

count

integer
Conditionally returned

The number of resources to retrieve.

Allowable Values:

1-10

data

array of objects
Conditionally returned

A list of program funding transactions.

Allowable Values:

A valid program funding transaction array

data[].amount

decimal
Conditionally returned

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
Returned

The date and time when the resource was created, in UTC. 2021-10-26T20:03:05Z, for example.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

data[].currency_code

string
Conditionally returned

The three-digit ISO 4217 currency code.

Allowable Values:

A 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. 2021-10-26T20:03:05Z, for example.

Allowable Values:

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

The state of the transaction.

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

The unique identifier of the transaction.

Allowable Values:

An existing transaction token

data[].type

string
Conditionally returned

The type of transaction.

Allowable Values:

CREDIT, DEBIT, PENDING_CREDIT, PENDING_DEBIT

end_index

integer
Conditionally returned

The sort order index of the last resource in the returned array.

Allowable Values:

Any integer

is_more

boolean
Conditionally returned

A value of true indicates that more unreturned resources exist.

Allowable Values:

true, false

start_index

integer
Conditionally returned

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

Sample response body
JSON
Copied

Is this helpful?

Yes
No
Join our developer newsletter