POST v1/policyPayment/createRecurrentPayment

Request Information

URI Parameters

None.

Body Parameters

createRecurrentPaymentRequest
NameDescriptionTypeAdditional information
policyNo

string

None.

user_id

integer

None.

amount

decimal number

None.

startDate

string

None.

endDate

string

None.

freq

frequency

None.

Request Formats

application/json, text/json

Sample:
{
  "policyNo": "sample string 1",
  "user_id": 2,
  "amount": 3.0,
  "startDate": "sample string 4",
  "endDate": "sample string 5",
  "freq": 0
}

application/xml, text/xml

Sample:
<createRecurrentPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.createRecurrentPayment">
  <amount>3</amount>
  <endDate>sample string 5</endDate>
  <freq>monthly</freq>
  <policyNo>sample string 1</policyNo>
  <startDate>sample string 4</startDate>
  <user_id>2</user_id>
</createRecurrentPaymentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

text/html

Sample:
{"policyNo":"sample string 1","user_id":2,"amount":3.0,"startDate":"sample string 4","endDate":"sample string 5","freq":0}

Response Information

Resource Description

createRecurrentPaymentResult
NameDescriptionTypeAdditional information
success

boolean

None.

message

string

None.

errorMsg

string

None.

policyNo

string

None.

totalExpectedPayment

decimal number

None.

startDate

string

None.

endDate

string

None.

paymentUrl

string

None.

referenceNo

string

None.

repaymentSchedule

Collection of repaySch

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "message": "sample string 2",
  "errorMsg": "sample string 3",
  "policyNo": "sample string 4",
  "totalExpectedPayment": 5.0,
  "startDate": "sample string 6",
  "endDate": "sample string 7",
  "paymentUrl": "sample string 8",
  "referenceNo": "sample string 9",
  "repaymentSchedule": [
    {
      "amount": 1.0,
      "debitDate": "sample string 2"
    },
    {
      "amount": 1.0,
      "debitDate": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<createRecurrentPaymentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.createRecurrentPayment">
  <endDate>sample string 7</endDate>
  <errorMsg>sample string 3</errorMsg>
  <message>sample string 2</message>
  <paymentUrl>sample string 8</paymentUrl>
  <policyNo>sample string 4</policyNo>
  <referenceNo>sample string 9</referenceNo>
  <repaymentSchedule>
    <createRecurrentPaymentResult.repaySch>
      <amount>1</amount>
      <debitDate>sample string 2</debitDate>
    </createRecurrentPaymentResult.repaySch>
    <createRecurrentPaymentResult.repaySch>
      <amount>1</amount>
      <debitDate>sample string 2</debitDate>
    </createRecurrentPaymentResult.repaySch>
  </repaymentSchedule>
  <startDate>sample string 6</startDate>
  <success>true</success>
  <totalExpectedPayment>5</totalExpectedPayment>
</createRecurrentPaymentResult>

text/html

Sample:
{"success":true,"message":"sample string 2","errorMsg":"sample string 3","policyNo":"sample string 4","totalExpectedPayment":5.0,"startDate":"sample string 6","endDate":"sample string 7","paymentUrl":"sample string 8","referenceNo":"sample string 9","repaymentSchedule":[{"amount":1.0,"debitDate":"sample string 2"},{"amount":1.0,"debitDate":"sample string 2"}]}