PApaymentology
Ledger API - Accounts

Create account

<ul> <li class="docBullet">Ledger API version of the PWS <a href="https://developer.paymentology.com/bankinglive/reference/v2_pws_create_account">Create account V2</a> call. Request and response use the same format, served by the Ledger API.</li> <li class="docBullet">All accounts sit in an account hierarchy: <code>ac_parent_id</code> is required and the new account becomes its child.</li> <li class="docBullet">Use <code>program_code</code> to assign the account to a program.</li> </ul>
post/pty/account/v1/pws_create_account

Request

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

Request body

ac_bill_ccystring required

Billing currency (Three digit ISO-4217 currency code, e.g. 048=BHD, 060=BMD, 036=AUD)

ac_parent_idinteger required

Parent account. Newly created accounts under a parent account will have parent-child hierarchy.

ac_set_ccystring required

Settlement currency (Three digit ISO-4217 currency code, e.g. 048=BHD, 060=BMD, 036=AUD)

account_namestring required

Account holder name

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

ac_descstring

Description for the account holder.

ac_ext_refstring

Account external reference.

crd_prdct_idinteger

Card product id. Must be a correct product id so the account inherits required properties and links with business.

ac_level2 | 3 | 4 | 5 | 6

Account hierarchy level (charge card programs only): 2=Master client account level 3=Corporate parent account 4=Department account 5=Customer parent account 6=Customer account

cu_idinteger

Customer Id to link the newly created account to the provided customer. You can get customer id after creating customer using pws_create_customer

branch_namestring

Branch name

program_codestring

Program code for the account. When provided, program_id is ignored. Defaults to the configured default program code if neither is provided.

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_bill_ccy": "048",
  "ac_parent_id": 542283189,
  "ac_set_ccy": "826",
  "account_name": "John Blogs",
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "user_id": "string",
  "remarks": "string",
  "ac_desc": "New account Desc",
  "ac_ext_ref": "0",
  "crd_prdct_id": 2,
  "ac_level": 2,
  "cu_id": 583198689,
  "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).

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "ac_id": 9876542
  }
}

Changes

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