POST api/Payments/GetPaymentHistoryDetailsByPolicyNumber
Gets the payment history details.
Request Information
URI Parameters
None.
Body Parameters
RetrievalParamsPayments| Name | Description | Type | Additional information |
|---|---|---|---|
| PolicyId | integer |
None. |
|
| MemberNumber | integer |
None. |
|
| PaymentHistoryFromDate | date |
None. |
|
| PaymentHistoryToDate | date |
None. |
|
| PageNumber | integer |
Required |
|
| PageSize | integer |
Required |
|
| SortOption | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"PolicyId": 1,
"MemberNumber": 1,
"PaymentHistoryFromDate": "2025-08-12T11:54:49.3397863-07:00",
"PaymentHistoryToDate": "2025-08-12T11:54:49.3397863-07:00",
"PageNumber": 1,
"PageSize": 2,
"SortOption": 3
}
application/xml, text/xml
Sample:
<RetrievalParamsPayments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.AS.AgentPortal.Data.Models.Payments"> <PageNumber xmlns="http://schemas.datacontract.org/2004/07/Speridian.Data.Base.Models">1</PageNumber> <PageSize xmlns="http://schemas.datacontract.org/2004/07/Speridian.Data.Base.Models">2</PageSize> <SortOption xmlns="http://schemas.datacontract.org/2004/07/Speridian.Data.Base.Models">3</SortOption> <MemberNumber>1</MemberNumber> <PaymentHistoryFromDate>2025-08-12T11:54:49.3397863-07:00</PaymentHistoryFromDate> <PaymentHistoryToDate>2025-08-12T11:54:49.3397863-07:00</PaymentHistoryToDate> <PolicyId>1</PolicyId> </RetrievalParamsPayments>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |