POST api/Payments/InitiateOnlineRenewalPayment

Initiate online payment for Renewal - save logs and get token

Request Information

URI Parameters

None.

Body Parameters

PolicyDetailForRenewalPayment
NameDescriptionTypeAdditional information
MembershipId

string

None.
PolicyCategory

string

None.
PolicyType

string

None.
FirstName

string

None.
LastName

string

None.
PaymentAmount

decimal number

None.
Address

string

None.
City

string

None.
State

string

None.
StateList

string

None.
Country

string

None.
Zip

string

None.
PhoneNumber

string

None.
Fax

string

None.
Email

string

None.
Currency

string

None.
LangCd

string

None.
PolicyHolderId

integer

None.
PolicyId

integer

None.
EffectiveDate

date

None.
PaymentGateway

string

None.
ProductName

string

None.
PolicyNo

string

None.
IsTrustPolicy

boolean

None.
RenewalId

integer

None.
PaymentId

integer

None.
InitiatedScreen

string

None.
MemberEmail

string

None.
IsRVFApplicable

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "MembershipId": "sample string 1",
  "PolicyCategory": "sample string 2",
  "PolicyType": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "PaymentAmount": 6.0,
  "Address": "sample string 7",
  "City": "sample string 8",
  "State": "sample string 9",
  "StateList": "sample string 10",
  "Country": "sample string 11",
  "Zip": "sample string 12",
  "PhoneNumber": "sample string 13",
  "Fax": "sample string 14",
  "Email": "sample string 15",
  "Currency": "sample string 16",
  "LangCd": "sample string 17",
  "PolicyHolderId": 18,
  "PolicyId": 1,
  "EffectiveDate": "2024-04-27T13:37:59.6552699-07:00",
  "PaymentGateway": "sample string 19",
  "ProductName": "sample string 20",
  "PolicyNo": "sample string 21",
  "IsTrustPolicy": true,
  "RenewalId": 23,
  "PaymentId": 24,
  "InitiatedScreen": "sample string 25",
  "MemberEmail": "sample string 26",
  "IsRVFApplicable": true
}

application/xml, text/xml

Sample: 
<PolicyDetailForRenewalPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.AS.AgentPortal.Data.Models.Policy">
  <Address>sample string 7</Address>
  <City>sample string 8</City>
  <Country>sample string 11</Country>
  <Currency>sample string 16</Currency>
  <EffectiveDate>2024-04-27T13:37:59.6552699-07:00</EffectiveDate>
  <Email>sample string 15</Email>
  <Fax>sample string 14</Fax>
  <FirstName>sample string 4</FirstName>
  <InitiatedScreen>sample string 25</InitiatedScreen>
  <IsRVFApplicable>true</IsRVFApplicable>
  <IsTrustPolicy>true</IsTrustPolicy>
  <LangCd>sample string 17</LangCd>
  <LastName>sample string 5</LastName>
  <MemberEmail>sample string 26</MemberEmail>
  <MembershipId>sample string 1</MembershipId>
  <PaymentAmount>6</PaymentAmount>
  <PaymentGateway>sample string 19</PaymentGateway>
  <PaymentId>24</PaymentId>
  <PhoneNumber>sample string 13</PhoneNumber>
  <PolicyCategory>sample string 2</PolicyCategory>
  <PolicyHolderId>18</PolicyHolderId>
  <PolicyId>1</PolicyId>
  <PolicyNo>sample string 21</PolicyNo>
  <PolicyType>sample string 3</PolicyType>
  <ProductName>sample string 20</ProductName>
  <RenewalId>23</RenewalId>
  <State>sample string 9</State>
  <StateList>sample string 10</StateList>
  <Zip>sample string 12</Zip>
</PolicyDetailForRenewalPayment>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Token

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.