POST v1/surrender/applyForSurrender
Request Information
URI Parameters
None.
Body Parameters
applyForSurrenderRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| policyNo | string |
None. |
|
| user_id | integer |
None. |
|
| comment | string |
None. |
|
| amount | decimal number |
None. |
|
| paymentMethod | surrenderPaymentMethod |
None. |
|
| base64_Signature | string |
None. |
|
| docs | Collection of Doc |
None. |
Request Formats
application/json, text/json
Sample:
{
"policyNo": "sample string 1",
"user_id": 2,
"comment": "sample string 3",
"amount": 4.0,
"paymentMethod": 0,
"base64_Signature": "sample string 5",
"docs": [
{
"documentName": "sample string 1",
"base64Document": "sample string 2",
"documentFormat": "sample string 3"
},
{
"documentName": "sample string 1",
"base64Document": "sample string 2",
"documentFormat": "sample string 3"
}
]
}
application/xml, text/xml
Sample:
<applyForSurrenderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.surrender">
<amount>4</amount>
<base64_Signature>sample string 5</base64_Signature>
<comment>sample string 3</comment>
<docs xmlns:d2p1="http://schemas.datacontract.org/2004/07/unifiedApp.Models.createClaim">
<d2p1:Doc>
<d2p1:base64Document>sample string 2</d2p1:base64Document>
<d2p1:documentFormat>sample string 3</d2p1:documentFormat>
<d2p1:documentName>sample string 1</d2p1:documentName>
</d2p1:Doc>
<d2p1:Doc>
<d2p1:base64Document>sample string 2</d2p1:base64Document>
<d2p1:documentFormat>sample string 3</d2p1:documentFormat>
<d2p1:documentName>sample string 1</d2p1:documentName>
</d2p1:Doc>
</docs>
<paymentMethod>wallet</paymentMethod>
<policyNo>sample string 1</policyNo>
<user_id>2</user_id>
</applyForSurrenderRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
text/html
Sample:
{"policyNo":"sample string 1","user_id":2,"comment":"sample string 3","amount":4.0,"paymentMethod":0,"base64_Signature":"sample string 5","docs":[{"documentName":"sample string 1","base64Document":"sample string 2","documentFormat":"sample string 3"},{"documentName":"sample string 1","base64Document":"sample string 2","documentFormat":"sample string 3"}]}
Response Information
Resource Description
applyForSurrenderResult| Name | Description | Type | Additional information |
|---|---|---|---|
| success | boolean |
None. |
|
| message | string |
None. |
|
| errorMsg | string |
None. |
|
| surrender_id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"success": true,
"message": "sample string 2",
"errorMsg": "sample string 3",
"surrender_id": 4
}
application/xml, text/xml
Sample:
<applyForSurrenderResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.surrender"> <errorMsg>sample string 3</errorMsg> <message>sample string 2</message> <success>true</success> <surrender_id>4</surrender_id> </applyForSurrenderResult>
text/html
Sample:
{"success":true,"message":"sample string 2","errorMsg":"sample string 3","surrender_id":4}