PApaymentology
Installment

Create Installment Template

Changed on

This web service allows to create installment template

post/pws/pws_create_installment_template

Request

  • Base URL
    https://api.uat.paymentology.com/ppws/api
  • URL
    https://api.uat.paymentology.com/ppws/api/pws/pws_create_installment_template
  • 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

cancellation_fee_fixednumber required

Installment Cancellation Fee in Fixed

cancellation_fee_logicstring required

Installment Cancellation Fee Logic.</br>Fee Logic can be one of the following:<ul><li>SUM: Sum of the two</li><li>AVG: Average of the two</li><li>MIN: Minimum of the two</li><li>MAX:Maximum of the two</li></ul>

cancellation_fee_percnumber required

Installment Cancellation Fee in Percent

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

end_datestring required

Installment Offer End Date

installment_methodinteger required

Installment Method.</br> There are two methods:<ul><li>1: Flat</li><li>2: Reducing</li></ul>

installment_typestring required

Installment Type.</br> Following are the type of installment:<ul><li>ST:Scheme Transaction</li><li>SB:Statement Balance</li><li>OB:Outstanding Balance</li><li>NS: Non-Schema</li></ul>

interest_ratenumber required

Interest Rate that is applied during the installment

periodinteger required

Cycle upto when the installment is to be implemented

processing_fee_fixednumber required

Installment Processing Fee in Fixed

processing_fee_logicstring required

Installment Processing Fee Logic.</br>Fee Logic can be one of the following:<ul><li>SUM: Sum of the two</li><li>AVG: Average of the two</li><li>MIN: Minimum of the two</li><li>MAX:Maximum of the two</li></ul>

processing_fee_percnumber required

Installment Processing Fee in Percent

prod_idstring required

Product Id that can have feature of installment

start_datestring required

Installment Offer Start Date

titlestring required

Title for the Installment Template

total_value_formulainteger required

Field that indicates whether fee,interest,principal or margin is to be included when converting to installment.</br>possible value are :<ul><li>1: Principal Only</li><li>2: Principal and Margins</li><li>3: Principal,Margins and Fee</li></ul>

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

allow_fee_overrideboolean

This field is used to override the existing template fee with the fee selected when offering installment

allow_interest_overrideboolean

This field is used to override the existing template interest with the interest selected when offering installment

allow_period_overrideboolean

This field is used to override the existing template period with the period selected when offering installment

scheme_profile_idstring

Installment Scheme Profile Id

statusboolean

Installment Status

apr_methodinteger

Apr Method

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "cancellation_fee_fixed": 20,
  "cancellation_fee_logic": "SUM",
  "cancellation_fee_perc": 20,
  "client_id": 760131,
  "end_date": "2022-02-16",
  "installment_method": 1,
  "installment_type": "ST",
  "interest_rate": 24,
  "period": 5,
  "processing_fee_fixed": 20,
  "processing_fee_logic": "SUM",
  "processing_fee_perc": 20,
  "prod_id": "12,242",
  "start_date": "2022-02-09",
  "title": "Installment Template",
  "total_value_formula": 1,
  "eligibility_criteria": [
    {
      "condition_function_call": "public.f_UniversalCheck3EC(<CTP>, _c_amount_OPERATION=>'>', _c_DE6_threshold_LIST=>'2')",
      "criterion_descr": "Criteria Description"
    }
  ],
  "scheme_profile_id": "visa",
  "status": true,
  "apr_method": 1
}

Response

Successful Response

Example response

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

Changes