v1

latestOpenAPI 3.0.02026-07-242035712.0 MB

Group

View Group Information

This API enables you to retrieve a list of all current groups or a specific group under your Client_ID. It proves to be particularly valuable when integrated into for example, a client middleware for card life cycle management. It can be utilized, for instance, to display the available group IDs that can be added in the create card API call or simply validating the existing group structure.

post/pws/pws_group_list/

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

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

group_idinteger

group Id. Returns data for provided group Id only

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": [
    {
      "group_id": 103,
      "group_desc": "Container For Fraud rules",
      "group_name": "Test group",
      "group_type": "General Container",
      "risk_level": "Default"
    }
  ]
}