POST api/Payments/GetPaymentReceiptByPaymentForDownload

To Downlod Payment Receipt

Request Information

URI Parameters

None.

Body Parameters

PaymentsReceiptRetrievalParams
NameDescriptionTypeAdditional information
PremDueId

integer

None.
PolicyId

integer

None.
EffectiveDate

date

None.
PageNumber

integer

Required
PageSize

integer

Required
SortOption

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "PremDueId": 1,
  "PolicyId": 1,
  "EffectiveDate": "2026-04-15T12:02:56.3431196-07:00",
  "PageNumber": 1,
  "PageSize": 2,
  "SortOption": 3
}

application/xml, text/xml

Sample: 
<PaymentsReceiptRetrievalParams 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>
  <EffectiveDate>2026-04-15T12:02:56.3431196-07:00</EffectiveDate>
  <PolicyId>1</PolicyId>
  <PremDueId>1</PremDueId>
</PaymentsReceiptRetrievalParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.