PApaymentology
Installment

Offer Installment

Changed on

This web service offer installment plan to client

post/pws/pws_offer_installment

Request

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

Request body

acc_idinteger required

Account Id

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

template_idinteger required

Installment Template Id

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

ridinteger

Transaction RID which we are converting to installment.</br>It is optional when template is defined for 'OB','SB' and 'NS for fee'.And it is required when template is defined for 'ST' and 'NS with Financial Debit Transaction'

principal_valuenumber

Total Amount which is to be converted as installment

interest_ratenumber

Interest Rate that is to be applied for this installment only.</br>The value will only be used if the allow_interest_override value from the installment template is true

processing_fee_fixednumber

Processing fee fixed that is to be applied for this installment only.</br>The value will only be used if the allow_fee_override value from the installment template is true

processing_fee_percnumber

Processing fee percent that is to be applied for this installment only.</br>The value will only be used if the allow_fee_override value from the installment template is true

processing_fee_logicstring

Processing fee logic that is to be applied for this installment only Valid values are 'SUM','AVG','MIN','MAX'.</br>The value will only be used if the allow_fee_override value from the installment template is true

periodinteger

Cycle duration for which the installment is to be implemented</br>The value will only be used if the allow_period_override value from the installment template is true

Example request

{
  "acc_id": 1234561234,
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "template_id": 1,
  "rid": 1865385744121000200,
  "principal_value": 50000,
  "interest_rate": 10,
  "processing_fee_fixed": 10,
  "processing_fee_perc": 10,
  "processing_fee_logic": "SUM",
  "period": 10
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "installment_details": {
      "template_id": 2,
      "installment_id": 15,
      "client_id": 189225,
      "prod_id": 24,
      "customer_id": 1642633,
      "account_id": 714552143,
      "pr_tok": 487427753,
      "tc_id": 1858268502345000000,
      "status": "Pending",
      "principal_amount": 100000,
      "installment_amount": 16600,
      "interest_rate": 12,
      "processing_fee_perc": 10,
      "processing_fee_fixed": 100,
      "processing_fee_logic": "SUM",
      "period": 6
    },
    "installment_schedules": [
      {
        "schedule_id": 1,
        "installment_id": 1,
        "seq_no": 1,
        "installment_amt": 1000,
        "status": 1
      }
    ]
  }
}

Changes