Status Account

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

Request
Security:
path Parameters
account_guid
required
string <uuid>

Account unique identifier on the platform

version
required
string
Request Body schema: application/json

account status request

account_status
required
string (AccountStatus)

Account status code.

Enum: "SYSTEM" "ACTIVE" "FREEZE" "CLOSED" "OPTOUT"
reason_code
string or null

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

reason_description
string or null

Optional Additional info to be sent by client

Responses
200

Returns the account details

400

Bad request

401

Unauthorized

404

Account not found

500

Server Error

post/api/{version}/accounts/{account_guid}/status
Request samples
application/json
{
  • "account_status": "SYSTEM",
  • "reason_code": "string",
  • "reason_description": "string"
}
Response samples
application/json
{
  • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
  • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
  • "account_currency": "string",
  • "account_name": "string",
  • "account_type": "GENERAL",
  • "available_balance": 0,
  • "ledger_balance": 0,
  • "suspense_balance": 0,
  • "advance_account_details": {
    • "account": {
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "client_reference_id": "6970735e-7ed9-436b-b2f2-f25200dba6b0",
      • "start_date": "2019-08-24T14:15:22Z",
      • "limit": 0,
      • "outstanding_balance": 0,
      • "credit_product": "string",
      • "cycle": "string",
      • "status": "string",
      • "payment_summary": {
        • "outstanding_principal": 0,
        • "disbursement_amount": 0,
        • "processing_fees": 0,
        • "carriedbalance_fees": 0,
        • "total_repayment": 0,
        • "number_of_payments": 0
        },
      • "payment_schedule": [
        • {
          • "mob": 0,
          • "date": "2019-08-24T14:15:22Z",
          • "disbursement_principal": 0,
          • "disbursement_fee": 0,
          • "total": 0,
          • "fee": 0,
          • "principal": 0,
          • "balance": 0,
          • "paid_principal": 0,
          • "paid_interest": 0,
          • "available_balance": 0,
          • "cycle": "string",
          • "type": "string",
          • "status": "string"
          }
        ],
      • "available_date_range": [
        • {
          • "name": "string",
          • "date": "2019-08-24T14:15:22Z"
          }
        ]
      }
    },
  • "account_status": "SYSTEM",
  • "last_txn_guid": "100ead98-12b5-4d05-9c0c-900006fc8694",
  • "post_date": "2019-08-24T14:15:22Z",
  • "amount": 0,
  • "mask_account_number": "string",
  • "sys_utcinserted": "2019-08-24T14:15:22Z",
  • "status_change_nonmon_detail": {
    • "nonmon_guid": "3df16cd2-de7f-4e81-936e-7604855d1fd7",
    • "txn_date": "2019-08-24T14:15:22Z",
    • "channel_name": "string",
    • "request_code": "string",
    • "reason_code": "string",
    • "response_code": "string",
    • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
    • "hash_account_number": "string",
    • "remarks": "string",
    • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
    • "journal_guid": "019b8be6-224f-4e54-91ec-2a471754d334",
    • "support_user_guid": "334ad5b0-1427-4c28-aac8-2d6e9614b4d0",
    • "source_code": "string",
    • "source_user_guid": "0aaedba8-146e-40a6-ad5f-54c512699647",
    • "reference_number": "string",
    • "outsort_guid": "eef602a5-424d-4eae-b4d8-4521969d8873",
    • "order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
    • "processing_start_date": "2019-08-24T14:15:22Z",
    • "processing_end_date": "2019-08-24T14:15:22Z"
    }
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.