Accounts

Status Account

Use this API end point to change the status of an account based on the account guid.

post/connected-deposits/{version}/accounts/{account_guid}/status

Request

Path parameters

account_guidstring uuid required

Account unique identifier on the platform

versionstring required

Request body

account_status'SYSTEM' | 'ACTIVE' | 'FREEZE' | 'CLOSED' | 'OPTOUT' required
reason_codestring nullable

Refer reason_code master data list to send valid reason code for status change

reason_descriptionstring nullable

Optional Additional info to be sent by client

Response

Returns the account details

account_guidstring uuid

Unique identifier of the account on the platform.

wallet_guidstring uuid

Unique identifier of the wallet on the platform.

account_currencystring nullable

Currency of account in ISO-3 string format.

account_namestring nullable

Name of account provided by the API client.

account_type'GENERAL' | 'PROGFUND' | 'CHECK' | 'REVENUE' | 'COLLECTION' | 'PRINCIPAL' | 'SECURE' | 'CREDIT' | 'USERDEFINED' | 'ADVANCE' | 'PROG_DISBURSE' | 'EXCEPTION' | 'WRITEOFF' | 'SUSPENSE' | 'OMNI_OFFSET' | 'INTHOLD' | 'OPERATION'
available_balancenumber double
ledger_balancenumber double
suspense_balancenumber double
account_status'SYSTEM' | 'ACTIVE' | 'FREEZE' | 'CLOSED' | 'OPTOUT'
last_txn_guidstring uuid nullable
post_datestring date-time nullable
amountnumber double nullable
mask_account_numberstring nullable

Last four digits of account number

sys_utcinsertedstring date-time
status_change_nonmon_detailTxnNonmonDetail

Changes

No recorded changes to this operation across all 1 revision of this API.