Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Group

Create group

The Create Group API enables the creation of group containers that apply any attributes assigned to the group to linked accounts during Card Creation or throughout the card's lifecycle. <br> Group types are beneficial for segmenting according to the options listed below, for day-to-day management of accounts and group segmentation. These types will also be visible when reviewing rules under group segmentation using Paycontrol.

post/pws/pws_group_create/

Request body

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

group_descstring required

group Description

group_namestring required

group Name

group_typeinteger required

Indicates the type of group. They are listed below:<ul>

<li class="docBullet" >group_type =2 indicates General Container</li> <li class="docBullet" >group_type =3 indicates Fees group</li> <li class="docBullet" >group_type =4 indicates Auth activities</li> <li class="docBullet" >group_type =5 indicates Settlement Activities</li> <li class="docBullet" >group_type =6 indicates Scheduled Tasks</li> <li class="docBullet" >group_type =7 indicates Fraud Assessment</li> <li class="docBullet" >group_type =8 indicates AI rules</li> <li class="docBullet" >group_type =9 indicates wallet Interactions</li> </ul>
risk_levelstring required

Risk Level .Supported Value for risk level are : <ul>

<li class="docBullet" >Default</li> <li class="docBullet" >Low</li> <li class="docBullet" >Very Low</li> <li class="docBullet" >High</li> <li class="docBullet" >Very High</li> <li class="docBullet" >Custom</li> </ul>
user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "group_desc": "Testing group Description",
  "group_name": "Testing group",
  "group_type": 2,
  "risk_level": "Default"
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "id": 183
  }
}