POST v1/Payment/PostPaymentEFT

Post EFT payment

Request Information

URI Parameters

None.

Body Parameters

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

EftInfo

Bank Information

EftInboundDTO

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

Sample:
{
  "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": "2022-01-20T03:21:33.1309495-10:00",
  "QuoteNumber": "sample string 5",
  "PhoneNumber": "sample string 6",
  "EftInfo": {
    "Id": 1,
    "BankTransitNumber": "sample string 2",
    "AccountHolderName": "sample string 3",
    "AccountNumber": "sample string 4",
    "EFTBankAccountType": "Unknown",
    "Expand": ""
  },
  "NetOnly": true,
  "DivisionOrganizationId": 1,
  "UnderwritingCompanyId": 8
}

application/xml, text/xml

Sample:
<EFTPaymentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">
  <DivisionOrganizationId>1</DivisionOrganizationId>
  <EftInfo 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:AccountHolderName>sample string 3</d2p1:AccountHolderName>
    <d2p1:AccountNumber>sample string 4</d2p1:AccountNumber>
    <d2p1:BankTransitNumber>sample string 2</d2p1:BankTransitNumber>
    <d2p1:EFTBankAccountType>Unknown</d2p1:EFTBankAccountType>
  </EftInfo>
  <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>2022-01-20T03:21:33.1309495-10:00</PostmarkDate>
  <QuoteNumber>sample string 5</QuoteNumber>
  <SuspenseType>Unknown</SuspenseType>
  <TransactionAmount>1</TransactionAmount>
  <UnderlyingPolicyNumber>sample string 2</UnderlyingPolicyNumber>
  <UnderwritingCompanyId>8</UnderwritingCompanyId>
</EFTPaymentDTO>

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>