RocketKOR

Introduction

Authentication

Sorting and Pagination

Errors

Retrieve Financial Account Balances

Retrieve the balances for a Financial Account. This includes the account balance, available funds, pending withdrawals, and pending deposits. Balances are returned for each supported currency for the Financial Account.

Balances are only returned for internal RocketKOR Financial Accounts. Balances are not returned for external accounts, such as a Recipient debit card.

Endpoint

GET /financial-accounts/{financialAccountId}/balances

Authorization Header

Authorization: Bearer <access_token>

where <access_token> is your RocketKOR access token.

Path Parameters

financialAccountId  REQUIRED

string (UUID)

Financial Account ID.

Request Body

None

Returns

Returns the Financial Account balances. For details, see the Financial Account Balances object.

SAMPLE RESPONSE

				
					{
  "USD": {
    "accountBalance": "1000.00",
    "availableBalance": "800.00",
    "pendingWithdrawals": "200.00",
    "pendingDeposits": "250.00"
  },
  "CAD": {
    "accountBalance": "700.00",
    "availableBalance": "600.00",
    "pendingWithdrawals": "100.00",
    "pendingDeposits": "300.00"
  }
}