DOCS

New!

/

5 minute read

December 1, 2019

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. 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.

  • Credit balance – Not currently used.

  • Pending credits – ACH loads that have been accepted, but for which the funding time has not yet elapsed.

Retrieve transaction and balance information for the program reserve account using the /programreserve/balances and /programreserve/transactions endpoints.

Retrieve GPA balances

Action: GET
Endpoint: /balances/{token}

Develop Now!

Sign in and use your sandbox to access the API Explorer

Use this endpoint to return general purpose account (GPA) balances for a user or business. The return object includes a link to balances of related user GPAs.

URL path parameters

Fields Description

token

string required

The token identifying the user or business whose GPA balances you want to retrieve.

Allowable Values: Existing user or business token.

Send a GET request to /users or /businesses to retrieve user or business tokens.

Sample response body

{
  "gpa": {
    "currency_code": "USD",
    "ledger_balance": 1000,
    "available_balance": 990,
    "credit_balance": 0,
    "pending_credits": 0,
    "balances": {
      "USD": {
        "currency_code": "USD",
        "ledger_balance": 1000,
        "available_balance": 990,
        "credit_balance": 0,
        "pending_credits": 0
      }
    }
  },
   "links": [
    {
      "rel": "gpa",
      "method": "GET",
      "href": "/v3/balances/my_user_01/gpa"
    }
  ]
}

Is this helpful?

Retrieve reserve account balances

Action: GET
Endpoint: /programreserve/balances

Develop Now!

Sign in and use your sandbox to access the API Explorer

Use this endpoint to return balances for your program’s reserve account. See Balances for descriptions of each balance.

Sample response body

{
  "currency_code": "USD",
  "ledger_balance": 10100,
  "available_balance": 10100,
  "credit_balance": 0,
  "pending_credits": 0,
  "balances": {
    "USD": {
      "currency_code": "USD",
      "ledger_balance": 10100,
      "available_balance": 10100,
      "credit_balance": 0,
      "pending_credits": 0
    }
  }

Is this helpful?

List reserve account transactions

Action: GET
Endpoint: /programreserve/transactions

Develop Now!

Sign in and use your sandbox to access the API Explorer

Use this endpoint to return a list of credits and debits to your program’s reserve account.

This endpoint supports sorting and pagination.

Sample response body

{
  "count": 2,
  "start_index": 0,
  "end_index": 1,
  "is_more": false,
  "data": [
    {
      "created_time": "2019-05-10T21:52:18Z",
      "last_modified_time": "2019-05-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": "2019-05-10T21:51:28Z",
      "last_modified_time": "2019-05-10T21:51:28Z",
      "token": "my_deposit_01",
      "amount": 100,
      "currency_code": "USD",
      "memo": "my_memo",
      "tags": "my, tags",
      "transaction_token": "153",
      "type": "CREDIT"
    }
  ]
}

Is this helpful?

Have any feedback on this page?

If you feel we can do anything better, please let our team know.

We strive for the best possible developer experience.