Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Account

Create Account

<ul> <li class="docBullet">Allows to create an account in the Paymentology ledger.</li> <li class="docBullet">The user can, optionally, create an external reference for this account should they require.</li> <li class="docBullet">All accounts must sit within an account hierarchy in the ledger. This means that a parent account must be provided by the user.</li> <li class="docBullet">The new account is then a child of the parent account.</li> <li class="docBullet">This hierarchy is beneficial to the user as it allows accounts to be related as wallets and allows for reporting at multiple hierarchy levels.</li> </ul>
post/pws/pws_create_account/

Request body

ac_bill_ccystring required

Billing currency (Three digit ISO_4217 standard currency code . i.e. : 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 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD).

account_name'range[-infinity, 50]' 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. (Need to input correct product id for your card so it will inherit full required properties and be fully linked with business.)

ac_levelinteger

Account hierarchy is only applicable to charge card programs. <ul> <li class="docBullet">2 = Master client account level</li> <li class="docBullet">3 = Corporate parent account</li> <li class="docBullet">4 = Department account</li> <li class="docBullet">5 = Customer parent account </li> <li class="docBullet">6 = Customer account</li></ul>

cu_idinteger

Customer Id to link the newly created account to the provided customer. You can get customer id after creating customer using <a href="#operation/pws_create_customer" class="external-link">pws_create_customer</a>

branch_name'range[-infinity, 50]'

branch name.

Example request

{
  "ac_bill_ccy": "048",
  "ac_parent_id": 542283189,
  "ac_set_ccy": "826",
  "account_name": "Joe Blogs",
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "ac_desc": "New account Desc",
  "ac_ext_ref": "0",
  "crd_prdct_id": 2,
  "ac_level": 2,
  "cu_id": 583198689,
  "branch_name": "pokhara"
}

Response

Successful Response

Example response

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