POST v1/Payment/PostPaymentCreditCard
Post Credit Card Payment
Request Information
URI Parameters
None.
Body Parameters
CreditCardPaymentDTOName | Description | Type | Additional information |
---|---|---|---|
SuspenseType |
Suspense type (EarlyCashPolicy, NotSuspense, etc) |
SuspenseTypeEnum |
Required |
PolicyNumber |
Policy number |
string |
String length: inclusive between 0 and 30 |
UnderlyingPolicyNumber |
Underlying Policy number |
string |
String length: inclusive between 0 and 30 |
LineOfBusiness |
Line of business prefix |
string |
Required String length: inclusive between 0 and 10 |
TransactionAmount |
Transaction amount |
decimal number |
Required |
NetPayment |
Net payment amount (Optional) |
decimal number |
None. |
PayorType |
Payor type (Optional) |
PayorTypeEnum |
None. |
PayorId |
Payor id (Optional) |
integer |
None. |
PostmarkDate |
Postmark date (Optional) |
date |
None. |
QuoteNumber |
Quote number (Optional) |
string |
String length: inclusive between 0 and 12 |
PhoneNumber |
Phone number (Optional) |
string |
None. |
CreditCardInfo |
Credit Card Information |
CreditCardInboundDTO |
Required |
NetOnly |
Use Net Payment only |
boolean |
None. |
DivisionOrganizationId |
Division Id |
integer |
None. |
UnderwritingCompanyId |
Underwriting company Id of policy |
integer |
None. |
Request Formats
application/json, text/json
{ "SuspenseType": "Unknown", "PolicyNumber": "sample string 1", "UnderlyingPolicyNumber": "sample string 2", "LineOfBusiness": "sample string 3", "TransactionAmount": 1.0, "NetPayment": 1.0, "PayorType": "Unknown", "PayorId": 4, "PostmarkDate": "2024-10-11T22:25:45.3897277-10:00", "QuoteNumber": "sample string 5", "PhoneNumber": "sample string 6", "CreditCardInfo": { "Id": 1, "CreditCardNumber": "samplestring2", "CreditCardType": "Unknown", "MonthOfExpirationDate": 1, "YearOfExpirationDate": 2003, "CardHolderName": "sample string 4", "CardHolderAddress": { "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "Expand": "" }, "NetOnly": true, "DivisionOrganizationId": 1, "UnderwritingCompanyId": 8 }
application/xml, text/xml
<CreditCardPaymentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models"> <CreditCardInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Models.Inbound"> <d2p1:Expand></d2p1:Expand> <d2p1:Expansions xmlns:d3p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <d2p1:Id>1</d2p1:Id> <d2p1:CardHolderAddress> <Expand></Expand> <Expansions xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" /> <Id>9</Id> <Address1>sample string 1</Address1> <Address2>sample string 2</Address2> <City>sample string 3</City> <Country>sample string 6</Country> <County>sample string 5</County> <State>sample string 4</State> <Zipcode1>sample string 7</Zipcode1> <Zipcode2>sample string 8</Zipcode2> </d2p1:CardHolderAddress> <d2p1:CardHolderName>sample string 4</d2p1:CardHolderName> <d2p1:CreditCardNumber>samplestring2</d2p1:CreditCardNumber> <d2p1:CreditCardType>Unknown</d2p1:CreditCardType> <d2p1:MonthOfExpirationDate>1</d2p1:MonthOfExpirationDate> <d2p1:YearOfExpirationDate>2003</d2p1:YearOfExpirationDate> </CreditCardInfo> <DivisionOrganizationId>1</DivisionOrganizationId> <LineOfBusiness>sample string 3</LineOfBusiness> <NetOnly>true</NetOnly> <NetPayment>1</NetPayment> <PayorId>4</PayorId> <PayorType>Unknown</PayorType> <PhoneNumber>sample string 6</PhoneNumber> <PolicyNumber>sample string 1</PolicyNumber> <PostmarkDate>2024-10-11T22:25:45.3897277-10:00</PostmarkDate> <QuoteNumber>sample string 5</QuoteNumber> <SuspenseType>Unknown</SuspenseType> <TransactionAmount>1</TransactionAmount> <UnderlyingPolicyNumber>sample string 2</UnderlyingPolicyNumber> <UnderwritingCompanyId>8</UnderwritingCompanyId> </CreditCardPaymentDTO>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
PaymentResponseDTOName | Description | Type | Additional information |
---|---|---|---|
Id |
Billing transaction record id |
integer |
None. |
PaymentMethodMasterId |
Payment method master id (EFT Master, Credit Card Master, etc) |
integer |
None. |
PaymentMethodTransactionId |
Payment method transaction id (EFT Transaction, Credit Card Transaction, etc) |
integer |
None. |
ReferenceNumber |
Reference Number |
string |
None. |
WarningMessages |
List of warning messages encountered while servicing request |
Collection of string |
None. |
Response Formats
application/json, text/json
{ "Id": 1, "PaymentMethodMasterId": 1, "PaymentMethodTransactionId": 1, "ReferenceNumber": "sample string 2" }
application/xml, text/xml
<PaymentResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound"> <Id>1</Id> <PaymentMethodMasterId>1</PaymentMethodMasterId> <PaymentMethodTransactionId>1</PaymentMethodTransactionId> <ReferenceNumber>sample string 2</ReferenceNumber> </PaymentResponseDTO>