Adjust Balance

Adjust Balance API should be used to update the balance of an account based on an external transfer. For example, if a program funding account is credited by a bank wire, this API can be used to update the balance of the PROGFUND account on the platform.

Request
Security:
Bearer
path Parameters
version
required
string
Request Body schema: application/json
client_reference_id
string or null

Transaction's unique external id from the client's system.

request_code
required
string non-empty

Refer request_code data list to send valid request codes for balance adjustment.

amount
required
number <double>

Transaction amount

currency
required
string 3 characters

Transaction currency in ISO-3 string format.

description
string or null [ 0 .. 128 ] characters

Optional transaction description provided by the API client.

memo_code
string or null <= 64 characters

Client driven code used to add more details to the transaction.

account_guid
string or null <uuid>

Account unique identifier on the platform, for which balance is being adjusted.

wire_date
string or null <date-time>

Reference date in UTC format for the corresponding transaction at bank.

card_proxy
string or null

Unique identifier for card, in case balance adjustment is happening through card reference.

object (Account)
user_guid
string <uuid>

Unique identifier for the user initiating the balance adjustment.

source_code
string or null

Refer source_code list to send valid source code for balance adjustment.

Responses
201

Returns the newly created Wallet

400

Bad request

401

Unauthorized

404

Wallet not found

500

Server Error

post/api/{version}/accounts/AdjustBalance
Request samples
application/json
{
  • "client_reference_id": "string",
  • "request_code": "string",
  • "amount": 0,
  • "currency": "str",
  • "description": "string",
  • "memo_code": "string",
  • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
  • "wire_date": "2019-08-24T14:15:22Z",
  • "card_proxy": "string",
  • "account": {
    • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
    • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
    • "account_type": "string",
    • "account_name": "string",
    • "account_currency": "str",
    • "available_balance": 0,
    • "ledger_balance": 0,
    • "suspense_balance": 0,
    • "starting_balance_date": "2019-08-24T14:15:22Z",
    • "starting_balance_amount": 0,
    • "last_credit_date": "2019-08-24T14:15:22Z",
    • "last_credit_amount": 0,
    • "first_debit_date": "2019-08-24T14:15:22Z",
    • "first_debit_amount": 0,
    • "last_debit_date": "2019-08-24T14:15:22Z",
    • "last_debit_amount": 0,
    • "account_status": "string",
    • "account_status_date": "2019-08-24T14:15:22Z",
    • "holder_account_status": "string",
    • "holder_account_status_date": "2019-08-24T14:15:22Z",
    • "sys_utcinserted": "2019-08-24T14:15:22Z",
    • "sys_utcupdated": "2019-08-24T14:15:22Z",
    • "last_txn_guid": "100ead98-12b5-4d05-9c0c-900006fc8694",
    • "interest_rate_strategy": "string"
    },
  • "user_guid": "2c9a19c5-ac85-4da0-8708-2b80265927da",
  • "source_code": "string"
}
Response samples
application/json
{
  • "client_reference_id": "string",
  • "request_code": "string",
  • "amount": 0,
  • "currency": "str",
  • "description": "string",
  • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
  • "card_proxy": "string",
  • "account": {
    • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
    • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
    • "account_type": "string",
    • "account_name": "string",
    • "account_currency": "str",
    • "available_balance": 0,
    • "ledger_balance": 0,
    • "suspense_balance": 0,
    • "starting_balance_date": "2019-08-24T14:15:22Z",
    • "starting_balance_amount": 0,
    • "last_credit_date": "2019-08-24T14:15:22Z",
    • "last_credit_amount": 0,
    • "first_debit_date": "2019-08-24T14:15:22Z",
    • "first_debit_amount": 0,
    • "last_debit_date": "2019-08-24T14:15:22Z",
    • "last_debit_amount": 0,
    • "account_status": "string",
    • "account_status_date": "2019-08-24T14:15:22Z",
    • "holder_account_status": "string",
    • "holder_account_status_date": "2019-08-24T14:15:22Z",
    • "sys_utcinserted": "2019-08-24T14:15:22Z",
    • "sys_utcupdated": "2019-08-24T14:15:22Z",
    • "last_txn_guid": "100ead98-12b5-4d05-9c0c-900006fc8694",
    • "interest_rate_strategy": "string"
    },
  • "user_guid": "2c9a19c5-ac85-4da0-8708-2b80265927da",
  • "source_code": "string"
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.