GET v1/policyPayment/viewRecurrentPaymentSchedule?policyNo={policyNo}&status={status}

Request Information

URI Parameters

Name	Description	Type	Additional information
policyNo		string	Required
status		recurrentPaymentStatus	Required

Body Parameters

None.

Response Information

Resource Description

viewRecurrentPaymentScheduleResult

Name	Type	Additional information
success	boolean	None.
message	string	None.
policyNo	string	None.
fullName	string	None.
createdDate	string	None.
amount	decimal number	None.
totalPaid	decimal number	None.
totalPending	decimal number	None.
totalFailed	decimal number	None.
errorMsg	string	None.
status	recurrentPaymentStatus	None.
paymentSchedule	Collection of paymentScheduleItem	None.

Response Formats

application/json, text/json

Sample:

{
  "success": true,
  "message": "sample string 2",
  "policyNo": "sample string 3",
  "fullName": "sample string 4",
  "createdDate": "sample string 5",
  "amount": 6.0,
  "totalPaid": 7.0,
  "totalPending": 8.0,
  "totalFailed": 9.0,
  "errorMsg": "sample string 10",
  "status": 0,
  "paymentSchedule": [
    {
      "id": 1,
      "amount": 2.0,
      "debitDate": "sample string 3",
      "bankResponse": "sample string 4",
      "status": "sample string 5",
      "enabled": true,
      "attempted": true,
      "debited": true
    },
    {
      "id": 1,
      "amount": 2.0,
      "debitDate": "sample string 3",
      "bankResponse": "sample string 4",
      "status": "sample string 5",
      "enabled": true,
      "attempted": true,
      "debited": true
    }
  ]
}

application/xml, text/xml

Sample:

<viewRecurrentPaymentScheduleResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.createRecurrentPayment">
  <amount>6</amount>
  <createdDate>sample string 5</createdDate>
  <errorMsg>sample string 10</errorMsg>
  <fullName>sample string 4</fullName>
  <message>sample string 2</message>
  <paymentSchedule>
    <paymentScheduleItem>
      <amount>2</amount>
      <attempted>true</attempted>
      <bankResponse>sample string 4</bankResponse>
      <debitDate>sample string 3</debitDate>
      <debited>true</debited>
      <enabled>true</enabled>
      <id>1</id>
      <status>sample string 5</status>
    </paymentScheduleItem>
    <paymentScheduleItem>
      <amount>2</amount>
      <attempted>true</attempted>
      <bankResponse>sample string 4</bankResponse>
      <debitDate>sample string 3</debitDate>
      <debited>true</debited>
      <enabled>true</enabled>
      <id>1</id>
      <status>sample string 5</status>
    </paymentScheduleItem>
  </paymentSchedule>
  <policyNo>sample string 3</policyNo>
  <status>all</status>
  <success>true</success>
  <totalFailed>9</totalFailed>
  <totalPaid>7</totalPaid>
  <totalPending>8</totalPending>
</viewRecurrentPaymentScheduleResult>

text/html

Sample:

{"success":true,"message":"sample string 2","policyNo":"sample string 3","fullName":"sample string 4","createdDate":"sample string 5","amount":6.0,"totalPaid":7.0,"totalPending":8.0,"totalFailed":9.0,"errorMsg":"sample string 10","status":0,"paymentSchedule":[{"id":1,"amount":2.0,"debitDate":"sample string 3","bankResponse":"sample string 4","status":"sample string 5","enabled":true,"attempted":true,"debited":true},{"id":1,"amount":2.0,"debitDate":"sample string 3","bankResponse":"sample string 4","status":"sample string 5","enabled":true,"attempted":true,"debited":true}]}