POST v1/Payment/PostPayment

Post Payment

Request Information

URI Parameters

None.

Body Parameters

PaymentDTO
NameDescriptionTypeAdditional information
SuspenseType

SuspenseTypeEnum

None.

UserId

integer

None.

PolicyNumber

string

String length: inclusive between 0 and 12

APNNumber

string

String length: inclusive between 0 and 20

BillingPaymentType

BillingPaymentTypeEnum

None.

PayorType

PayorTypeEnum

None.

PostmarkDate

date

None.

TransactionAmount

decimal number

None.

NetPayment

decimal number

None.

PaymentSource

string

String length: inclusive between 0 and 500

CreditCardTransactionId

integer

None.

EFTTransactionId

integer

None.

EPayTransactionId

integer

None.

SpeedpayTransactionId

integer

None.

LockboxTransactionId

integer

None.

QuoteNumber

string

String length: inclusive between 0 and 12

FirstName

string

String length: inclusive between 0 and 30

MiddleName

string

String length: inclusive between 0 and 30

LastName

string

String length: inclusive between 0 and 30

CommercialName

string

String length: inclusive between 0 and 60

PhoneNumber

string

None.

Address1

string

String length: inclusive between 0 and 200

Address2

string

String length: inclusive between 0 and 200

City

string

String length: inclusive between 0 and 50

StateCode

string

String length: inclusive between 0 and 30

ZipCode1

string

String length: inclusive between 0 and 10

ZipCode2

string

String length: inclusive between 0 and 4

CountryId

integer

None.

NetOnly

boolean

None.

DivisionOrganizationId

integer

None.

UnderwritingCompanyId

integer

None.

PolicyId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "SuspenseType": "Unknown",
  "UserId": 1,
  "PolicyNumber": "sample string 2",
  "APNNumber": "sample string 3",
  "BillingPaymentType": "Unknown",
  "PayorType": "Unknown",
  "PostmarkDate": "2022-01-20T01:45:49.429348-10:00",
  "TransactionAmount": 1.0,
  "NetPayment": 1.0,
  "PaymentSource": "sample string 4",
  "CreditCardTransactionId": 1,
  "EFTTransactionId": 1,
  "EPayTransactionId": 1,
  "SpeedpayTransactionId": 1,
  "LockboxTransactionId": 1,
  "QuoteNumber": "sample string 5",
  "FirstName": "sample string 6",
  "MiddleName": "sample string 7",
  "LastName": "sample string 8",
  "CommercialName": "sample string 9",
  "PhoneNumber": "sample string 10",
  "Address1": "sample string 11",
  "Address2": "sample string 12",
  "City": "sample string 13",
  "StateCode": "sample string 14",
  "ZipCode1": "sample string 15",
  "ZipCode2": "sample string 16",
  "CountryId": 1,
  "NetOnly": true,
  "DivisionOrganizationId": 1,
  "UnderwritingCompanyId": 18,
  "PolicyId": 1
}

application/xml, text/xml

Sample:
<PaymentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <APNNumber>sample string 3</APNNumber>
  <Address1>sample string 11</Address1>
  <Address2>sample string 12</Address2>
  <BillingPaymentType>Unknown</BillingPaymentType>
  <City>sample string 13</City>
  <CommercialName>sample string 9</CommercialName>
  <CountryId>1</CountryId>
  <CreditCardTransactionId>1</CreditCardTransactionId>
  <DivisionOrganizationId>1</DivisionOrganizationId>
  <EFTTransactionId>1</EFTTransactionId>
  <EPayTransactionId>1</EPayTransactionId>
  <FirstName>sample string 6</FirstName>
  <LastName>sample string 8</LastName>
  <LockboxTransactionId>1</LockboxTransactionId>
  <MiddleName>sample string 7</MiddleName>
  <NetOnly>true</NetOnly>
  <NetPayment>1</NetPayment>
  <PaymentSource>sample string 4</PaymentSource>
  <PayorType>Unknown</PayorType>
  <PhoneNumber>sample string 10</PhoneNumber>
  <PolicyId>1</PolicyId>
  <PolicyNumber>sample string 2</PolicyNumber>
  <PostmarkDate>2022-01-20T01:45:49.429348-10:00</PostmarkDate>
  <QuoteNumber>sample string 5</QuoteNumber>
  <SpeedpayTransactionId>1</SpeedpayTransactionId>
  <StateCode>sample string 14</StateCode>
  <SuspenseType>Unknown</SuspenseType>
  <TransactionAmount>1</TransactionAmount>
  <UnderwritingCompanyId>18</UnderwritingCompanyId>
  <UserId>1</UserId>
  <ZipCode1>sample string 15</ZipCode1>
  <ZipCode2>sample string 16</ZipCode2>
</PaymentDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PaymentResponseDTO
NameDescriptionTypeAdditional 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.

WarningMessages

List of warning messages encountered while servicing request

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "PaymentMethodMasterId": 1,
  "PaymentMethodTransactionId": 1
}

application/xml, text/xml

Sample:
<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>
</PaymentResponseDTO>