PApaymentology
Installment

Set Installment Eligibility Criteria

Changed on

This web service allows to set installment eligibility criteria

post/pws/pws_set_installment_eligibility_criteria

Request

  • Base URL
    https://api.uat.paymentology.com/ppws/api
  • URL
    https://api.uat.paymentology.com/ppws/api/pws/pws_set_installment_eligibility_criteria
  • Auth
    none declared

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

condition_function_callstring required
<p>Condition Function Call to determine if the contract with the given (template_id, client_id) can be applied.</br>Condition function call are set differently for different installment type.Following are the condition function call to be set based on installment type.<ul><li>For Non-scheme Fee: Fee-fee_id eg.Fee-17</li><li> For Non-scheme Financial Transaction: FAD-txn_code eg.FAD-123456</li><li> For Statement Balance: Due_Amount-Minimum Amount to be paid eg. Due_Amount-500</li><li> For Scheme Transaction: we have predefined template from where we can set condition function call</li><li> For Outstanding Balance: no need of condition function call </li></ul>
criterion_descrstring required

Description of the Criteria

template_idinteger required

Installment Template Id

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,
  "condition_function_call": "public.f_UniversalCheck3EC(<CTP>, _c_amount_OPERATION=>'>', _c_DE6_threshold_LIST=>'2')",
  "criterion_descr": "Criteria Description",
  "template_id": 1,
  "eligibiltyCriteria": {
    "header": {
      "error_desc": "success"
    }
  }
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "criteria_id": "1"
  }
}

Changes