PApaymentology
Ledger API - Accounts

Edit account

<ul> <li class="docBullet">Ledger API version of the PWS <a href="https://developer.paymentology.com/bankinglive/reference/pws_account_edit">Edit Account</a> call. Request and response use the same format, served by the Ledger API.</li> <li class="docBullet">Editable fields: account_name, ac_desc, ac_ext_ref, branch_name, guarantee_amount, guarantee_id and program_code. Account currencies and the parent account cannot be changed.</li> <li class="docBullet">The account must be linked to a program; otherwise the request is rejected.</li> </ul>
post/pty/account/v1/pws_account_edit

Request

  • Base URL
    https://api.uat.paymentology.com
  • URL
    https://api.uat.paymentology.com/pty/account/v1/pws_account_edit
  • Auth
    HTTP bearer

Request body

ac_idinteger required

The unique Account ID used for updating account details

api_call_unique_identifierstring required

Unique number that must be passed at each API request. Identifier to make each API request unique

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

account_namestring

Account holder name

ac_descstring

Description for the account holder.

ac_ext_refstring

Account external reference.

guarantee_amountnumber double

Guarantee Amount (credit related editable field)

guarantee_idinteger

Guarantee Type Id (credit related editable field)

branch_namestring

Branch name

program_codestring

Program code for the account. When provided, program_id is ignored.

program_idinteger

Deprecated. Use program_code instead. Ignored when program_code is provided. Program ID for the account. Must be one of the configured program IDs.

Example request

{
  "ac_id": 9876542,
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "user_id": "string",
  "remarks": "string",
  "account_name": "John Blogs",
  "ac_desc": "Updated account description",
  "ac_ext_ref": "EXT-001",
  "guarantee_amount": 10000.5,
  "guarantee_id": 2,
  "branch_name": "pokhara",
  "program_id": 100
}

Response

Request processed. Check header.error_id: 0 means success. Any other value is a business error, reported with HTTP 200 and an empty body. Common codes: 992 (invalid account id), 993 (invalid card token), 995 (validation failed), 1043 (account does not belong to the client), 1055 (invalid program_code), 1531 (invalid customer id).

bodyobject required

Empty body for successful account edit

Example response

{
  "header": {
    "error_desc": "success"
  }
}

Changes

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