Backward Compatibility

One Inc is continuously updating their systems but avoids making breaking changes for our client’s integration.

Note: One Inc may be required to make changes to our systems to abide to new requirements from external governing bodies (i.e. PCI Council, Nacha, Card Brands etc). These changes and the timelines associated with them may be dictated by external parties, out of One Inc's control.

One Inc considers the following changes to be backward compatible:

  • Adding a new API resource

  • Adding a new (optional) request parameter to an existing API resource.

  • Adding a new API response parameter.

  • Adding a new enumeration value. The value is added either in the request or response.

  • Adding new event types

  • Changing parameter validation from more restrictive to less restrictive

  • Changing the order of existing API responses parameters

Modal Payments

Policy

POST policies/search

This method is used for searching policies

MethodEndpoint
Search https://stgportalone.processonepayments.com/ExternalApi/policies/search

SearchRequest

NameDescriptionTypeRequired*Additional information
Limit

Maximum number of records in result

integer Yes
Offset

How many records to skip in result

integer Yes
SortBy

Defines sorting order. Only one column sorting is supported

string Yes
SearchParameters

Collection of Key/Value search parameters. Available parameters are configurable by merchant. For example a merchant can configure the portal to send "policyNumber", "accountNumber", "insuredName" fields as search parameters.

Dictionary of string and string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "Limit": 5,
  "Offset": 0,
  "SearchParameters": {
    "policyNumber": "12345",
    "phoneNumber": "111-111-1111",
    "zipCode": "12345"
  }
}
                                
                                 <SearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Search">
  <Limit>5</Limit>
  <Offset>0</Offset>
  <SearchParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>policyNumber</d2p1:Key>
      <d2p1:Value>12345</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>phoneNumber</d2p1:Key>
      <d2p1:Value>111-111-1111</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>zipCode</d2p1:Key>
      <d2p1:Value>12345</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </SearchParameters>
  <SortBy i:nil="true" />
</SearchRequest>

Response Information

PolicySearchResponse

NameDescriptionTypeRequired*Additional information
Results

List of policies matching the search criteria

Collection of PolicyDetailsResponse Yes
TotalCount

Total number of results

integer Yes
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

PolicyDetailsResponse

NameDescriptionTypeRequired*Additional information
PolicyId

Policy Identifier

string Yes
PolicyNumber

Policy Number

string Yes
CustomerId

ONE Inc customer identifier that will be used to fetch available payment methods

string No
ExternalCustomerId

External generated ID of Customer

string No
CustomerName

Name of the customer

string No
AccountId

Account Identifier

string No
Status

Policy Status

string No
Term

Policy Term

string No
Type

Line Of Business Type. Supported values: Automobile, Homeowner, Workers Comp, Other

string Yes
Premium

Policy Premium

decimal number No
DueDate

Policy Due Date

date No
RemainingBalance

Remaining Balance

decimal number No
MinimumAmountDue

Minimum Amount Due

decimal number Yes
OtherAmountAllowed

Other Amount Allowed

boolean Yes
PaymentsAreAllowed

Payments Are Allowed for the policy This value is optional, default is true

boolean No
IsAutoPayEnabled

Is AutoPay Enabled for the policy This value is optional, default is true

boolean No
ZipCode

Policy Zip Code

string No
FeeContext

Indicates whether a fee will be applied to the payment. Supported values: PaymentWithFee, PaymentWithoutFee. Optional. Default is PaymentWithFee

string No
AccountGroupCode

Indicates the account group/corresponding bank account where the transaction's funds will be allocated from the set of account groups configured in your merchant settings. If omitted, the default account group configured in your merchant settings will be used.

string No
TokenId

Unique identifier that represents a saved card or bank account. Can be used to safely make payments with the saved payment method.

string No
Documents

Collection of policy documents (Proof of insurance document details)

Collection of DocumentDetails No
Bills

Collection of policy bills

Collection of BillDetails No
AutoPayOptions

Collection of possible recurring payment options

Collection of FrequencyDetails No
PolicyDetails

Policy Details. It is used for displaying policy details in portal

PolicyDetailsBase Can be one of the following types: AutoPolicyDetails HomePolicyDetails OtherPolicyDetails WorkersCompPolicyDetails No
InstallmentPlanEngineType

This field will define who will control the AutoPay Payment Plan generation and recurring scheduling.

AutoPayEngineType No
ExternalSchedulerEndpoint

This field value should only be sent when autoPayEngineType = "Carrier". Digital Payments will then use this endpoint to eventually send user-selected Payment Preferences for Auto-Pay Plan creation and scheduling.

string No
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

DocumentDetails

NameDescriptionTypeRequired*Additional information
Id

Document Id

string Yes
Type

Document Type (e.g. ProofOfInsurance)

string Yes
LinkToDownload

LinkToDownload to download the document (proof of insurance)

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

BillDetails

NameDescriptionTypeRequired*Additional information
Id

Bill Id

string Yes
DocumentId

Document Id

string No
Date

Date

date No
Description

Description

string Yes
Amount

Amount

decimal number No
LinkToDownload

Link to download the bill

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

FrequencyDetails

NameDescriptionTypeRequired*Additional information
Frequency

Frequency type: Monthly, Quarterly, Semiannually, Annually

string Yes
Amount

Payment amount for each installment

decimal number Yes
NumberOfInstallments

Number of total installments

integer Yes
WithdrawalDates

Available dates fo withdrawal

Collection of integer Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

PolicyDetailsBase

NameDescriptionTypeRequired*Additional information
Type

Name of the Policy Details Type, like "AutoPolicyDetails", "HomePolicyDetails", "OtherPolicyDetails", "WorkersCompPolicyDetails"

string Yes
Properties

Generic Key/Value Property list

Dictionary of string and string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

AutoPolicyDetails

NameDescriptionTypeRequired*Additional information
Drivers

Drivers collection

Collection of Driver No
Vehicles

Vehicles collection

Collection of Vehicle No
PolicyCoverages

Policy Coverages

Collection of Coverage No
Type

Name of the Policy Details Type, like "AutoPolicyDetails", "HomePolicyDetails", "OtherPolicyDetails", "WorkersCompPolicyDetails"

string Yes
Properties

Generic Key/Value Property list

Dictionary of string and string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Driver

NameDescriptionTypeRequired*Additional information
FirstName

First Name

string Yes
LastName

LastName

string Yes
LicenseNumber

License Number

string Yes
RelationToNamedInsured

Relation To Named Insured

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Vehicle

NameDescriptionTypeRequired*Additional information
Make

Make

string Yes
Model

Model

string Yes
Year

Year

integer Yes
Vin

Vin

string Yes
Coverages

Coverages

Collection of Coverage No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Coverage

NameDescriptionTypeRequired*Additional information
Type

Type

string Yes
LimitOrDeductible

Limit And/Or Deductible

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

HomePolicyDetails

NameDescriptionTypeRequired*Additional information
Deductible

Deductible

decimal number No
Mortgagee

Mortgagee

string No
LoanNumber

Loan Number

string No
AgentName

Agent Name

string No
AgentPhoneNumber

Agent Phone Number

string No
Coverages

Coverages

Collection of Coverage No
Type

Name of the Policy Details Type, like "AutoPolicyDetails", "HomePolicyDetails", "OtherPolicyDetails", "WorkersCompPolicyDetails"

string Yes
Properties

Generic Key/Value Property list

Dictionary of string and string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

OtherPolicyDetails

NameDescriptionTypeRequired*Additional information
Type

Name of the Policy Details Type, like "AutoPolicyDetails", "HomePolicyDetails", "OtherPolicyDetails", "WorkersCompPolicyDetails"

string Yes
Properties

Generic Key/Value Property list

Dictionary of string and string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

WorkersCompPolicyDetails

NameDescriptionTypeRequired*Additional information
Type

Name of the Policy Details Type, like "AutoPolicyDetails", "HomePolicyDetails", "OtherPolicyDetails", "WorkersCompPolicyDetails"

string Yes
Properties

Generic Key/Value Property list

Dictionary of string and string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

AutoPayEngineType

Possible enumeration values:

NameValueDescription
InstallmentsEngine

0

One Inc. will control Auto-Pay via current functionality in InstallmentsEngine.

Carrier

1

Carrier's Billing System will control Auto-Pay Payment Plan creation and Scheduling.

Response Formats

{
  "Results": [
    {
      "PolicyNumber": "12345",
      "CustomerId": "f83b10d9-ec82-4893-83e8-e1ebd744d319",
      "CustomerName": "Test Customer",
      "Premium": 0.0,
      "DueDate": "2019-10-27T07:19:33.1980458",
      "RemainingBalance": 100.0,
      "MinimumAmountDue": 25.0,
      "OtherAmountAllowed": true,
      "ZipCode": "12345",
      "PolicyDetails": {
        "Type": "AutoPolicyDetails",
        "Properties": {
          "BillingAddress": "321 Main Street, Folsom, CA 95630",
          "AccountGroupCode": "Value"
        }
      },
      "InstallmentPlanEngineType": 0,
      "IsSuccessful": false
    }
  ],
  "TotalCount": 1,
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<PolicySearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Policy">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
  <Results>
    <PolicyDetailsResponse>
      <ErrorMessage i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts" />
      <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">false</IsSuccessful>
      <AccountGroupCode i:nil="true" />
      <AccountId i:nil="true" />
      <AutoPayOptions i:nil="true" />
      <Bills i:nil="true" />
      <CustomerId>f83b10d9-ec82-4893-83e8-e1ebd744d319</CustomerId>
      <CustomerName>Test Customer</CustomerName>
      <Documents i:nil="true" />
      <DueDate>2019-10-27T07:19:33.1980458-07:00</DueDate>
      <ExternalCustomerId i:nil="true" />
      <ExternalSchedulerEndpoint i:nil="true" />
      <FeeContext i:nil="true" />
      <InstallmentPlanEngineType>InstallmentsEngine</InstallmentPlanEngineType>
      <IsAutoPayEnabled i:nil="true" />
      <MinimumAmountDue>25</MinimumAmountDue>
      <OtherAmountAllowed>true</OtherAmountAllowed>
      <PaymentsAreAllowed i:nil="true" />
      <PolicyDetails i:type="AutoPolicyDetails">
        <Properties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>BillingAddress</d5p1:Key>
            <d5p1:Value>321 Main Street, Folsom, CA 95630</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>AccountGroupCode</d5p1:Key>
            <d5p1:Value>Value</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Properties>
        <Drivers i:nil="true" />
        <PolicyCoverages i:nil="true" />
        <Vehicles i:nil="true" />
      </PolicyDetails>
      <PolicyId i:nil="true" />
      <PolicyNumber>12345</PolicyNumber>
      <Premium>0</Premium>
      <RemainingBalance>100</RemainingBalance>
      <Status i:nil="true" />
      <Term i:nil="true" />
      <TokenId i:nil="true" />
      <Type i:nil="true" />
      <ZipCode>12345</ZipCode>
    </PolicyDetailsResponse>
  </Results>
  <TotalCount>1</TotalCount>
</PolicySearchResponse>

Account

POST accounts/signUpForTexts

This method is used to sign up the customer for Texts.

MethodEndpoint
SignUpForTexts https://stgportalone.processonepayments.com/ExternalApi/accounts/signUpForTexts

SignUpForTextsRequest

NameDescriptionTypeRequired*Additional information
AccountId

Account Id. If AccountId is empty, CustomerId should be provided

string No
CustomerId

One Inc Customer Id. If CustomerId is empty, AccountId should be provided

string No
PhoneNumber

Phone Number

string Yes
IsSubscribedForTexts

Is subscribed for Texts

boolean Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AccountId": "12345",
  "CustomerId": "49437EE0-9C1D-483A-99C3-3C3197FEF8C2",
  "PhoneNumber": "916-123-4567",
  "IsSubscribedForTexts": true
}
                                
                                 <SignUpForTextsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <AccountId>12345</AccountId>
  <CustomerId>49437EE0-9C1D-483A-99C3-3C3197FEF8C2</CustomerId>
  <IsSubscribedForTexts>true</IsSubscribedForTexts>
  <PhoneNumber>916-123-4567</PhoneNumber>
</SignUpForTextsRequest>

Response Information

SignUpForTextsResponse

NameDescriptionTypeRequired*Additional information
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<SignUpForTextsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
</SignUpForTextsResponse>
{
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<SignUpForTextsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
</SignUpForTextsResponse>

POST accounts/signUpForEmails

This method is used to sign up the customer for emails. Once signed customer will receive an email with summary bill information.

MethodEndpoint
SignUpForEmails https://stgportalone.processonepayments.com/ExternalApi/accounts/signUpForEmails

SignUpForEmailsRequest

NameDescriptionTypeRequired*Additional information
AccountId

Account Id. If AccountId is empty, CustomerId should be provided

string No
CustomerId

One Inc Customer Id. If CustomerId is empty, AccountId should be provided

string No
Email

Email

string Yes
IsSubscribedForEmails

Is subscribed for Emails

boolean Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AccountId": "12345",
  "CustomerId": "49437EE0-9C1D-483A-99C3-3C3197FEF8C2",
  "Email": "[email protected]",
  "IsSubscribedForEmails": true
}
                                
                                 <SignUpForEmailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <AccountId>12345</AccountId>
  <CustomerId>49437EE0-9C1D-483A-99C3-3C3197FEF8C2</CustomerId>
  <Email>[email protected]</Email>
  <IsSubscribedForEmails>true</IsSubscribedForEmails>
</SignUpForEmailsRequest>

Response Information

SignUpForEmailsResponse

NameDescriptionTypeRequired*Additional information
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<SignUpForEmailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
</SignUpForEmailsResponse>

POST accounts/signUpForPhoneCalls

This method is used to sign up the customer for phone calls.

MethodEndpoint
SignUpForPhoneCalls https://stgportalone.processonepayments.com/ExternalApi/accounts/signUpForPhoneCalls

SignUpForPhoneCallsRequest

NameDescriptionTypeRequired*Additional information
AccountId

Account Id. If AccountId is empty, CustomerId should be provided

string No
CustomerId

One Inc Customer Id. If CustomerId is empty, AccountId should be provided

string No
PhoneNumber

Phone Number

string Yes
IsSubscribedForPhoneCalls

Is subscribed for Phone Calls

boolean Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AccountId": "12345",
  "CustomerId": "49437EE0-9C1D-483A-99C3-3C3197FEF8C2",
  "PhoneNumber": "916-234-5678",
  "IsSubscribedForPhoneCalls": true
}
                                
                                 <SignUpForPhoneCallsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <AccountId>12345</AccountId>
  <CustomerId>49437EE0-9C1D-483A-99C3-3C3197FEF8C2</CustomerId>
  <IsSubscribedForPhoneCalls>true</IsSubscribedForPhoneCalls>
  <PhoneNumber>916-234-5678</PhoneNumber>
</SignUpForPhoneCallsRequest>

Response Information

SignUpForPhoneCallsResponse

NameDescriptionTypeRequired*Additional information
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<SignUpForPhoneCallsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
</SignUpForPhoneCallsResponse>

GET accounts/{accountId}/subscriptions

This method is used to get active subscriptions like email, text messages, phone calls and paperless for an Account

MethodEndpoint
SubscriptionDetails https://stgportalone.processonepayments.com/ExternalApi/accounts/{accountId}/subscriptions

URI Parameters

NameDescriptionTypeRequired*Additional information
accountId

Account Id

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 

Response Information

AccountSubscriptionDetailsResponse

NameDescriptionTypeRequired*Additional information
Subscriptions

Collection of SubscriptionDetail No
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

SubscriptionDetail

NameDescriptionTypeRequired*Additional information
Type

Subscription type

SubscriptionType No
Status

Subscription status

SubscriptionStatus No
Target

Subscription target such as email address, phone number, etc.

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

SubscriptionType

Possible enumeration values:

NameValueDescription
Email

1

Email

Text

2

Text messages

Paperless

3

Paperless

PhoneCall

4

Phone calls

SubscriptionStatus

Possible enumeration values:

NameValueDescription
Requested

1

Subscription hasn't been confirmed yet (for future purposes)

Subscribed

2

Subscription is active

Unsubscribed

3

Subscription was turned off

Response Formats

{
  "Subscriptions": [
    {
      "Type": 2,
      "Status": 2,
      "Target": "19161234567"
    },
    {
      "Type": 1,
      "Status": 2,
      "Target": "[email protected]"
    },
    {
      "Type": 4,
      "Status": 2,
      "Target": "19162345678"
    }
  ],
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<AccountSubscriptionDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
  <Subscriptions>
    <SubscriptionDetail>
      <Status>Subscribed</Status>
      <Target>19161234567</Target>
      <Type>Text</Type>
    </SubscriptionDetail>
    <SubscriptionDetail>
      <Status>Subscribed</Status>
      <Target>[email protected]</Target>
      <Type>Email</Type>
    </SubscriptionDetail>
    <SubscriptionDetail>
      <Status>Subscribed</Status>
      <Target>19162345678</Target>
      <Type>PhoneCall</Type>
    </SubscriptionDetail>
  </Subscriptions>
</AccountSubscriptionDetailsResponse>

POST accounts/search

This method is used for searching accounts

MethodEndpoint
Search https://stgportalone.processonepayments.com/ExternalApi/accounts/search

SearchRequest

NameDescriptionTypeRequired*Additional information
Limit

Maximum number of records in result

integer Yes
Offset

How many records to skip in result

integer Yes
SortBy

Defines sorting order. Only one column sorting is supported

string Yes
SearchParameters

Collection of Key/Value search parameters. Available parameters are configurable by merchant. For example a merchant can configure the portal to send "policyNumber", "accountNumber", "insuredName" fields as search parameters.

Dictionary of string and string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "Limit": 5,
  "Offset": 0,
  "SearchParameters": {
    "policyNumber": "12345",
    "phoneNumber": "111-111-1111",
    "zipCode": "12345"
  }
}
                                
                                 <SearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Search">
  <Limit>5</Limit>
  <Offset>0</Offset>
  <SearchParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>policyNumber</d2p1:Key>
      <d2p1:Value>12345</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>phoneNumber</d2p1:Key>
      <d2p1:Value>111-111-1111</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>zipCode</d2p1:Key>
      <d2p1:Value>12345</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </SearchParameters>
  <SortBy i:nil="true" />
</SearchRequest>

Response Information

AccountSearchResponse

NameDescriptionTypeRequired*Additional information
Results

List of accounts matching the search criteria

Collection of AccountSearchResult Yes
TotalCount

Total number of results

integer Yes
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

AccountSearchResult

NameDescriptionTypeRequired*Additional information
CustomerId

ONE Inc customer identifier that will be used to fetch available payment methods

string Yes
AccountId

Account Identifier

string Yes
Properties

Generic Key/Value Property list. Every value from this list could be added to search result view

Dictionary of string and string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "Results": [
    {
      "CustomerId": "49437EE0-9C1D-483A-99C3-3C3197FEF8C2",
      "AccountId": "12345",
      "Properties": {
        "policyNumber": "AB-123-456",
        "customerName": "John Smith",
        "accountNumber": "B55BA07A-94EF-49AF-9B2D-669812C8F070"
      }
    },
    {
      "CustomerId": "4D82B38F-1521-4DEE-B811-A3596B21755B",
      "AccountId": "56789",
      "Properties": {
        "policyNumber": "AB-456-789",
        "customerName": "Jane Doe",
        "accountNumber": "B55BA07A-94EF-49AF-9B2D-669812C8F070"
      }
    }
  ],
  "TotalCount": 0,
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<AccountSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Search">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
  <Results>
    <AccountSearchResult>
      <AccountId>12345</AccountId>
      <CustomerId>49437EE0-9C1D-483A-99C3-3C3197FEF8C2</CustomerId>
      <Properties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>policyNumber</d4p1:Key>
          <d4p1:Value>AB-123-456</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>customerName</d4p1:Key>
          <d4p1:Value>John Smith</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>accountNumber</d4p1:Key>
          <d4p1:Value>B55BA07A-94EF-49AF-9B2D-669812C8F070</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Properties>
    </AccountSearchResult>
    <AccountSearchResult>
      <AccountId>56789</AccountId>
      <CustomerId>4D82B38F-1521-4DEE-B811-A3596B21755B</CustomerId>
      <Properties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>policyNumber</d4p1:Key>
          <d4p1:Value>AB-456-789</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>customerName</d4p1:Key>
          <d4p1:Value>Jane Doe</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>accountNumber</d4p1:Key>
          <d4p1:Value>B55BA07A-94EF-49AF-9B2D-669812C8F070</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Properties>
    </AccountSearchResult>
  </Results>
  <TotalCount>0</TotalCount>
</AccountSearchResponse>

POST accounts/submitPayments?url={url}&portalOneAuthKey={portalOneAuthKey}

This method is used for submit payment acknowledge

MethodEndpoint
SubmitPaymentsAcknowledge https://stgportalone.processonepayments.com/ExternalApi/accounts/submitPayments?url={url}&portalOneAuthKey={portalOneAuthKey}

URI Parameters

NameDescriptionTypeRequired*Additional information
url

string Yes
portalOneAuthKey

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 

Response Information

SubmitPaymentsAcknowledgeResponse

NameDescriptionTypeRequired*Additional information
IsAcknowledgeDelivered

Indicate if Acknowledge is delivered.

boolean No
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "IsAcknowledgeDelivered": true,
  "IsSuccessful": true,
  "ErrorMessage": "sample string 3"
}
<SubmitPaymentsAcknowledgeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">sample string 3</ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
  <IsAcknowledgeDelivered>true</IsAcknowledgeDelivered>
</SubmitPaymentsAcknowledgeResponse>

Notification

POST notifications/acknowledgePayments

Acknowledgement Payment API will be used to notify the source system when a Quick Pay Payment is successfully processed. This API can be used for single/ multiple Payment Acknowledgements at a time. This is the preferred API for clients to implement as it caters to multiple feature families. Acknowledgement via this endpoint can be controlled via settings in Portal One.

MethodEndpoint
AcknowledgePayments https://stgportalone.processonepayments.com/ExternalApi/notifications/acknowledgePayments

AcknowledgePaymentsRequest

NameDescriptionTypeRequired*Additional information
SubmitPaymentAcknowledgeRequests

Payment acknowledgement request models.

Collection of AcknowledgePaymentDetails Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

AcknowledgePaymentDetails

NameDescriptionTypeRequired*Additional information
CustomerId

One Inc customer identifier.

string No
ExternalCustomerId

External generated ID of Customer

string No
AccountId

Account Identifier

string No
CustomerName

Name that was provided with a card or bank account information. Passed back as Customer Name

string Yes
AuthCode

Will be returned for payments with PaymentCategory of creditCard only. Returns authorization code provided by issuing bank.

string No
TokenId

Unique identifier that represents a saved card or bank account. Can be used to safely make payments of with the save payment method.

string No
PaymentMethod

Payment method

PaymentMethodBase Can be one of the following types: CreditCardPaymentMethodDetails EftPaymentMethodDetails CreditCardPaymentMethodDetails EftPaymentMethodDetails Yes
BatchNumber

ProcessOne Batch ID, file identifier. Identifies which batch is associated with a transaction.

integer Yes
TransactionId

ProcessOne Transaction ID, payment identifier. Will be displayed as Confirmation number on the modal and web pages. Can be used to search for a specific payment in the ProcessOne Transaction Report

string Yes
SessionId

Unique identifier echoed back from call to a PortalOne operation.

string No
PaymentAmount

The premium payment amount excluding any convenience fees.

decimal number Yes
Timezone

Time zone code. (PST, EST)

string Yes
TransactionDate

Date Stamp of the payment

date Yes
OutboundApiKey

Unique Identifier for the outbound API.

string No
ClientReferenceData

Client reference data

ClientReferenceData Yes
ExtendedParameters

Extended parameters

Dictionary of string and object No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

PaymentMethodBase

NameDescriptionTypeRequired*Additional information
Type

Name of the Payment Method Details Type, like "CreditCardPaymentMethodDetails", "EftPaymentMethodDetails"

string Yes
LastFourDigits

Last 4 digits of the card or bank account

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

CreditCardPaymentMethodDetails

NameDescriptionTypeRequired*Additional information
CardType

Will be returned for payments with PaymentCategory of creditCard only. Returns the card type that was processed.

CreditCardType Yes
HolderZip

Will be returned for payments with PaymentCategory of creditCard only. Returns zip code of card holder passed back from billingZip on request.

string Yes
CardExpirationMonth

Will be returned for payments with PaymentCategory of creditCard only. Returns the card expiration month.

integer Yes
CardExpirationYear

Will be returned for payments with PaymentCategory of creditCard only. Returns the card expiration year.

integer Yes
Type

Name of the Payment Method Details Type, like "CreditCardPaymentMethodDetails", "EftPaymentMethodDetails"

string Yes
LastFourDigits

Last 4 digits of the card or bank account

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

CreditCardType

Possible enumeration values:

NameValueDescription
Visa

1

Visa

MasterCard

2

MasterCard

AmericanExpress

3

American Express

Discover

4

Discover

PinlessDebitGeneric

5

PinlessDebitGeneric

Star

6

Star

Nyce

7

Nyce

Pulse

8

Pulse

Other

99

Other

EftPaymentMethodDetails

NameDescriptionTypeRequired*Additional information
AccountType

Will be returned for payments with PaymentCategory of eCheck only. Returns the account type of the bank account: Checking or Saving.

EftAccountType Yes
BankName

Will be returned for payments with PaymentCategory of eCheck only. Returns the name of a bank associated with a provided account.

string Yes
Type

Name of the Payment Method Details Type, like "CreditCardPaymentMethodDetails", "EftPaymentMethodDetails"

string Yes
LastFourDigits

Last 4 digits of the card or bank account

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

EftAccountType

Possible enumeration values:

NameValueDescription
Checking

1

Checking.

Savings

2

Savings.

ClientReferenceData

NameDescriptionTypeRequired*Additional information
ClientReferenceData1

Reference number such as Policy, Quote, or Claim Number.

string Yes
ClientReferenceData2

External TransactionId value.

string No
ClientReferenceData3

Location data such as the office the transaction originated.

string No
ClientReferenceData4

Transaction additional information.

string No
ClientReferenceData5

Additional reference source account data such as an account number for a multi-policy account.

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "SubmitPaymentAcknowledgeRequests": [
    {
      "CustomerId": "sample string 1",
      "ExternalCustomerId": "sample string 2",
      "AccountId": "sample string 3",
      "CustomerName": "sample string 4",
      "AuthCode": "sample string 5",
      "TokenId": "sample string 6",
      "BatchNumber": 1,
      "TransactionId": "sample string 7",
      "SessionId": "sample string 8",
      "PaymentAmount": 1.0,
      "Timezone": "sample string 9",
      "TransactionDate": "2020-10-27T07:19:37",
      "OutboundApiKey": "sample string 10",
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "ExtendedParameters": {
        "sample string 1": {},
        "sample string 3": {}
      }
    },
    {
      "CustomerId": "sample string 1",
      "ExternalCustomerId": "sample string 2",
      "AccountId": "sample string 3",
      "CustomerName": "sample string 4",
      "AuthCode": "sample string 5",
      "TokenId": "sample string 6",
      "BatchNumber": 1,
      "TransactionId": "sample string 7",
      "SessionId": "sample string 8",
      "PaymentAmount": 1.0,
      "Timezone": "sample string 9",
      "TransactionDate": "2020-10-27T07:19:37",
      "OutboundApiKey": "sample string 10",
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "ExtendedParameters": {
        "sample string 1": {},
        "sample string 3": {}
      }
    }
  ]
}
                                
                                 <AcknowledgePaymentsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Payment">
  <SubmitPaymentAcknowledgeRequests>
    <AcknowledgePaymentDetails>
      <AccountId>sample string 3</AccountId>
      <AuthCode>sample string 5</AuthCode>
      <BatchNumber>1</BatchNumber>
      <ClientReferenceData>
        <ClientReferenceData1>sample string 1</ClientReferenceData1>
        <ClientReferenceData2>sample string 2</ClientReferenceData2>
        <ClientReferenceData3>sample string 3</ClientReferenceData3>
        <ClientReferenceData4>sample string 4</ClientReferenceData4>
        <ClientReferenceData5>sample string 5</ClientReferenceData5>
      </ClientReferenceData>
      <CustomerId>sample string 1</CustomerId>
      <CustomerName>sample string 4</CustomerName>
      <ExtendedParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </ExtendedParameters>
      <ExternalCustomerId>sample string 2</ExternalCustomerId>
      <OutboundApiKey>sample string 10</OutboundApiKey>
      <PaymentAmount>1</PaymentAmount>
      <PaymentMethod i:nil="true" />
      <SessionId>sample string 8</SessionId>
      <Timezone>sample string 9</Timezone>
      <TokenId>sample string 6</TokenId>
      <TransactionDate>2020-10-27T07:19:37.6200363-07:00</TransactionDate>
      <TransactionId>sample string 7</TransactionId>
    </AcknowledgePaymentDetails>
    <AcknowledgePaymentDetails>
      <AccountId>sample string 3</AccountId>
      <AuthCode>sample string 5</AuthCode>
      <BatchNumber>1</BatchNumber>
      <ClientReferenceData>
        <ClientReferenceData1>sample string 1</ClientReferenceData1>
        <ClientReferenceData2>sample string 2</ClientReferenceData2>
        <ClientReferenceData3>sample string 3</ClientReferenceData3>
        <ClientReferenceData4>sample string 4</ClientReferenceData4>
        <ClientReferenceData5>sample string 5</ClientReferenceData5>
      </ClientReferenceData>
      <CustomerId>sample string 1</CustomerId>
      <CustomerName>sample string 4</CustomerName>
      <ExtendedParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </ExtendedParameters>
      <ExternalCustomerId>sample string 2</ExternalCustomerId>
      <OutboundApiKey>sample string 10</OutboundApiKey>
      <PaymentAmount>1</PaymentAmount>
      <PaymentMethod i:nil="true" />
      <SessionId>sample string 8</SessionId>
      <Timezone>sample string 9</Timezone>
      <TokenId>sample string 6</TokenId>
      <TransactionDate>2020-10-27T07:19:37.6200363-07:00</TransactionDate>
      <TransactionId>sample string 7</TransactionId>
    </AcknowledgePaymentDetails>
  </SubmitPaymentAcknowledgeRequests>
</AcknowledgePaymentsRequest>

Response Information

AcknowledgePaymentsResponse

NameDescriptionTypeRequired*Additional information
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<AcknowledgePaymentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Payment">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
</AcknowledgePaymentsResponse>

POST notifications/acknowledgePaymentMethods

This method is used to notify the source system that payment method has been submitted. This Payment Acknowledgement is specifically used for IVR in the case when the Policy System originates Payment transactions via IVR and cannot consume Payment Postbacks.

MethodEndpoint
AcknowledgePaymentMethods https://stgportalone.processonepayments.com/ExternalApi/notifications/acknowledgePaymentMethods

AcknowledgePaymentMethodsRequest

NameDescriptionTypeRequired*Additional information
SubmitPaymentMethodsDetails

Payment method acknowledgement details models

Collection of SubmitPaymentMethodsDetails No
ExtendedParameters

Extended parameters

Dictionary of string and object No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

SubmitPaymentMethodsDetails

NameDescriptionTypeRequired*Additional information
CustomerId

One Inc customer identifier.

string No
ExternalCustomerId

External generated ID of Customer

string No
AccountId

Account Identifier

string No
CustomerName

Name that was provided with a card or bank account information. Passed back as Customer Name

string No
TokenId

Unique identifier that represents a saved card or bank account. Can be used to safely make payments of with the save payment method.

string No
PaymentMethod

Payment method

PaymentMethodBase Can be one of the following types: CreditCardPaymentMethodDetails EftPaymentMethodDetails CreditCardPaymentMethodDetails EftPaymentMethodDetails No
ClientReferenceData

Client reference data

ClientReferenceData No
ExtendedParameters

Extended parameters

Dictionary of string and object No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "SubmitPaymentMethodsDetails": [
    {
      "CustomerId": "sample string 1",
      "ExternalCustomerId": "sample string 2",
      "AccountId": "sample string 3",
      "CustomerName": "sample string 4",
      "TokenId": "sample string 5",
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "ExtendedParameters": {
        "sample string 1": {},
        "sample string 3": {}
      }
    },
    {
      "CustomerId": "sample string 1",
      "ExternalCustomerId": "sample string 2",
      "AccountId": "sample string 3",
      "CustomerName": "sample string 4",
      "TokenId": "sample string 5",
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "ExtendedParameters": {
        "sample string 1": {},
        "sample string 3": {}
      }
    }
  ],
  "ExtendedParameters": {
    "sample string 1": {},
    "sample string 3": {}
  }
}
                                
                                 <AcknowledgePaymentMethodsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Payment">
  <ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </ExtendedParameters>
  <SubmitPaymentMethodsDetails>
    <SubmitPaymentMethodsDetails>
      <AccountId>sample string 3</AccountId>
      <ClientReferenceData>
        <ClientReferenceData1>sample string 1</ClientReferenceData1>
        <ClientReferenceData2>sample string 2</ClientReferenceData2>
        <ClientReferenceData3>sample string 3</ClientReferenceData3>
        <ClientReferenceData4>sample string 4</ClientReferenceData4>
        <ClientReferenceData5>sample string 5</ClientReferenceData5>
      </ClientReferenceData>
      <CustomerId>sample string 1</CustomerId>
      <CustomerName>sample string 4</CustomerName>
      <ExtendedParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </ExtendedParameters>
      <ExternalCustomerId>sample string 2</ExternalCustomerId>
      <PaymentMethod i:nil="true" />
      <TokenId>sample string 5</TokenId>
    </SubmitPaymentMethodsDetails>
    <SubmitPaymentMethodsDetails>
      <AccountId>sample string 3</AccountId>
      <ClientReferenceData>
        <ClientReferenceData1>sample string 1</ClientReferenceData1>
        <ClientReferenceData2>sample string 2</ClientReferenceData2>
        <ClientReferenceData3>sample string 3</ClientReferenceData3>
        <ClientReferenceData4>sample string 4</ClientReferenceData4>
        <ClientReferenceData5>sample string 5</ClientReferenceData5>
      </ClientReferenceData>
      <CustomerId>sample string 1</CustomerId>
      <CustomerName>sample string 4</CustomerName>
      <ExtendedParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </ExtendedParameters>
      <ExternalCustomerId>sample string 2</ExternalCustomerId>
      <PaymentMethod i:nil="true" />
      <TokenId>sample string 5</TokenId>
    </SubmitPaymentMethodsDetails>
  </SubmitPaymentMethodsDetails>
</AcknowledgePaymentMethodsRequest>

Response Information

AcknowledgePaymentMethodsResponse

NameDescriptionTypeRequired*Additional information
ExtendedParameters

Dictionary of string and object No
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "ExtendedParameters": {
    "MakePaymentSuccess": "true",
    "PaymentProcessorTransactionId": "123456789",
    "PolicyIssuedSuccess": "true",
    "PolicyNumberAfterPromoteToPending": "123456",
    "PolicyReinstatedSuccess": "true"
  },
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<AcknowledgePaymentMethodsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Payment">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
  <ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>MakePaymentSuccess</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">true</d2p1:Value>
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>PaymentProcessorTransactionId</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">123456789</d2p1:Value>
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>PolicyIssuedSuccess</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">true</d2p1:Value>
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>PolicyNumberAfterPromoteToPending</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">123456</d2p1:Value>
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>PolicyReinstatedSuccess</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">true</d2p1:Value>
    </d2p1:KeyValueOfstringanyType>
  </ExtendedParameters>
</AcknowledgePaymentMethodsResponse>

AutoPay

POST autopay/paymentProcessed

This method is used to notify that recurring payment was processed

MethodEndpoint
PaymentProcessed https://stgportalone.processonepayments.com/ExternalApi/autopay/paymentProcessed

PaymentProcessedNotificationRequest

NameDescriptionTypeRequired*Additional information
TransactionId

Payment transaction identifier.

integer No
InstallmentPaymentStatus

Installment payment status.

InstallmentPlanPaymentStatus Yes
Amount

Payment amount.

decimal number No
Type

Transaction payment type.

PaymentType No
TransactionDate

Transaction processing date.

date No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

InstallmentPlanPaymentStatus

Possible enumeration values:

NameValueDescription
Scheduled

0

Payment will be processed for the first time.

Processed

1

Payment was successfully processed.

Retry

2

Payment will be retried on retry date.

Failed

3

Retry counts has been met. Payment will not process again.

Cancelled

4

Payment was cancelled and will not be processed.

Deleted

5

Payment was deleted and will not be processed.

PaymentType

Possible enumeration values:

NameValueDescription
CreditCard

1

Credit card payment type.

Eft

2

EFT payment type.

Request Formats

 
                                
                                 {
  "TransactionId": 123456,
  "InstallmentPaymentStatus": 1,
  "Amount": 10.0,
  "Type": 2,
  "TransactionDate": "2020-10-27T07:19:39"
}
                                
                                 <PaymentProcessedNotificationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.AutoPay">
  <Amount>10</Amount>
  <InstallmentPaymentStatus>Processed</InstallmentPaymentStatus>
  <TransactionDate>2020-10-27T07:19:39</TransactionDate>
  <TransactionId>123456</TransactionId>
  <Type>Eft</Type>
</PaymentProcessedNotificationRequest>

Response Information

PaymentProcessedNotificationResponse

NameDescriptionTypeRequired*Additional information
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<PaymentProcessedNotificationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.AutoPay">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
</PaymentProcessedNotificationResponse>

POST autopay/installmentPlanChanged

This method is used to notify that Auto Pay has been set up in InstallmentsOne

MethodEndpoint
InstallmentPlanChanged https://stgportalone.processonepayments.com/ExternalApi/autopay/installmentPlanChanged

InstallmentPlanChangedNotificationRequest

NameDescriptionTypeRequired*Additional information
InstallmentPlanDetails

Information on the Installment Plan and payment details. See InstallmentPlanDetails object definition.

InstallmentPlanDetails Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

InstallmentPlanDetails

NameDescriptionTypeRequired*Additional information
InstallmentPlanId

Unique identifier for the installment plan

integer Yes
PolicyRefNumber

Used to pass policy number or quote number for reference. This value is searchable and displayed in the Transaction search.

string Yes
InstallmentPlanStatus

The status of the installment plan: Active, Cancelled, Completed.

InstallmentPlanStatus Yes
ProfileId

The ProfileId associated to the Installment Plan.

integer Yes
InstallmentPlanTokenId

Payment method TokenId that will be used for the payments.

string Yes
ClientRefValues

Array of ClientRefValueDetails associated to the ProfileId.

Collection of ClientRefValueDetails Yes
InstallmentPlanPaymentDetails

Details on each of the payments associated to the InstallmentPlan as an array. If a downpayment was made with the enrollment, the details will be provided as part of the array. See InstallmentPlanPaymentDetail object definition.

Collection of InstallmentPlanPaymentDetails Yes
CustomerId

ONE Inc customer identifier that will be used to fetch available payment methods.

string No
ExternalCustomerId

External generated ID of Customer.

string No
Email

Customer email address.

string No
WithdrawalFrequency

Specifies how often payments should be made.

WithdrawalFrequency Yes
AmountPerInstallment

Payment amount for each installment.

decimal number Yes
NumberOfInstallments

Number of installment payments to be made by the installment plan.

integer Yes
WithdrawalDay

Specifies day of month when payments should be made.

integer Yes
ExternalSchedulerEndpoint

This field value should only be sent when autoPayEngineType = "Carrier". Digital Payments will then use this endpoint to eventually send user-selected Payment Preferences for Auto-Pay Plan creation and scheduling.

string No
PaymentMethod

Payment method

PaymentMethodBase Can be one of the following types: CreditCardPaymentMethodDetails EftPaymentMethodDetails No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

InstallmentPlanStatus

Possible enumeration values:

NameValueDescription
Active

0

Installment plan is active and has additional payments to be processed.

Completed

1

Installment plan has been completed i.e. all payments have been processed.

Cancelled

2

Installment plan was cancelled and no further payments will be processed.

ClientRefValueDetails

NameDescriptionTypeRequired*Additional information
PropertyName

Property name.

string Yes

Max length: 250

PropertyValue

Property value.

string No

Max length: 250

* If field is not required, it can be omitted. Please do not send Null or invalid values.

InstallmentPlanPaymentDetails

NameDescriptionTypeRequired*Additional information
InstallmentPlanPaymentId

Unique value for each payment under the installment payment plan.

integer Yes
PolicyRefNumber

Used to pass policy number or quote number for reference. This value is searchable and displayed in the Transaction search.

string Yes
InstallmentPlanPaymentStatus

The status of the Installment Plan Payment. Values: scheduled, processed, retry (payment will be retried on retry date), failed (retry counts has been met, payment will not process again), cancelled (payment will be skipped or was skipped if date is in the past).

InstallmentPlanPaymentStatus Yes
IsDownpayment

If the payment was a downpayment made during enrollment the value will be true. For all other installment payments value will be false.

boolean Yes
Amount

The dollar amount of the payment.

decimal number Yes
IncludeFee

Indicates if the payment will be/was processed with or without a fee.

boolean Yes
PostedAmount

The total amount processed. Includes the amount of fees.

decimal number No
EffectiveDate

The scheduled date of the payment as determined by the installment plan.

date Yes
NextRetryDate

The next retry date for a payment that failed during processing and was subsequently scheduled to be retried (based upon retry settings).

date No
UpdatedDate

The most recent date and time stamp on which the payment was updated by payment processing or via an API change.

date No
PaymentCategory

The category of payment that will be or was used for the payment. Values: CreditCard or Eft.

PaymentType Yes
TokenId

Token ID that was or will be used for the payment.

string Yes
TimeZone

Timezone code (PST, EST).

string Yes
TransactionDetails

Payment transaction results details. See TransactionDetails object definition.

TransactionDetails Yes
CreditCardDetails

Credit Card payment response details. See ProcessedCreditCardDetails object definition.

ProcessedCreditCardDetails No
EftDetails

Eft payment response details. See ProcessedEftDetails object definition.

ProcessedEftDetails No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

TransactionDetails

NameDescriptionTypeRequired*Additional information
ProcessedDate

Date and time stamp on which the payment was processed.

date Yes
ProcessOneTransactionId

ProcessOne payment Transaction number.

integer Yes
AuthCode

Authorization code sent from Bank. Can be used for reference.

string No
BatchNumber

The batch number to which the ProcessOne transaction was attached.

integer No
PaymentResponseCode

Response code received when payment was made.

string Yes
PaymentResponseMessage

Readable response description received when payment was made.

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ProcessedCreditCardDetails

NameDescriptionTypeRequired*Additional information
LastFourDigits

Last four digits for the credit card number.

string Yes
ExpirationMonth

The expiration month of the card associated to the payment method.

integer Yes
ExpirationYear

The expiration year of the card associated to the payment method.

integer Yes
HolderAddress

The street address of card holder of the card associated to the payment method.

string No
Zip

The zip code of card holder of the card associated to the payment method.

string No
CardHolderName

The cardholder name.

string Yes
CardType

Type of card: Visa, MasterCard, AmericanExpress, Discover, or Debit.

CreditCardType Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ProcessedEftDetails

NameDescriptionTypeRequired*Additional information
LastFourDigits

Last four digits of the bank account.

string Yes
CustomerName

Customer Name associated to the bank account.

string Yes
BankName

The name of the Bank based off of Routing Number.

string Yes
AccountType

Type of bank account: checking or savings.

EftAccountType Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

WithdrawalFrequency

Possible enumeration values:

NameValueDescription
Monthly

1

Each payment will be scheduled in 1 month increments from the first payments PaymentMonth.

Quarterly

3

Each payment will be scheduled in 3 month increments from the first payments PaymentMonth.

Semiannually

6

Each payment will be scheduled in 6 month increments from the first payments PaymentMonth.

Annually

12

Each payment will be scheduled in 12 month increments from the first payments PaymentMonth.

Request Formats

 
                                
                                 {
  "InstallmentPlanDetails": {
    "InstallmentPlanId": 42,
    "PolicyRefNumber": "AB-98765432",
    "InstallmentPlanStatus": 0,
    "ProfileId": 123,
    "InstallmentPlanTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
    "ClientRefValues": [
      {
        "PropertyName": "BillingZip",
        "PropertyValue": "95123"
      }
    ],
    "InstallmentPlanPaymentDetails": [
      {
        "InstallmentPlanPaymentId": 978,
        "PolicyRefNumber": "AB-98765432",
        "InstallmentPlanPaymentStatus": 1,
        "IsDownpayment": false,
        "Amount": 10.0,
        "IncludeFee": false,
        "PostedAmount": 10.0,
        "EffectiveDate": "2020-09-27T07:19:39.7607455",
        "PaymentCategory": 2,
        "TokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
        "TimeZone": "US/Pacific",
        "TransactionDetails": {
          "ProcessedDate": "2020-09-28T07:19:39.7607455",
          "ProcessOneTransactionId": 123456,
          "AuthCode": "1234",
          "BatchNumber": 111,
          "PaymentResponseCode": "Success",
          "PaymentResponseMessage": ""
        },
        "EftDetails": {
          "LastFourDigits": "1234",
          "CustomerName": "John Smith",
          "BankName": "### Bank",
          "AccountType": 1
        }
      },
      {
        "InstallmentPlanPaymentId": 979,
        "PolicyRefNumber": "AB-98765432",
        "InstallmentPlanPaymentStatus": 1,
        "IsDownpayment": false,
        "Amount": 10.0,
        "IncludeFee": false,
        "PostedAmount": 10.0,
        "EffectiveDate": "2020-10-27T07:19:39.7607455",
        "PaymentCategory": 2,
        "TokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
        "TimeZone": "US/Pacific",
        "TransactionDetails": {
          "ProcessedDate": "2020-10-27T07:19:39.7607455",
          "ProcessOneTransactionId": 123456,
          "AuthCode": "1234",
          "BatchNumber": 111,
          "PaymentResponseCode": "Success",
          "PaymentResponseMessage": ""
        },
        "EftDetails": {
          "LastFourDigits": "1234",
          "CustomerName": "John Smith",
          "BankName": "### Bank",
          "AccountType": 1
        }
      }
    ],
    "CustomerId": "49437EE0-9C1D-483A-99C3-3C3197FEF8C2",
    "ExternalCustomerId": "b89b041f-1384-49f3-819e-294912cb9604",
    "Email": "[email protected]",
    "WithdrawalFrequency": 3,
    "AmountPerInstallment": 100.0,
    "NumberOfInstallments": 3,
    "WithdrawalDay": 21,
    "ExternalSchedulerEndpoint": "https://example.com",
    "PaymentMethod": {
      "Type": "EftPaymentMethodDetails",
      "AccountType": 1,
      "BankName": "### Bank",
      "LastFourDigits": "1234"
    }
  }
}
                                
                                 <InstallmentPlanChangedNotificationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.AutoPay">
  <InstallmentPlanDetails>
    <AmountPerInstallment>100</AmountPerInstallment>
    <ClientRefValues>
      <ClientRefValueDetails>
        <PropertyName>BillingZip</PropertyName>
        <PropertyValue>95123</PropertyValue>
      </ClientRefValueDetails>
    </ClientRefValues>
    <CustomerId>49437EE0-9C1D-483A-99C3-3C3197FEF8C2</CustomerId>
    <Email>[email protected]</Email>
    <ExternalCustomerId>b89b041f-1384-49f3-819e-294912cb9604</ExternalCustomerId>
    <ExternalSchedulerEndpoint>https://example.com</ExternalSchedulerEndpoint>
    <InstallmentPlanId>42</InstallmentPlanId>
    <InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>10</Amount>
        <CreditCardDetails i:nil="true" />
        <EffectiveDate>2020-09-27T07:19:39.7607455-07:00</EffectiveDate>
        <EftDetails>
          <AccountType>Checking</AccountType>
          <BankName>### Bank</BankName>
          <CustomerName>John Smith</CustomerName>
          <LastFourDigits>1234</LastFourDigits>
        </EftDetails>
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>978</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Processed</InstallmentPlanPaymentStatus>
        <IsDownpayment>false</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>Eft</PaymentCategory>
        <PolicyRefNumber>AB-98765432</PolicyRefNumber>
        <PostedAmount>10</PostedAmount>
        <TimeZone>US/Pacific</TimeZone>
        <TokenId>1E8E5E3B-B438-4405-82AE-F5C64E1FF060</TokenId>
        <TransactionDetails>
          <AuthCode>1234</AuthCode>
          <BatchNumber>111</BatchNumber>
          <PaymentResponseCode>Success</PaymentResponseCode>
          <PaymentResponseMessage></PaymentResponseMessage>
          <ProcessOneTransactionId>123456</ProcessOneTransactionId>
          <ProcessedDate>2020-09-28T07:19:39.7607455-07:00</ProcessedDate>
        </TransactionDetails>
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>10</Amount>
        <CreditCardDetails i:nil="true" />
        <EffectiveDate>2020-10-27T07:19:39.7607455-07:00</EffectiveDate>
        <EftDetails>
          <AccountType>Checking</AccountType>
          <BankName>### Bank</BankName>
          <CustomerName>John Smith</CustomerName>
          <LastFourDigits>1234</LastFourDigits>
        </EftDetails>
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>979</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Processed</InstallmentPlanPaymentStatus>
        <IsDownpayment>false</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>Eft</PaymentCategory>
        <PolicyRefNumber>AB-98765432</PolicyRefNumber>
        <PostedAmount>10</PostedAmount>
        <TimeZone>US/Pacific</TimeZone>
        <TokenId>1E8E5E3B-B438-4405-82AE-F5C64E1FF060</TokenId>
        <TransactionDetails>
          <AuthCode>1234</AuthCode>
          <BatchNumber>111</BatchNumber>
          <PaymentResponseCode>Success</PaymentResponseCode>
          <PaymentResponseMessage></PaymentResponseMessage>
          <ProcessOneTransactionId>123456</ProcessOneTransactionId>
          <ProcessedDate>2020-10-27T07:19:39.7607455-07:00</ProcessedDate>
        </TransactionDetails>
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
    </InstallmentPlanPaymentDetails>
    <InstallmentPlanStatus>Active</InstallmentPlanStatus>
    <InstallmentPlanTokenId>1E8E5E3B-B438-4405-82AE-F5C64E1FF060</InstallmentPlanTokenId>
    <NumberOfInstallments>3</NumberOfInstallments>
    <PaymentMethod i:type="EftPaymentMethodDetails">
      <LastFourDigits>1234</LastFourDigits>
      <AccountType>Checking</AccountType>
      <BankName>### Bank</BankName>
    </PaymentMethod>
    <PolicyRefNumber>AB-98765432</PolicyRefNumber>
    <ProfileId>123</ProfileId>
    <WithdrawalDay>21</WithdrawalDay>
    <WithdrawalFrequency>Quarterly</WithdrawalFrequency>
  </InstallmentPlanDetails>
</InstallmentPlanChangedNotificationRequest>

Response Information

InstallmentPlanChangedNotificationResponse

NameDescriptionTypeRequired*Additional information
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<InstallmentPlanChangedNotificationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.AutoPay">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
</InstallmentPlanChangedNotificationResponse>

POST autopay/currentPaymentAmount

This method is used for getting current payment amount. Provided amount will be charged for the request policy

MethodEndpoint
CurrentPaymentAmount https://stgportalone.processonepayments.com/ExternalApi/autopay/currentPaymentAmount

CurrentPaymentAmountRequest

NameDescriptionTypeRequired*Additional information
PolicyNumber

Policy number.

string Yes
ZipCode

Policy zip code.

string Yes
InstallmentPlanId

Auto pay installment plan identifier.

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "PolicyNumber": "AB-98765432",
  "ZipCode": "95123",
  "InstallmentPlanId": "42"
}
                                
                                 <CurrentPaymentAmountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.AutoPay">
  <InstallmentPlanId>42</InstallmentPlanId>
  <PolicyNumber>AB-98765432</PolicyNumber>
  <ZipCode>95123</ZipCode>
</CurrentPaymentAmountRequest>

Response Information

CurrentPaymentAmountResponse

NameDescriptionTypeRequired*Additional information
PolicyId

Policy Identifier.

string Yes
IsRecurringPaymentDue

Is recurring payment due today.

boolean Yes
Amount

Amount to charge.

decimal number Yes
PolicyStatus

Policy Status

PolicyStatus Yes
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

PolicyStatus

Possible enumeration values:

NameValueDescription
Active

1

Payment will be processed, no changes in installment plan.

Cancelled

2

Payment will be skipped, installment plan is cancelled, no renewals will happen.

CancelledWithRemainingAmountDue

3

Payment will be processed, installment plan is cancelled, no renewals will happen.

Response Formats

{
  "PolicyId": "12345",
  "IsRecurringPaymentDue": true,
  "Amount": 100.0,
  "PolicyStatus": 1,
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<CurrentPaymentAmountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.AutoPay">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
  <Amount>100</Amount>
  <IsRecurringPaymentDue>true</IsRecurringPaymentDue>
  <PolicyId>12345</PolicyId>
  <PolicyStatus>Active</PolicyStatus>
</CurrentPaymentAmountResponse>

Claims Pay

ClaimsSystemApi

This section describes the APIs that need to be made available to implement ClaimsPay. The Claims System API is owned by the claims system and called by ClaimsPay. The APIs will be used to request data from your claims system for user validation and to pass back information to your claims system on user activities.

Authentication

Available authentication schemes for Claims System API endpoints are Basic Auth (username/password) or no authentication.

Validate Portal User

In order for a user to access the ClaimsPay portal, the system uses multilevel authentication to confirm the users identity. The portal requests payee Information from the claims system which will be used to:

  • identify what validation criteria will be requested from the user

  • validate the user based upon the user entered criteria and display contact options that will allow a user to select the delivery option for an identification code

POST getidentificationcriteria

The GetIdentificationCriteria method is used to provide the criteria which will be requested to validate the user from the claims system.

MethodEndpoint
GetIdentificationCriteria https://stgportalone.processonepayments.com/ExternalApi/getidentificationcriteria

GetIdentificationCriteriaRequest

NameDescriptionTypeRequired*Additional information
AccountId

The AccountId for the user that is attempting to access the website.

integer No
ContactId

The ContactId for the user who is attempting to access the website.

integer No
EpayRequestId

The identifier for the ePay request.

integer No
ExtendedParameters

The collection of key value pairs for optional parameters.

Dictionary of string and object
Extended Parameters
No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Extended Parameters

Key Description
ApprovalRequestId The ApprovalRequestId will be sent if the API call is triggered when a user is accessing the Approval and Payment portal via a link that was sent by an Approval Request. The value will match the ApprovalRequestId which was returned in the CreateApprovalRequest response.

Request Formats

 
                                
                                 {
  "AccountId": 135,
  "ContactId": 246,
  "EpayRequestId": 369,
  "ExtendedParameters": {
    "ApprovalRequestId": 123456
  }
}
                                
                                 <GetIdentificationCriteriaRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.ClamsSystem">
  <AccountId>135</AccountId>
  <ContactId>246</ContactId>
  <EpayRequestId>369</EpayRequestId>
  <ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>ApprovalRequestId</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int">123456</d2p1:Value>
    </d2p1:KeyValueOfstringanyType>
  </ExtendedParameters>
</GetIdentificationCriteriaRequest>

Response Information

GetIdentificationCriteriaResponse

NameDescriptionTypeRequired*Additional information
VerificationCriteria

The validation values for the verificationCriteria for the company contact or individual that is identified from the request information. Each criteria will be a string of a user friendly display value. 10 question limit.

Collection of string No
ValidationRules

Validation rules for each value of the validation criteria. Not required.

Collection of ValidationRule No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ValidationRule

NameDescriptionTypeRequired*Additional information
Name

Required string. Defines the field's name. The name must be presented in the 'VerificationCriteria' array.

string No
Type

Optional string. Defines the field's data validation type. Can be set to Numeric, Alphanumeric, or Date (format is fixed as 'MM/DD/YYYY').

string No
MinLength

Optional integer. Defines the field's minimum length. Applicable for validation types Numeric and Alphanumeric.

integer No
MaxLength

Optional integer. Defines the field's maximum length. If not specified, the length will be checked for compliance with the minimum length value.

integer No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "VerificationCriteria": [
    "ValidationCriteria1",
    "ValidationCriteria2"
  ],
  "ValidationRules": [
    {
      "Name": "ValidationCriteria1",
      "Type": "Alphanumeric",
      "MinLength": 1,
      "MaxLength": 10
    },
    {
      "Name": "ValidationCriteria2",
      "Type": "Alphanumeric",
      "MinLength": 1,
      "MaxLength": 10
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<GetIdentificationCriteriaResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.ClamsSystem">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage></ResponseMessage>
  <ValidationRules>
    <ValidationRule>
      <MaxLength>10</MaxLength>
      <MinLength>1</MinLength>
      <Name>ValidationCriteria1</Name>
      <Type>Alphanumeric</Type>
    </ValidationRule>
    <ValidationRule>
      <MaxLength>10</MaxLength>
      <MinLength>1</MinLength>
      <Name>ValidationCriteria2</Name>
      <Type>Alphanumeric</Type>
    </ValidationRule>
  </ValidationRules>
  <VerificationCriteria xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>ValidationCriteria1</d2p1:string>
    <d2p1:string>ValidationCriteria2</d2p1:string>
  </VerificationCriteria>
</GetIdentificationCriteriaResponse>

POST verifyidentity

The VerifyIdentity method is used to verify the user entered IdentificationCriteria values and get payee contact information from claims system to complete authentication and allow user to access website, after registration if needed

MethodEndpoint
VerifyIdentity https://stgportalone.processonepayments.com/ExternalApi/verifyidentity

VerifyIdentityRequest

NameDescriptionTypeRequired*Additional information
AccountId

The accountId that associated to the user who is being authenticated.

integer No
ContactId

The ContactId for the user who is attempting to access the website.

integer No
EpayRequestId

The identifier for the ePay request.

integer No
ExtendedParameters

The collection of key value pairs for optional parameters.

Dictionary of string and string No
VerificationResponse

The data for verification.

Collection of VerificationResponse No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

VerificationResponse

NameDescriptionTypeRequired*Additional information
VerificationCriteria

The validation criteria that was provided with the GetIdentificationCriteriaResponse.

string No
VerificationValue

The user entered value for each requested verification.

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AccountId": 135,
  "ContactId": 246,
  "EpayRequestId": 369,
  "ExtendedParameters": {
    "ExtendedParameter1": "Extended Parameter 1 Value",
    "ExtendedParameter2": "Extended Parameter 2 Value"
  },
  "VerificationResponse": [
    {
      "VerificationCriteria": "ValidationCriteria1",
      "VerificationValue": "Verification Value 1"
    },
    {
      "VerificationCriteria": "ValidationCriteria2",
      "VerificationValue": "Verification Value 2"
    }
  ]
}
                                
                                 <VerifyIdentityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.ClamsSystem">
  <AccountId>135</AccountId>
  <ContactId>246</ContactId>
  <EpayRequestId>369</EpayRequestId>
  <ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>ExtendedParameter1</d2p1:Key>
      <d2p1:Value>Extended Parameter 1 Value</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>ExtendedParameter2</d2p1:Key>
      <d2p1:Value>Extended Parameter 2 Value</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ExtendedParameters>
  <VerificationResponse>
    <VerificationResponse>
      <VerificationCriteria>ValidationCriteria1</VerificationCriteria>
      <VerificationValue>Verification Value 1</VerificationValue>
    </VerificationResponse>
    <VerificationResponse>
      <VerificationCriteria>ValidationCriteria2</VerificationCriteria>
      <VerificationValue>Verification Value 2</VerificationValue>
    </VerificationResponse>
  </VerificationResponse>
</VerifyIdentityRequest>

Response Information

VerifyIdentityResponse

NameDescriptionTypeRequired*Additional information
ResponseCode

ResponseCode that indicates if the entered VerificationCriteria matched what is on record.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

ContactOptions

Contact options which can be used to receive an identification code.

Collection of ContactOption No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ContactOption

NameDescriptionTypeRequired*Additional information
ContactOptionMethod

Value is phone.

string No
ContactOptionValue

10 digit number with no spaces or symbols.

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": "",
  "ContactOptions": [
    {
      "ContactOptionMethod": "phone",
      "ContactOptionValue": "916-123-4567"
    }
  ]
}
<VerifyIdentityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.ClamsSystem">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage></ResponseMessage>
  <ContactOptions>
    <ContactOption>
      <ContactOptionMethod>phone</ContactOptionMethod>
      <ContactOptionValue>916-123-4567</ContactOptionValue>
    </ContactOption>
  </ContactOptions>
</VerifyIdentityResponse>

POST approvalrequestupdate

The Approval Request Update is sent when an event occurs that changes the status of the Approval Request.

MethodEndpoint
ApprovalRequestUpdate https://stgportalone.processonepayments.com/ExternalApi/approvalrequestupdate

ApprovalRequestUpdateRequest

NameDescriptionTypeRequired*Additional information
OperationId

Unique GUID for an event to prevent duplication when an operation communication is sent more than once due to lack of response.

string No
EventType

The type of event that has occurred to trigger the api.

ApprovalRequestUpdateEventType No
EventDate

The date of the event.

date No
TimeZone

Time zone code. (PST, EST)

string No
ClaimNumber

Claim number for which the approval process will be completed.

string No
ApprovalRequestId

Unique identifier for the approval request.

integer No
ProcessType

The process type for the approval request.

string
Process Type Values
No
Status

The status of the approval request.

ApprovalRequestStatus No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ApprovalRequestUpdateEventType

Possible enumeration values:

NameValueDescription
Completed

1

The approval request process has been completed. All parties have completed their actions and if request included payment processing, payments have been submitted.

Rejected

2

The claim payment was rejected by one of the approval request parties that had a role which included providing approval.

Expired

3

The approval request has expired before all parties completed their action.

Cancelled

4

The approval request was cancelled.

MarkedIncomplete

5

The approval request was marked as incomplete. At least one payment was processed and at least one payment was not completed within the allowable timeframe.

Process Type Values

Name Description
MultiPartyPayment System will create an approval request involving multiple parties.Once all claim parties have completed the required actions based upon the role, a payment will be processed.
IssueCheckPayment System will create an approval request to issue a check with a mail to party and 1-4 pay to names. The approval request parties will not be required to complete any action.
SinglePartyPayment System will create an approval request for a single party.Once the party completes the required action, the system will process a payment.
SinglePartySave System will create an approval request for a single party to capture a payment method option.

ApprovalRequestStatus

Possible enumeration values:

NameValueDescription
Initiated

1

The approval process has been initiated.

Completed

2

The approval process has been completed (all approval parties completed their actions and payments were processed).

Rejected

3

The claim payment was rejected by one of the approval request parties.

Cancelled

4

The approval request has been canceled.

Expired

5

At least one of the approval request parties did not complete their required action prior to the Expiration Date.

Incomplete

6

At least one of the approval request payment recipients did not complete their required action prior to the Expiration Date and at least one payment recipient's payment was processed.

AuthorityHold

7

The approval request has been created and is on authority hold until it is released.

Request Formats

 
                                
                                 {
  "OperationId": "58CF5D97-0725-4ABA-9705-E4F29D9B756C",
  "EventType": 1,
  "EventDate": "2020-10-27T07:19:42",
  "TimeZone": "US/Pacific",
  "ClaimNumber": "123123123",
  "ApprovalRequestId": 123456,
  "ProcessType": "SinglePartyPayment",
  "Status": 2
}
                                
                                 <ApprovalRequestUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.ClamsSystem">
  <ApprovalRequestId>123456</ApprovalRequestId>
  <ClaimNumber>123123123</ClaimNumber>
  <EventDate>2020-10-27T07:19:42</EventDate>
  <EventType>Completed</EventType>
  <OperationId>58CF5D97-0725-4ABA-9705-E4F29D9B756C</OperationId>
  <ProcessType>SinglePartyPayment</ProcessType>
  <Status>Completed</Status>
  <TimeZone>US/Pacific</TimeZone>
</ApprovalRequestUpdateRequest>

Response Information

ApprovalRequestUpdateResponse

NameDescriptionTypeRequired*Additional information
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<ApprovalRequestUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.ClamsSystem">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage></ResponseMessage>
</ApprovalRequestUpdateResponse>

POST approvalrequestpartyupdate

The Approval Request Party Update is sent when an event occurs that changes the status of the Approval Request Party.

MethodEndpoint
ApprovalRequestPartyUpdate https://stgportalone.processonepayments.com/ExternalApi/approvalrequestpartyupdate

ApprovalRequestPartyUpdateRequest

NameDescriptionTypeRequired*Additional information
OperationId

Unique GUID for an event to prevent duplication when an operation communication is sent more than once due to lack of response.

string No
EventType

The event that occurred to trigger the send of the ApprovalRequestPartyUpdateRequest.

ApprovalRequestPartyUpdateEventType No
EventDate

The date of the event.

date No
TimeZone

Time zone code. (PST, EST)

string No
ApprovalRequestPartyId

Approval Request Party Identifier.

integer No
AccountId

ClaimsPay Account Identifier.

integer No
ContactId

Company Contact identifier. Only applicable to company accounts.

integer No
ProcessType

The process type for the approval request.

string
Process Type Values
No
ApprovalRole

The role that defines the actions the claim party will complete as part of the approval request.

ApprovalRequestPartyRole No
LinkDeliveryType

The delivery method to receive the link to the ClaimsPay approval website.

InvitationMessageDeliveryType No
EmailAddress

The email address for the approval party to which approval process emails are sent.

string No
PhoneNumber

The Phone Number for the approval party to which approval process text messages are sent.

string No
FullName

First and Last name of the claim party.

string No
CompanyName

Company name if the ClaimsPayAccountType is Company.

string No
Status

The status of the action that the claim party must complete based upon their role.

ApprovalRequestPartyStatus No
DisputeComment

Applicable to ApprovalRequestPartyStatus is Rejected.

string No
PaymentSummary

Payment information.

PaymentSummary No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ApprovalRequestPartyUpdateEventType

Possible enumeration values:

NameValueDescription
CommunicationSendError

1

The attempt to send the approval process initiated communication has been unsuccessful.

ActionCompleted

2

Approval request party completed the required approval process actions as defined for their role.

Rejected

3

The approval request party disputed the claim payment as defined by the approval request.

PaymentFailed

4

The payment attempt for this approval request party failed. No further action will be taken as part of this approval request.

PaymentSuccessful

5

The payment was completed without errors for this approval request party.

WebsiteAccessBlocked

6

The user had too many failed attempts to access the website and was blocked for security reasons.

PrepareCheck

7

The party has selected check. The check payment should be fulfilled by the source system.

PaymentIncomplete

8

The approval request was marked Incomplete before this party completed the required action to receive the claim payment.

MessageDeliveryChanged

9

The communication method for the Approval Request Party has changed. Please note the new LinkDeliveryType

ApprovalRequestPartyRole

Possible enumeration values:

NameValueDescription
ApprovalOnly

1

A claim party that must approve the claim payment but will not receive a payment. The ApprovalOnly role must approve or reject the claim information.

PaymentOnly

2

A claim party that will receive a payment but will not need to approve the claim payment. The PaymentOnly role must specify a payment method which will be used to receive the claim payment funds.

ApprovalAndPayment

3

A claim party that must approve the claim payment and will receive a payment. The ApprovalAndPayment role must approve or reject the claim information and specify a payment method.

PaymentOnlyActionBypass

4

A claim party that will receive a payment and does not need to approve the claim payment. The claim party will not be required to complete any action but the payment information must be included in the request.

MailToCheckParty

5

Applicable to the ProcessType of IssueCheckPayment when there are one or more parties. The role specifies the claim party that will be that will receive the check in the mail. The MailToCheckParty will not be required to complete any actions, but they may be named on the check. They will receive a confirmation message when the check payment has been created.

NamedCheckParty

6

Applicable to ProcessType of IssueCheckPayment when there is more than one party on the check. The role specifies a claim party that will be named on a check but is not the party to whom the check will be mailed. They will not need to complete any actions, nor will they receive a confirmation message.

InvitationMessageDeliveryType

Possible enumeration values:

NameValueDescription
Email

1

The Approval Process link will be sent via email.

Text

2

The Approval Process link will be sent via text message.

ApprovalRequestPartyStatus

Possible enumeration values:

NameValueDescription
Initiated

1

Approval process is underway and the waiting for the party to complete their action.

FailedWelcomeCommunication

2

An error was received when attempting to send the approval process initiation communication.

WebsiteAccessBlocked

3

The party has been blocked from accessing the website due to too many unsuccessful attempts. To unblock the user, resend the approval request for this party.

Rejected

4

The claim party disputed the claim payment. Applicable to parties with an approval role.

WaitingForOtherParties

5

The claim party completed the actions required for their role.

Completed

6

The approval process has been completed and if the process includes payment processing and the role included a payment, the payment was processed.

PaymentIncomplete

7

The user failed to complete their payment method selection and has not received payment.

PaymentScheduled

8

Payment creation has been scheduled. Payment will be created within several minutes.

PaymentSummary

NameDescriptionTypeRequired*Additional information
PaymentMethodType

Selected payment method type.

PaymentMethodType No
BankAccountSummary

Bank account summary information that was saved with the Approval request.

BankAccountSummary No
CardInfo

Card summary information that was saved with the Approval request.

CardInfo No
CheckSummary

Check summary information that was saved with the Approval request.

CheckSummary No
Address

Selected mailing address for check.

MailingAddress No
TransactionSummary

Payment information. Only applicable if the payment has been processed.

TransactionSummary No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

PaymentMethodType

Possible enumeration values:

NameValueDescription
BankAccount

1

Bank account payment method.

Check

2

Mail check payment method. May be fulfilled by carrier based upon check fulfillment owner.

VirtualCard

3

Virtual card payment method.

PushToCard

4

Push to card payment method.

BankAccountSummary

NameDescriptionTypeRequired*Additional information
Token

Saved bank account token.

string No
AccountType

Account type.

EftAccountType No
LastFourDigits

Last four digits of the bank account number.

string No
BankName

Name of Bank based off of Routing Number.

string No
NameOnAccount

Name on Bank Account. For Individual it will be PayeeName, for Company will be Company Name.

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

CardInfo

NameDescriptionTypeRequired*Additional information
Token

Card payment token.

string No
LastFourDigits

Card type.

string No
CardType

Last four digits of the card number.

CreditCardType No
ExpirationYear

Year of the expiration of the card.

string No
ExpirationMonth

Month of the expiration of the card.

string No
Holder

Card holder.

Customer No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Customer

NameDescriptionTypeRequired*Additional information
Name

Customer name.

string No
Zip

Customer ZIP code.

string No
Address

Customer address.

string No
Phone

Customer phone.

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

CheckSummary

NameDescriptionTypeRequired*Additional information
PayTo

Name(s) on the check.

string No
CheckMemo

Check Memo

string No
CheckStubData

Information that was printed on the check stub.

Collection of string No
DocumentUrl

URL to a pdf that was provided to be printed and mailed with the check.

string No
MailDeliveryType

Defines the mailing method that was used for the check.

MailDeliveryType No
CheckFulfillmentOwner

Identifies if the check was fulfilled by One Inc or returned to the client for fulfillment.

CheckFulfillmentOwnerType No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

MailDeliveryType

Possible enumeration values:

NameValueDescription
Standard

1

Check will be mailed via USPS First Class Mail. It will be placed in the mail either one or two days after the check is requested, depending on the time your check batch is set to close.

NextDay

2

Check will be mailed via UPS Next Day delivery. It will be shipped either one or two days after the check is requested, depending on the time your check batch is set to close.

CheckFulfillmentOwnerType

Possible enumeration values:

NameValueDescription
OneInc

1

OneInc

Client

2

Client

MailingAddress

NameDescriptionTypeRequired*Additional information
CompanyContactInformation

Additional company address field.

string No
Attention

For payment method of check, attention line.

string No
Address

The street address.

string No
Address2

Address Line 2 to which the check will be mailed.

string No
City

The city.

string No
State

The state.

string No
Zip

The zip code.

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

TransactionSummary

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction identifier for the payment. Only applicable if ProcessPayments = True.

string No
TransactionDate

The date when transaction was executed.

date No
PaymentProcessingStatus

The status of the claim party payment. Only applicable if ProcessPayments = True and ApprovalRequestPartyRole is not ApprovalOnly.

PaymentProcessingStatus No
PaymentResponseMessage

Payment response message.

string No
BatchNumber

Number of the batch or if IssueCheck payment, the checkbatch.

integer No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

PaymentProcessingStatus

Possible enumeration values:

NameValueDescription
Successful

1

The payment processing results were successful. For bank account and IssueCheck payments, the payment was submitted successfully.

Failed

2

The payment processing failed. No further action will be taken on this payment through the ApprovalRequestId.

Skipped

3

Applies to PaymentMethodType of Check when check is not processed by One Inc.

Request Formats

 
                                
                                 {
  "OperationId": "58CF5D97-0725-4ABA-9705-E4F29D9B756C",
  "EventType": 2,
  "EventDate": "2020-10-27T07:19:43",
  "TimeZone": "US/Pacific",
  "ApprovalRequestPartyId": 123456,
  "AccountId": 135,
  "ContactId": 246,
  "ProcessType": "SinglePartyPayment",
  "ApprovalRole": 3,
  "LinkDeliveryType": 1,
  "EmailAddress": "[email protected]",
  "PhoneNumber": "916-123-4567",
  "FullName": "John Smith",
  "CompanyName": "Some Company",
  "Status": 6,
  "PaymentSummary": {
    "PaymentMethodType": 1,
    "BankAccountSummary": {
      "Token": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
      "AccountType": 1,
      "LastFourDigits": "1234",
      "BankName": "Some Bank",
      "NameOnAccount": "John Smith"
    },
    "Address": {
      "Address": "Street",
      "City": "City",
      "State": "ST",
      "Zip": "95123"
    },
    "TransactionSummary": {
      "TransactionId": "123456",
      "TransactionDate": "2020-10-27T07:19:43",
      "PaymentProcessingStatus": 1,
      "PaymentResponseMessage": "Success",
      "BatchNumber": 123456
    }
  }
}
                                
                                 <ApprovalRequestPartyUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.ClamsSystem">
  <AccountId>135</AccountId>
  <ApprovalRequestPartyId>123456</ApprovalRequestPartyId>
  <ApprovalRole>ApprovalAndPayment</ApprovalRole>
  <CompanyName>Some Company</CompanyName>
  <ContactId>246</ContactId>
  <DisputeComment i:nil="true" />
  <EmailAddress>[email protected]</EmailAddress>
  <EventDate>2020-10-27T07:19:43</EventDate>
  <EventType>ActionCompleted</EventType>
  <FullName>John Smith</FullName>
  <LinkDeliveryType>Email</LinkDeliveryType>
  <OperationId>58CF5D97-0725-4ABA-9705-E4F29D9B756C</OperationId>
  <PaymentSummary>
    <Address>
      <Address>Street</Address>
      <Address2 i:nil="true" />
      <Attention i:nil="true" />
      <City>City</City>
      <CompanyContactInformation i:nil="true" />
      <State>ST</State>
      <Zip>95123</Zip>
    </Address>
    <BankAccountSummary>
      <AccountType>Checking</AccountType>
      <BankName>Some Bank</BankName>
      <LastFourDigits>1234</LastFourDigits>
      <NameOnAccount>John Smith</NameOnAccount>
      <Token>1E8E5E3B-B438-4405-82AE-F5C64E1FF060</Token>
    </BankAccountSummary>
    <CardInfo i:nil="true" />
    <CheckSummary i:nil="true" />
    <PaymentMethodType>BankAccount</PaymentMethodType>
    <TransactionSummary>
      <BatchNumber>123456</BatchNumber>
      <PaymentProcessingStatus>Successful</PaymentProcessingStatus>
      <PaymentResponseMessage>Success</PaymentResponseMessage>
      <TransactionDate>2020-10-27T07:19:43</TransactionDate>
      <TransactionId>123456</TransactionId>
    </TransactionSummary>
  </PaymentSummary>
  <PhoneNumber>916-123-4567</PhoneNumber>
  <ProcessType>SinglePartyPayment</ProcessType>
  <Status>Completed</Status>
  <TimeZone>US/Pacific</TimeZone>
</ApprovalRequestPartyUpdateRequest>

Response Information

ApprovalRequestPartyUpdateResponse

NameDescriptionTypeRequired*Additional information
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<ApprovalRequestPartyUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.ClamsSystem">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage></ResponseMessage>
</ApprovalRequestPartyUpdateResponse>

POST notifyapprovalrequestupdate

The Notify Approval Request Update is sent when an event occurs that changes the status of the Approval Request.

MethodEndpoint
NotifyApprovalRequestUpdated https://stgportalone.processonepayments.com/ExternalApi/notifyapprovalrequestupdate

ClaimsPayApprovalRequestUpdateRequest

NameDescriptionTypeRequired*Additional information
OperationId

string No
EventType

ClaimsPayApprovalRequestUpdateEventType No
EventDate

date No
TimeZone

string No
ClaimNumber

string No
ApprovalRequestId

integer No
ProcessType

string No
IsAuthorityHold

boolean No
Status

ClaimsPayApprovalRequestStatus No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ClaimsPayApprovalRequestUpdateEventType

Possible enumeration values:

NameValueDescription
Undefined

0

Completed

1

Rejected

2

Expired

3

Cancelled

4

MarkedIncomplete

5

AuthorityRelease

6

ClaimsPayApprovalRequestStatus

Possible enumeration values:

NameValueDescription
Undefined

0

Initiated

1

Completed

2

Rejected

3

Cancelled

4

Expired

5

Incomplete

6

AuthorityHold

7

Request Formats

 
                                
                                 {
  "OperationId": "sample string 1",
  "EventType": 0,
  "EventDate": "2020-10-27T07:19:44",
  "TimeZone": "sample string 3",
  "ClaimNumber": "sample string 4",
  "ApprovalRequestId": 5,
  "ProcessType": "sample string 6",
  "IsAuthorityHold": true,
  "Status": 0
}
                                
                                 <ClaimsPayApprovalRequestUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Common.Core.DataContracts.ClientOperations">
  <ApprovalRequestId>5</ApprovalRequestId>
  <ClaimNumber>sample string 4</ClaimNumber>
  <EventDate>2020-10-27T07:19:44</EventDate>
  <EventType>Undefined</EventType>
  <IsAuthorityHold>true</IsAuthorityHold>
  <OperationId>sample string 1</OperationId>
  <ProcessType>sample string 6</ProcessType>
  <Status>Undefined</Status>
  <TimeZone>sample string 3</TimeZone>
</ClaimsPayApprovalRequestUpdateRequest>

Response Information

ClaimsPayApprovalRequestUpdateResponse

NameDescriptionTypeRequired*Additional information
ResponseMessage

string No
ResponseCode

string No
IsSuccessful

boolean No
ResultCode

ResultCode No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ResultCode

Possible enumeration values:

NameValueDescription
Success

0

InternalError

1

PolicyNotFound

2

InvalidRoutingNumber

3

InvalidEftAmount

4

InvalidCardNumber

5

InvalidAccountNumber

6

AvsVerificationFailed

7

EftCustomerNameMissing

8

IncorrectValidationValue

9

CardExpired

10

CardTypeNotExcepted

11

Declined

12

CannotUpdateRecurringPaymentStatus

13

SubmitPaymentFailed

14

PaymentsNotAllowed

15

SaveCreditCardFailed

16

ErrorOnThirdPartySide

17

ExternalServiceUnavailable

18

DuplicateTransaction

19

OverMaximumPayment

20

Call

21

InvalidCreditCardAmount

22

InvalidExpirationDate

23

InvalidReason

24

InvalidZipcode

25

CreditCardCustomerNameMissing

26

NoProcessorResponse

27

CardTypeNotAccepted

28

InvalidEpay

29

InvalidRequest

30

Unauthorized

31

Response Formats

{
  "ResponseMessage": "sample string 1",
  "ResponseCode": "sample string 2",
  "IsSuccessful": true,
  "ResultCode": 0
}
<ClaimsPayApprovalRequestUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Common.Core.DataContracts.ClientOperations">
  <_x003C_IsSuccessful_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Common.Core.DataContracts">true</_x003C_IsSuccessful_x003E_k__BackingField>
  <_x003C_ResponseCode_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Common.Core.DataContracts">sample string 2</_x003C_ResponseCode_x003E_k__BackingField>
  <_x003C_ResponseMessage_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Common.Core.DataContracts">sample string 1</_x003C_ResponseMessage_x003E_k__BackingField>
  <_x003C_ResultCode_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Common.Core.DataContracts">Success</_x003C_ResultCode_x003E_k__BackingField>
</ClaimsPayApprovalRequestUpdateResponse>

POST notifyapprovalrequestpartyupdate

The Notify Approval Request Party Update is sent when an event occurs that changes the status of the Approval Request Party.

MethodEndpoint
NotifyApprovalRequestPartyUpdated https://stgportalone.processonepayments.com/ExternalApi/notifyapprovalrequestpartyupdate

ClaimsPayApprovalRequestPartyUpdateRequest

NameDescriptionTypeRequired*Additional information
OperationId

string No
EventType

ClaimsPayApprovalRequestPartyUpdateEventType No
EventDate

date No
TimeZone

string No
ApprovalRequestPartyId

integer No
AccountId

integer No
ContactId

integer No
ProcessType

string No
EmailAddress

string No
PhoneNumber

string No
FullName

string No
CompanyName

string No
LinkDeliveryType

ClaimsPayMessageDeliveryType No
ApprovalRole

ClaimsPayApprovalRequestPartyRole No
DisputeComment

string No
Status

ClaimsPayApprovalRequestPartyStatus No
PaymentSummary

ClaimsPayPaymentSummary No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ClaimsPayApprovalRequestPartyUpdateEventType

Possible enumeration values:

NameValueDescription
Undefined

0

CommunicationSendError

1

ActionCompleted

2

Rejected

3

PaymentFailed

4

PaymentSuccessful

5

WebsiteAccessBlocked

6

PrepareCheck

7

PaymentIncomplete

8

MessageDeliveryChanged

9

ClaimsPayMessageDeliveryType

Possible enumeration values:

NameValueDescription
Undefined

0

Email

1

Text

2

ClaimsPayApprovalRequestPartyRole

Possible enumeration values:

NameValueDescription
Undefined

0

ApprovalOnly

1

PaymentOnly

2

ApprovalAndPayment

3

PaymentOnlyActionBypass

4

MailToCheckParty

5

NamedCheckParty

6

ClaimsPayApprovalRequestPartyStatus

Possible enumeration values:

NameValueDescription
Undefined

0

Initiated

1

FailedWelcomeCommunication

2

WebsiteAccessBlocked

3

Rejected

4

WaitingForOtherParties

5

Completed

6

PaymentIncomplete

7

PaymentScheduled

8

AuthorityHold

9

ClaimsPayPaymentSummary

NameDescriptionTypeRequired*Additional information
PaymentMethodType

ClaimsPayPaymentMethodType No
BankAccountSummary

BankAccountSummary No
CardInfo

CardInfo No
CheckSummary

CheckSummary No
Address

MailingAddress No
TransactionSummary

ClaimsPayTransactionSummary No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ClaimsPayPaymentMethodType

Possible enumeration values:

NameValueDescription
Undefined

0

BankAccount

1

Check

2

VirtualCard

3

PushToCard

4

ClaimsPayTransactionSummary

NameDescriptionTypeRequired*Additional information
TransactionId

string No
TransactionDate

date No
PaymentProcessingStatus

PaymentProcessingStatus No
PaymentResponseMessage

string No
BatchNumber

integer No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "OperationId": "sample string 1",
  "EventType": 0,
  "EventDate": "2020-10-27T07:19:44",
  "TimeZone": "sample string 3",
  "ApprovalRequestPartyId": 4,
  "AccountId": 5,
  "ContactId": 1,
  "ProcessType": "sample string 6",
  "EmailAddress": "sample string 7",
  "PhoneNumber": "sample string 8",
  "FullName": "sample string 9",
  "CompanyName": "sample string 10",
  "LinkDeliveryType": 0,
  "ApprovalRole": 0,
  "DisputeComment": "sample string 11",
  "Status": 0,
  "PaymentSummary": {
    "PaymentMethodType": 0,
    "BankAccountSummary": {
      "Token": "sample string 1",
      "AccountType": 0,
      "LastFourDigits": "sample string 2",
      "BankName": "sample string 3",
      "NameOnAccount": "sample string 4"
    },
    "CardInfo": {
      "Token": "sample string 1",
      "LastFourDigits": "sample string 2",
      "CardType": 0,
      "HolderName": "sample string 3"
    },
    "CheckSummary": {
      "PayTo": "sample string 1",
      "CheckMemo": "sample string 2",
      "CheckStubData": [
        "sample string 1",
        "sample string 2"
      ],
      "DocumentUrl": "sample string 3",
      "MailDeliveryType": 1,
      "CheckFulfillmentOwner": 1
    },
    "Address": {
      "CompanyContactInformation": "sample string 1",
      "Attention": "sample string 2",
      "Address": "sample string 3",
      "Address2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "Zip": "sample string 7"
    },
    "TransactionSummary": {
      "TransactionId": "sample string 1",
      "TransactionDate": "2020-10-27T07:19:44",
      "PaymentProcessingStatus": 0,
      "PaymentResponseMessage": "sample string 2",
      "BatchNumber": 3
    }
  }
}
                                
                                 <ClaimsPayApprovalRequestPartyUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Common.Core.DataContracts.ClientOperations">
  <AccountId>5</AccountId>
  <ApprovalRequestPartyId>4</ApprovalRequestPartyId>
  <ApprovalRole>Undefined</ApprovalRole>
  <CompanyName>sample string 10</CompanyName>
  <ContactId>1</ContactId>
  <DisputeComment>sample string 11</DisputeComment>
  <EmailAddress>sample string 7</EmailAddress>
  <EventDate>2020-10-27T07:19:44.6358906-07:00</EventDate>
  <EventType>Undefined</EventType>
  <FullName>sample string 9</FullName>
  <LinkDeliveryType>Undefined</LinkDeliveryType>
  <OperationId>sample string 1</OperationId>
  <PaymentSummary>
    <Address>
      <Address>sample string 3</Address>
      <Address2>sample string 4</Address2>
      <Attention>sample string 2</Attention>
      <City>sample string 5</City>
      <CompanyContactInformation>sample string 1</CompanyContactInformation>
      <State>sample string 6</State>
      <Zip>sample string 7</Zip>
    </Address>
    <BankAccountSummary xmlns:d3p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Common.Core.DataContracts.SIMSClaims">
      <d3p1:AccountType>Undefined</d3p1:AccountType>
      <d3p1:BankName>sample string 3</d3p1:BankName>
      <d3p1:LastFourDigits>sample string 2</d3p1:LastFourDigits>
      <d3p1:NameOnAccount>sample string 4</d3p1:NameOnAccount>
      <d3p1:Token>sample string 1</d3p1:Token>
    </BankAccountSummary>
    <CardInfo>
      <CardType>Undefined</CardType>
      <HolderName>sample string 3</HolderName>
      <LastFourDigits>sample string 2</LastFourDigits>
      <Token>sample string 1</Token>
    </CardInfo>
    <CheckSummary>
      <CheckFulfillmentOwner>OneInc</CheckFulfillmentOwner>
      <CheckMemo>sample string 2</CheckMemo>
      <CheckStubData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </CheckStubData>
      <DocumentUrl>sample string 3</DocumentUrl>
      <MailDeliveryType>Standard</MailDeliveryType>
      <PayTo>sample string 1</PayTo>
    </CheckSummary>
    <PaymentMethodType>Undefined</PaymentMethodType>
    <TransactionSummary xmlns:d3p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Common.Core.DataContracts">
      <d3p1:BatchNumber>3</d3p1:BatchNumber>
      <d3p1:PaymentProcessingStatus>Undefined</d3p1:PaymentProcessingStatus>
      <d3p1:PaymentResponseMessage>sample string 2</d3p1:PaymentResponseMessage>
      <d3p1:TransactionDate>2020-10-27T07:19:44.6358906-07:00</d3p1:TransactionDate>
      <d3p1:TransactionId>sample string 1</d3p1:TransactionId>
    </TransactionSummary>
  </PaymentSummary>
  <PhoneNumber>sample string 8</PhoneNumber>
  <ProcessType>sample string 6</ProcessType>
  <Status>Undefined</Status>
  <TimeZone>sample string 3</TimeZone>
</ClaimsPayApprovalRequestPartyUpdateRequest>

Response Information

ClaimsPayApprovalRequestPartyUpdateResponse

NameDescriptionTypeRequired*Additional information
ResponseMessage

string No
ResponseCode

string No
IsSuccessful

boolean No
ResultCode

ResultCode No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "ResponseMessage": "sample string 1",
  "ResponseCode": "sample string 2",
  "IsSuccessful": true,
  "ResultCode": 0
}
<ClaimsPayApprovalRequestPartyUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Common.Core.DataContracts.ClientOperations">
  <_x003C_IsSuccessful_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Common.Core.DataContracts">true</_x003C_IsSuccessful_x003E_k__BackingField>
  <_x003C_ResponseCode_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Common.Core.DataContracts">sample string 2</_x003C_ResponseCode_x003E_k__BackingField>
  <_x003C_ResponseMessage_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Common.Core.DataContracts">sample string 1</_x003C_ResponseMessage_x003E_k__BackingField>
  <_x003C_ResultCode_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Common.Core.DataContracts">Success</_x003C_ResultCode_x003E_k__BackingField>
</ClaimsPayApprovalRequestPartyUpdateResponse>

Epay

EpayPostback

This section describes the APIs that need to be made to implement ePay notifications. The notification API is owned by the PortalOne customer and called by ePay System. The APIs will be used to pass back notifications to your system on user activities.

POST epayPostbackLinkForCharge

This method is used to notify the source system on EPay Charged event. This method is called when EpayType is Charge or ChargeViaTerminal and EpayCommunicationType is Link.

MethodEndpoint
LinkForCharge https://stgportalone.processonepayments.com/ExternalApi/epayPostbackLinkForCharge

EpayChargedRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

The key that is used to link the request and postback, originated by Client.

string No
PaymentAmount

Payment Amount passed by Client.

decimal number No
TransactionId

Original Transaction ID from the previous transaction where the charge occurred.

integer No
TransactionDate

Date Stamp of the payment.

date No
BatchNumber

This is the batch number that the transaction will be attached to.

integer No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No
SavedCardTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
SavedEftTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
IsPaymentMethodRecurring

Is payment method recurring.

boolean No
ClientReferenceData

Client Reference Data.

ClientReferenceData No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "PaymentAmount": 100.0,
  "TransactionId": 123456,
  "TransactionDate": "2020-10-27T07:19:45",
  "BatchNumber": 5444,
  "AccountGroupCode": "Default",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company"
  }
}
                                
                                 <EpayChargedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.EpayPostback">
  <AccountGroupCode>Default</AccountGroupCode>
  <BatchNumber>5444</BatchNumber>
  <ClientReferenceData>
    <ClientReferenceData1>AB-98765432</ClientReferenceData1>
    <ClientReferenceData2>123456</ClientReferenceData2>
    <ClientReferenceData3>Some Company</ClientReferenceData3>
    <ClientReferenceData4 i:nil="true" />
  </ClientReferenceData>
  <CommunicationKey>EA3EAA87-6466-4C04-B915-CFF836D9EB4D</CommunicationKey>
  <IsPaymentMethodRecurring>true</IsPaymentMethodRecurring>
  <PaymentAmount>100</PaymentAmount>
  <SavedCardTokenId>1E8E5E3B-B438-4405-82AE-F5C64E1FF060</SavedCardTokenId>
  <SavedEftTokenId i:nil="true" />
  <TransactionDate>2020-10-27T07:19:45</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayChargedRequest>

Response Information

Response Formats

POST ePayPostbackLinkForChargeBySavedPaymentMethod

This method is used to notify the source system on EPay Charged event. This method is called when EpayType is not Charge and not ChargeViaTerminal and EpayCommunicationType is Link.

MethodEndpoint
LinkForChargeBySavedPaymentMethod https://stgportalone.processonepayments.com/ExternalApi/ePayPostbackLinkForChargeBySavedPaymentMethod

EpayChargedRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

The key that is used to link the request and postback, originated by Client.

string No
PaymentAmount

Payment Amount passed by Client.

decimal number No
TransactionId

Original Transaction ID from the previous transaction where the charge occurred.

integer No
TransactionDate

Date Stamp of the payment.

date No
BatchNumber

This is the batch number that the transaction will be attached to.

integer No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No
SavedCardTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
SavedEftTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
IsPaymentMethodRecurring

Is payment method recurring.

boolean No
ClientReferenceData

Client Reference Data.

ClientReferenceData No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "PaymentAmount": 100.0,
  "TransactionId": 123456,
  "TransactionDate": "2020-10-27T07:19:45",
  "BatchNumber": 5444,
  "AccountGroupCode": "Default",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company"
  }
}
                                
                                 <EpayChargedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.EpayPostback">
  <AccountGroupCode>Default</AccountGroupCode>
  <BatchNumber>5444</BatchNumber>
  <ClientReferenceData>
    <ClientReferenceData1>AB-98765432</ClientReferenceData1>
    <ClientReferenceData2>123456</ClientReferenceData2>
    <ClientReferenceData3>Some Company</ClientReferenceData3>
    <ClientReferenceData4 i:nil="true" />
  </ClientReferenceData>
  <CommunicationKey>EA3EAA87-6466-4C04-B915-CFF836D9EB4D</CommunicationKey>
  <IsPaymentMethodRecurring>true</IsPaymentMethodRecurring>
  <PaymentAmount>100</PaymentAmount>
  <SavedCardTokenId>1E8E5E3B-B438-4405-82AE-F5C64E1FF060</SavedCardTokenId>
  <SavedEftTokenId i:nil="true" />
  <TransactionDate>2020-10-27T07:19:45</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayChargedRequest>

Response Information

Response Formats

POST ePayPostbackEmailForCharge

This method is used to notify the source system on EPay Charged event. This method is called when EpayType is Charge or ChargeViaTerminal and EpayCommunicationType is Email.

MethodEndpoint
EmailForCharge https://stgportalone.processonepayments.com/ExternalApi/ePayPostbackEmailForCharge

EpayChargedRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

The key that is used to link the request and postback, originated by Client.

string No
PaymentAmount

Payment Amount passed by Client.

decimal number No
TransactionId

Original Transaction ID from the previous transaction where the charge occurred.

integer No
TransactionDate

Date Stamp of the payment.

date No
BatchNumber

This is the batch number that the transaction will be attached to.

integer No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No
SavedCardTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
SavedEftTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
IsPaymentMethodRecurring

Is payment method recurring.

boolean No
ClientReferenceData

Client Reference Data.

ClientReferenceData No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "PaymentAmount": 100.0,
  "TransactionId": 123456,
  "TransactionDate": "2020-10-27T07:19:46",
  "BatchNumber": 5444,
  "AccountGroupCode": "Default",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company"
  }
}
                                
                                 <EpayChargedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.EpayPostback">
  <AccountGroupCode>Default</AccountGroupCode>
  <BatchNumber>5444</BatchNumber>
  <ClientReferenceData>
    <ClientReferenceData1>AB-98765432</ClientReferenceData1>
    <ClientReferenceData2>123456</ClientReferenceData2>
    <ClientReferenceData3>Some Company</ClientReferenceData3>
    <ClientReferenceData4 i:nil="true" />
  </ClientReferenceData>
  <CommunicationKey>EA3EAA87-6466-4C04-B915-CFF836D9EB4D</CommunicationKey>
  <IsPaymentMethodRecurring>true</IsPaymentMethodRecurring>
  <PaymentAmount>100</PaymentAmount>
  <SavedCardTokenId>1E8E5E3B-B438-4405-82AE-F5C64E1FF060</SavedCardTokenId>
  <SavedEftTokenId i:nil="true" />
  <TransactionDate>2020-10-27T07:19:46</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayChargedRequest>

Response Information

Response Formats

POST ePayPostbackEmailForChargeBySavedPaymentMethod

This method is used to notify the source system on EPay Charged event. This method is called when EpayType is not Charge and not ChargeViaTerminal and EpayCommunicationType is Email.

MethodEndpoint
EmailForChargeBySavedPaymentMethod https://stgportalone.processonepayments.com/ExternalApi/ePayPostbackEmailForChargeBySavedPaymentMethod

EpayChargedRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

The key that is used to link the request and postback, originated by Client.

string No
PaymentAmount

Payment Amount passed by Client.

decimal number No
TransactionId

Original Transaction ID from the previous transaction where the charge occurred.

integer No
TransactionDate

Date Stamp of the payment.

date No
BatchNumber

This is the batch number that the transaction will be attached to.

integer No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No
SavedCardTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
SavedEftTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
IsPaymentMethodRecurring

Is payment method recurring.

boolean No
ClientReferenceData

Client Reference Data.

ClientReferenceData No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "PaymentAmount": 100.0,
  "TransactionId": 123456,
  "TransactionDate": "2020-10-27T07:19:46",
  "BatchNumber": 5444,
  "AccountGroupCode": "Default",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company"
  }
}
                                
                                 <EpayChargedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.EpayPostback">
  <AccountGroupCode>Default</AccountGroupCode>
  <BatchNumber>5444</BatchNumber>
  <ClientReferenceData>
    <ClientReferenceData1>AB-98765432</ClientReferenceData1>
    <ClientReferenceData2>123456</ClientReferenceData2>
    <ClientReferenceData3>Some Company</ClientReferenceData3>
    <ClientReferenceData4 i:nil="true" />
  </ClientReferenceData>
  <CommunicationKey>EA3EAA87-6466-4C04-B915-CFF836D9EB4D</CommunicationKey>
  <IsPaymentMethodRecurring>true</IsPaymentMethodRecurring>
  <PaymentAmount>100</PaymentAmount>
  <SavedCardTokenId>1E8E5E3B-B438-4405-82AE-F5C64E1FF060</SavedCardTokenId>
  <SavedEftTokenId i:nil="true" />
  <TransactionDate>2020-10-27T07:19:46</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayChargedRequest>

Response Information

Response Formats

POST ePayPostbackTextMessageForCharge

This method is used to notify the source system on EPay Charged event. This method is called when EpayType is Charge or ChargeViaTerminal and EpayCommunicationType is TextMessage.

MethodEndpoint
TextMessageForCharge https://stgportalone.processonepayments.com/ExternalApi/ePayPostbackTextMessageForCharge

EpayChargedRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

The key that is used to link the request and postback, originated by Client.

string No
PaymentAmount

Payment Amount passed by Client.

decimal number No
TransactionId

Original Transaction ID from the previous transaction where the charge occurred.

integer No
TransactionDate

Date Stamp of the payment.

date No
BatchNumber

This is the batch number that the transaction will be attached to.

integer No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No
SavedCardTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
SavedEftTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
IsPaymentMethodRecurring

Is payment method recurring.

boolean No
ClientReferenceData

Client Reference Data.

ClientReferenceData No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "PaymentAmount": 100.0,
  "TransactionId": 123456,
  "TransactionDate": "2020-10-27T07:19:47",
  "BatchNumber": 5444,
  "AccountGroupCode": "Default",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company"
  }
}
                                
                                 <EpayChargedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.EpayPostback">
  <AccountGroupCode>Default</AccountGroupCode>
  <BatchNumber>5444</BatchNumber>
  <ClientReferenceData>
    <ClientReferenceData1>AB-98765432</ClientReferenceData1>
    <ClientReferenceData2>123456</ClientReferenceData2>
    <ClientReferenceData3>Some Company</ClientReferenceData3>
    <ClientReferenceData4 i:nil="true" />
  </ClientReferenceData>
  <CommunicationKey>EA3EAA87-6466-4C04-B915-CFF836D9EB4D</CommunicationKey>
  <IsPaymentMethodRecurring>true</IsPaymentMethodRecurring>
  <PaymentAmount>100</PaymentAmount>
  <SavedCardTokenId>1E8E5E3B-B438-4405-82AE-F5C64E1FF060</SavedCardTokenId>
  <SavedEftTokenId i:nil="true" />
  <TransactionDate>2020-10-27T07:19:47</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayChargedRequest>

Response Information

Response Formats

POST ePayPostbackTextMessageForChargeBySavedPaymentMethod

This method is used to notify the source system on EPay Charged event. This method is called when EpayType is not Charge and not ChargeViaTerminal and EpayCommunicationType is TextMessage.

MethodEndpoint
TextMessageForChargeBySavedPaymentMethod https://stgportalone.processonepayments.com/ExternalApi/ePayPostbackTextMessageForChargeBySavedPaymentMethod

EpayChargedRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

The key that is used to link the request and postback, originated by Client.

string No
PaymentAmount

Payment Amount passed by Client.

decimal number No
TransactionId

Original Transaction ID from the previous transaction where the charge occurred.

integer No
TransactionDate

Date Stamp of the payment.

date No
BatchNumber

This is the batch number that the transaction will be attached to.

integer No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No
SavedCardTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
SavedEftTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
IsPaymentMethodRecurring

Is payment method recurring.

boolean No
ClientReferenceData

Client Reference Data.

ClientReferenceData No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "PaymentAmount": 100.0,
  "TransactionId": 123456,
  "TransactionDate": "2020-10-27T07:19:47",
  "BatchNumber": 5444,
  "AccountGroupCode": "Default",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company"
  }
}
                                
                                 <EpayChargedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.EpayPostback">
  <AccountGroupCode>Default</AccountGroupCode>
  <BatchNumber>5444</BatchNumber>
  <ClientReferenceData>
    <ClientReferenceData1>AB-98765432</ClientReferenceData1>
    <ClientReferenceData2>123456</ClientReferenceData2>
    <ClientReferenceData3>Some Company</ClientReferenceData3>
    <ClientReferenceData4 i:nil="true" />
  </ClientReferenceData>
  <CommunicationKey>EA3EAA87-6466-4C04-B915-CFF836D9EB4D</CommunicationKey>
  <IsPaymentMethodRecurring>true</IsPaymentMethodRecurring>
  <PaymentAmount>100</PaymentAmount>
  <SavedCardTokenId>1E8E5E3B-B438-4405-82AE-F5C64E1FF060</SavedCardTokenId>
  <SavedEftTokenId i:nil="true" />
  <TransactionDate>2020-10-27T07:19:47</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayChargedRequest>

Response Information

Response Formats

POST ePayPostbackCreateLinkForCharge

This method is used to notify the source system on EPay Link Created event. This method is called when EpayType is Charge or ChargeViaTerminal.

MethodEndpoint
CreateLinkForCharge https://stgportalone.processonepayments.com/ExternalApi/ePayPostbackCreateLinkForCharge

EpayLinkCreatedRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

The key that is used to link the request and postback, originated by Client.

string No
PortalUrl

Portal url.

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "PortalUrl": "http://www.somehost.com"
}
                                
                                 <EpayLinkCreatedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.EpayPostback">
  <CommunicationKey>EA3EAA87-6466-4C04-B915-CFF836D9EB4D</CommunicationKey>
  <PortalUrl>http://www.somehost.com</PortalUrl>
</EpayLinkCreatedRequest>

Response Information

Response Formats

POST ePayPostbackCreateLinkForSavePaymentMethod

This method is used to notify the source system on EPay Link Created event. This method is called when EpayType is ChargeBySavedPaymentMethod.

MethodEndpoint
CreateLinkForSavePaymentMethod https://stgportalone.processonepayments.com/ExternalApi/ePayPostbackCreateLinkForSavePaymentMethod

EpayLinkCreatedRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

The key that is used to link the request and postback, originated by Client.

string No
PortalUrl

Portal url.

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "PortalUrl": "http://www.somehost.com"
}
                                
                                 <EpayLinkCreatedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.EpayPostback">
  <CommunicationKey>EA3EAA87-6466-4C04-B915-CFF836D9EB4D</CommunicationKey>
  <PortalUrl>http://www.somehost.com</PortalUrl>
</EpayLinkCreatedRequest>

Response Information

Response Formats

POST ePayPostbackCreateLinkForChargeBySavedPaymentMethod

This method is used to notify the source system on EPay Link Created event. This method is called when EpayType is CreateLinkForSavePaymentMethod.

MethodEndpoint
CreateLinkForChargeBySavedPaymentMethod https://stgportalone.processonepayments.com/ExternalApi/ePayPostbackCreateLinkForChargeBySavedPaymentMethod

EpayLinkCreatedRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

The key that is used to link the request and postback, originated by Client.

string No
PortalUrl

Portal url.

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "PortalUrl": "http://www.somehost.com"
}
                                
                                 <EpayLinkCreatedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.EpayPostback">
  <CommunicationKey>EA3EAA87-6466-4C04-B915-CFF836D9EB4D</CommunicationKey>
  <PortalUrl>http://www.somehost.com</PortalUrl>
</EpayLinkCreatedRequest>

Response Information

Response Formats

POST epayPostbackLinkForSavePaymentMethod

This method is used to notify the source system on Epay Payment Method Saved event. This method is called when EpayCommunicationType is Link.

MethodEndpoint
LinkForSavePaymentMethod https://stgportalone.processonepayments.com/ExternalApi/epayPostbackLinkForSavePaymentMethod

EpayPaymentMethodSavedRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

The key that is used to link the request and postback, originated by Client.

string No
TransactionId

Original Transaction ID from the previous transaction where the charge occurred.

integer No
TransactionDate

Date Stamp of the payment.

date No
SavedCardTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
SavedEftTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
IsPaymentMethodRecurring

Is payment method recurring.

boolean No
ClientReferenceData

Client Reference Data.

ClientReferenceData No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "TransactionId": 123456,
  "TransactionDate": "2020-10-27T07:19:49",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company"
  }
}
                                
                                 <EpayPaymentMethodSavedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.EpayPostback">
  <ClientReferenceData>
    <ClientReferenceData1>AB-98765432</ClientReferenceData1>
    <ClientReferenceData2>123456</ClientReferenceData2>
    <ClientReferenceData3>Some Company</ClientReferenceData3>
    <ClientReferenceData4 i:nil="true" />
  </ClientReferenceData>
  <CommunicationKey>EA3EAA87-6466-4C04-B915-CFF836D9EB4D</CommunicationKey>
  <IsPaymentMethodRecurring>true</IsPaymentMethodRecurring>
  <SavedCardTokenId>1E8E5E3B-B438-4405-82AE-F5C64E1FF060</SavedCardTokenId>
  <SavedEftTokenId i:nil="true" />
  <TransactionDate>2020-10-27T07:19:49</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayPaymentMethodSavedRequest>

Response Information

Response Formats

POST epayPostbackEmailForSavePaymentMethod

This method is used to notify the source system on Epay Payment Method Saved event. This method is called when EpayCommunicationType is Email.

MethodEndpoint
EmailForSavePaymentMethod https://stgportalone.processonepayments.com/ExternalApi/epayPostbackEmailForSavePaymentMethod

EpayPaymentMethodSavedRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

The key that is used to link the request and postback, originated by Client.

string No
TransactionId

Original Transaction ID from the previous transaction where the charge occurred.

integer No
TransactionDate

Date Stamp of the payment.

date No
SavedCardTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
SavedEftTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
IsPaymentMethodRecurring

Is payment method recurring.

boolean No
ClientReferenceData

Client Reference Data.

ClientReferenceData No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "TransactionId": 123456,
  "TransactionDate": "2020-10-27T07:19:49",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company"
  }
}
                                
                                 <EpayPaymentMethodSavedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.EpayPostback">
  <ClientReferenceData>
    <ClientReferenceData1>AB-98765432</ClientReferenceData1>
    <ClientReferenceData2>123456</ClientReferenceData2>
    <ClientReferenceData3>Some Company</ClientReferenceData3>
    <ClientReferenceData4 i:nil="true" />
  </ClientReferenceData>
  <CommunicationKey>EA3EAA87-6466-4C04-B915-CFF836D9EB4D</CommunicationKey>
  <IsPaymentMethodRecurring>true</IsPaymentMethodRecurring>
  <SavedCardTokenId>1E8E5E3B-B438-4405-82AE-F5C64E1FF060</SavedCardTokenId>
  <SavedEftTokenId i:nil="true" />
  <TransactionDate>2020-10-27T07:19:49</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayPaymentMethodSavedRequest>

Response Information

Response Formats

POST epayPostbackTextMessageForSavePaymentMethod

This method is used to notify the source system on Epay Payment Method Saved event. This method is called when EpayCommunicationType is TextMessage.

MethodEndpoint
TextMessageForSavePaymentMethod https://stgportalone.processonepayments.com/ExternalApi/epayPostbackTextMessageForSavePaymentMethod

EpayPaymentMethodSavedRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

The key that is used to link the request and postback, originated by Client.

string No
TransactionId

Original Transaction ID from the previous transaction where the charge occurred.

integer No
TransactionDate

Date Stamp of the payment.

date No
SavedCardTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
SavedEftTokenId

Either savedCardTokenID or savedEFTToken will be returned depending what type of payment was saved.

string No
IsPaymentMethodRecurring

Is payment method recurring.

boolean No
ClientReferenceData

Client Reference Data.

ClientReferenceData No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "TransactionId": 123456,
  "TransactionDate": "2020-10-27T07:19:50",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company"
  }
}
                                
                                 <EpayPaymentMethodSavedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.EpayPostback">
  <ClientReferenceData>
    <ClientReferenceData1>AB-98765432</ClientReferenceData1>
    <ClientReferenceData2>123456</ClientReferenceData2>
    <ClientReferenceData3>Some Company</ClientReferenceData3>
    <ClientReferenceData4 i:nil="true" />
  </ClientReferenceData>
  <CommunicationKey>EA3EAA87-6466-4C04-B915-CFF836D9EB4D</CommunicationKey>
  <IsPaymentMethodRecurring>true</IsPaymentMethodRecurring>
  <SavedCardTokenId>1E8E5E3B-B438-4405-82AE-F5C64E1FF060</SavedCardTokenId>
  <SavedEftTokenId i:nil="true" />
  <TransactionDate>2020-10-27T07:19:50</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayPaymentMethodSavedRequest>

Response Information

Response Formats

Portal Payments

User

This section describes APIs for User Operations

GET users/{accountId}

This method is used to get User Details information

MethodEndpoint
Details https://stgportalone.processonepayments.com/ExternalApi/users/{accountId}

URI Parameters

NameDescriptionTypeRequired*Additional information
accountId

Account Id

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 

Response Information

UserDetailsResponse

NameDescriptionTypeRequired*Additional information
AccountId

Account Id

string Yes
FirstName

First Name

string No
LastName

Last Name

string No
CustomerId

One Inc Customer Id

string Yes
Roles

Roles collection assigned to the current user. Supported values: insured, agent, csr

Collection of string Yes
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "AccountId": "12345",
  "FirstName": "John",
  "LastName": "Smith",
  "CustomerId": "49437EE0-9C1D-483A-99C3-3C3197FEF8C2",
  "Roles": [
    "agent"
  ],
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<UserDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.User">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
  <AccountId>12345</AccountId>
  <CustomerId>49437EE0-9C1D-483A-99C3-3C3197FEF8C2</CustomerId>
  <FirstName>John</FirstName>
  <LastName>Smith</LastName>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>agent</d2p1:string>
  </Roles>
</UserDetailsResponse>

Policy

This section describes APIs for Policy Operations. This API is instrumental to One Inc. Payment Operations.

GET policies/{policyId}

This method is used to get Policy Details information

MethodEndpoint
Details https://stgportalone.processonepayments.com/ExternalApi/policies/{policyId}

URI Parameters

NameDescriptionTypeRequired*Additional information
policyId

Policy Id

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 

Response Information

PolicyDetailsResponse

NameDescriptionTypeRequired*Additional information
PolicyId

Policy Identifier

string Yes
PolicyNumber

Policy Number

string Yes
CustomerId

ONE Inc customer identifier that will be used to fetch available payment methods

string No
ExternalCustomerId

External generated ID of Customer

string No
CustomerName

Name of the customer

string No
AccountId

Account Identifier

string No
Status

Policy Status

string No
Term

Policy Term

string No
Type

Line Of Business Type. Supported values: Automobile, Homeowner, Workers Comp, Other

string Yes
Premium

Policy Premium

decimal number No
DueDate

Policy Due Date

date No
RemainingBalance

Remaining Balance

decimal number No
MinimumAmountDue

Minimum Amount Due

decimal number Yes
OtherAmountAllowed

Other Amount Allowed

boolean Yes
PaymentsAreAllowed

Payments Are Allowed for the policy This value is optional, default is true

boolean No
IsAutoPayEnabled

Is AutoPay Enabled for the policy This value is optional, default is true

boolean No
ZipCode

Policy Zip Code

string No
FeeContext

Indicates whether a fee will be applied to the payment. Supported values: PaymentWithFee, PaymentWithoutFee. Optional. Default is PaymentWithFee

string No
AccountGroupCode

Indicates the account group/corresponding bank account where the transaction's funds will be allocated from the set of account groups configured in your merchant settings. If omitted, the default account group configured in your merchant settings will be used.

string No
TokenId

Unique identifier that represents a saved card or bank account. Can be used to safely make payments with the saved payment method.

string No
Documents

Collection of policy documents (Proof of insurance document details)

Collection of DocumentDetails No
Bills

Collection of policy bills

Collection of BillDetails No
AutoPayOptions

Collection of possible recurring payment options

Collection of FrequencyDetails No
PolicyDetails

Policy Details. It is used for displaying policy details in portal

PolicyDetailsBase Can be one of the following types: AutoPolicyDetails HomePolicyDetails OtherPolicyDetails WorkersCompPolicyDetails No
InstallmentPlanEngineType

This field will define who will control the AutoPay Payment Plan generation and recurring scheduling.

AutoPayEngineType No
ExternalSchedulerEndpoint

This field value should only be sent when autoPayEngineType = "Carrier". Digital Payments will then use this endpoint to eventually send user-selected Payment Preferences for Auto-Pay Plan creation and scheduling.

string No
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "PolicyId": "123",
  "PolicyNumber": "AB-12345678",
  "Status": "Active",
  "Term": "HalfYear",
  "Type": "Automobile",
  "Premium": 123.0,
  "DueDate": "2020-10-27T07:19:50.979793",
  "RemainingBalance": 100.0,
  "MinimumAmountDue": 25.0,
  "OtherAmountAllowed": true,
  "ZipCode": "95648",
  "FeeContext": "PaymentWithoutFee",
  "AccountGroupCode": "Default",
  "Documents": [
    {
      "Id": "2000",
      "LinkToDownload": "https://link_to_download_the_document_2000"
    }
  ],
  "Bills": [
    {
      "Id": "500",
      "DocumentId": "2001",
      "Date": "2020-08-27T07:19:50.979793",
      "Description": "Bill for [smth]",
      "Amount": 80.0,
      "LinkToDownload": "https://link_to_download_the_bill_500"
    },
    {
      "Id": "600",
      "DocumentId": "2002",
      "Date": "2020-09-27T07:19:50.979793",
      "Description": "Bill for [smth]",
      "Amount": 20.0,
      "LinkToDownload": "https://link_to_download_the_bill_600"
    }
  ],
  "AutoPayOptions": [
    {
      "Frequency": "Monthly",
      "Amount": 100.0,
      "NumberOfInstallments": 12,
      "WithdrawalDates": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20,
        21,
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29,
        30,
        31
      ]
    },
    {
      "Frequency": "Quarterly",
      "Amount": 300.0,
      "NumberOfInstallments": 6,
      "WithdrawalDates": [
        20,
        21,
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29,
        30
      ]
    },
    {
      "Frequency": "Semiannually",
      "Amount": 600.0,
      "NumberOfInstallments": 2,
      "WithdrawalDates": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10
      ]
    },
    {
      "Frequency": "Annually",
      "Amount": 1200.0,
      "NumberOfInstallments": 2,
      "WithdrawalDates": [
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19
      ]
    }
  ],
  "PolicyDetails": {
    "Type": "AutoPolicyDetails",
    "Drivers": [
      {
        "FirstName": "John",
        "LastName": "Smith",
        "LicenseNumber": "343434211",
        "RelationToNamedInsured": "Insured"
      },
      {
        "FirstName": "Samantha",
        "LastName": "Smith",
        "LicenseNumber": "343434213",
        "RelationToNamedInsured": "Spouse"
      }
    ],
    "Vehicles": [
      {
        "Make": "BMW",
        "Model": "M850i",
        "Year": 2018,
        "Vin": "WBACA234587960574",
        "Coverages": [
          {
            "Type": "Comprehensive",
            "LimitOrDeductible": "$1,000"
          },
          {
            "Type": "Collision",
            "LimitOrDeductible": "$500"
          }
        ]
      }
    ],
    "PolicyCoverages": [
      {
        "Type": "Bodily Injury",
        "LimitOrDeductible": "$25,000/$50,000"
      },
      {
        "Type": "Property Damage",
        "LimitOrDeductible": "$10,000"
      },
      {
        "Type": "Uninsured Motorist Bodily Injury",
        "LimitOrDeductible": "$25,000/$50,000"
      },
      {
        "Type": "Underinsured Motorist Bodily Injury",
        "LimitOrDeductible": "$25,000/$50,000"
      }
    ],
    "Properties": {
      "CustomField": "Value",
      "CustomField1": "Value1",
      "CustomField2": "Value2",
      "CustomField3": "Value3"
    }
  },
  "InstallmentPlanEngineType": 1,
  "ExternalSchedulerEndpoint": "http://localhost",
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<PolicyDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Policy">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
  <AccountGroupCode>Default</AccountGroupCode>
  <AccountId i:nil="true" />
  <AutoPayOptions>
    <FrequencyDetails>
      <Amount>100</Amount>
      <Frequency>Monthly</Frequency>
      <NumberOfInstallments>12</NumberOfInstallments>
      <WithdrawalDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
        <d4p1:int>3</d4p1:int>
        <d4p1:int>4</d4p1:int>
        <d4p1:int>5</d4p1:int>
        <d4p1:int>6</d4p1:int>
        <d4p1:int>7</d4p1:int>
        <d4p1:int>8</d4p1:int>
        <d4p1:int>9</d4p1:int>
        <d4p1:int>10</d4p1:int>
        <d4p1:int>11</d4p1:int>
        <d4p1:int>12</d4p1:int>
        <d4p1:int>13</d4p1:int>
        <d4p1:int>14</d4p1:int>
        <d4p1:int>15</d4p1:int>
        <d4p1:int>16</d4p1:int>
        <d4p1:int>17</d4p1:int>
        <d4p1:int>18</d4p1:int>
        <d4p1:int>19</d4p1:int>
        <d4p1:int>20</d4p1:int>
        <d4p1:int>21</d4p1:int>
        <d4p1:int>22</d4p1:int>
        <d4p1:int>23</d4p1:int>
        <d4p1:int>24</d4p1:int>
        <d4p1:int>25</d4p1:int>
        <d4p1:int>26</d4p1:int>
        <d4p1:int>27</d4p1:int>
        <d4p1:int>28</d4p1:int>
        <d4p1:int>29</d4p1:int>
        <d4p1:int>30</d4p1:int>
        <d4p1:int>31</d4p1:int>
      </WithdrawalDates>
    </FrequencyDetails>
    <FrequencyDetails>
      <Amount>300</Amount>
      <Frequency>Quarterly</Frequency>
      <NumberOfInstallments>6</NumberOfInstallments>
      <WithdrawalDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>20</d4p1:int>
        <d4p1:int>21</d4p1:int>
        <d4p1:int>22</d4p1:int>
        <d4p1:int>23</d4p1:int>
        <d4p1:int>24</d4p1:int>
        <d4p1:int>25</d4p1:int>
        <d4p1:int>26</d4p1:int>
        <d4p1:int>27</d4p1:int>
        <d4p1:int>28</d4p1:int>
        <d4p1:int>29</d4p1:int>
        <d4p1:int>30</d4p1:int>
      </WithdrawalDates>
    </FrequencyDetails>
    <FrequencyDetails>
      <Amount>600</Amount>
      <Frequency>Semiannually</Frequency>
      <NumberOfInstallments>2</NumberOfInstallments>
      <WithdrawalDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
        <d4p1:int>3</d4p1:int>
        <d4p1:int>4</d4p1:int>
        <d4p1:int>5</d4p1:int>
        <d4p1:int>6</d4p1:int>
        <d4p1:int>7</d4p1:int>
        <d4p1:int>8</d4p1:int>
        <d4p1:int>9</d4p1:int>
        <d4p1:int>10</d4p1:int>
      </WithdrawalDates>
    </FrequencyDetails>
    <FrequencyDetails>
      <Amount>1200</Amount>
      <Frequency>Annually</Frequency>
      <NumberOfInstallments>2</NumberOfInstallments>
      <WithdrawalDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>10</d4p1:int>
        <d4p1:int>11</d4p1:int>
        <d4p1:int>12</d4p1:int>
        <d4p1:int>13</d4p1:int>
        <d4p1:int>14</d4p1:int>
        <d4p1:int>15</d4p1:int>
        <d4p1:int>16</d4p1:int>
        <d4p1:int>17</d4p1:int>
        <d4p1:int>18</d4p1:int>
        <d4p1:int>19</d4p1:int>
      </WithdrawalDates>
    </FrequencyDetails>
  </AutoPayOptions>
  <Bills>
    <BillDetails>
      <Amount>80</Amount>
      <Date>2020-08-27T07:19:50.979793-07:00</Date>
      <Description>Bill for [smth]</Description>
      <DocumentId>2001</DocumentId>
      <Id>500</Id>
      <LinkToDownload>https://link_to_download_the_bill_500</LinkToDownload>
    </BillDetails>
    <BillDetails>
      <Amount>20</Amount>
      <Date>2020-09-27T07:19:50.979793-07:00</Date>
      <Description>Bill for [smth]</Description>
      <DocumentId>2002</DocumentId>
      <Id>600</Id>
      <LinkToDownload>https://link_to_download_the_bill_600</LinkToDownload>
    </BillDetails>
  </Bills>
  <CustomerId i:nil="true" />
  <CustomerName i:nil="true" />
  <Documents>
    <DocumentDetails>
      <Id>2000</Id>
      <LinkToDownload>https://link_to_download_the_document_2000</LinkToDownload>
      <Type i:nil="true" />
    </DocumentDetails>
  </Documents>
  <DueDate>2020-10-27T07:19:50.979793-07:00</DueDate>
  <ExternalCustomerId i:nil="true" />
  <ExternalSchedulerEndpoint>http://localhost</ExternalSchedulerEndpoint>
  <FeeContext>PaymentWithoutFee</FeeContext>
  <InstallmentPlanEngineType>Carrier</InstallmentPlanEngineType>
  <IsAutoPayEnabled i:nil="true" />
  <MinimumAmountDue>25</MinimumAmountDue>
  <OtherAmountAllowed>true</OtherAmountAllowed>
  <PaymentsAreAllowed i:nil="true" />
  <PolicyDetails i:type="AutoPolicyDetails">
    <Properties xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>CustomField</d3p1:Key>
        <d3p1:Value>Value</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>CustomField1</d3p1:Key>
        <d3p1:Value>Value1</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>CustomField2</d3p1:Key>
        <d3p1:Value>Value2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>CustomField3</d3p1:Key>
        <d3p1:Value>Value3</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Properties>
    <Drivers>
      <Driver>
        <FirstName>John</FirstName>
        <LastName>Smith</LastName>
        <LicenseNumber>343434211</LicenseNumber>
        <RelationToNamedInsured>Insured</RelationToNamedInsured>
      </Driver>
      <Driver>
        <FirstName>Samantha</FirstName>
        <LastName>Smith</LastName>
        <LicenseNumber>343434213</LicenseNumber>
        <RelationToNamedInsured>Spouse</RelationToNamedInsured>
      </Driver>
    </Drivers>
    <PolicyCoverages>
      <Coverage>
        <LimitOrDeductible>$25,000/$50,000</LimitOrDeductible>
        <Type>Bodily Injury</Type>
      </Coverage>
      <Coverage>
        <LimitOrDeductible>$10,000</LimitOrDeductible>
        <Type>Property Damage</Type>
      </Coverage>
      <Coverage>
        <LimitOrDeductible>$25,000/$50,000</LimitOrDeductible>
        <Type>Uninsured Motorist Bodily Injury</Type>
      </Coverage>
      <Coverage>
        <LimitOrDeductible>$25,000/$50,000</LimitOrDeductible>
        <Type>Underinsured Motorist Bodily Injury</Type>
      </Coverage>
    </PolicyCoverages>
    <Vehicles>
      <Vehicle>
        <Coverages>
          <Coverage>
            <LimitOrDeductible>$1,000</LimitOrDeductible>
            <Type>Comprehensive</Type>
          </Coverage>
          <Coverage>
            <LimitOrDeductible>$500</LimitOrDeductible>
            <Type>Collision</Type>
          </Coverage>
        </Coverages>
        <Make>BMW</Make>
        <Model>M850i</Model>
        <Vin>WBACA234587960574</Vin>
        <Year>2018</Year>
      </Vehicle>
    </Vehicles>
  </PolicyDetails>
  <PolicyId>123</PolicyId>
  <PolicyNumber>AB-12345678</PolicyNumber>
  <Premium>123</Premium>
  <RemainingBalance>100</RemainingBalance>
  <Status>Active</Status>
  <Term>HalfYear</Term>
  <TokenId i:nil="true" />
  <Type>Automobile</Type>
  <ZipCode>95648</ZipCode>
</PolicyDetailsResponse>

GET policies/{policyId}/documents/{documentId}

Download Policy document

MethodEndpoint
DownloadDocument https://stgportalone.processonepayments.com/ExternalApi/policies/{policyId}/documents/{documentId}

URI Parameters

NameDescriptionTypeRequired*Additional information
policyId

Policy Id

string Yes
documentId

Document Id

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 

Response Information

FileStreamResponse

NameDescriptionTypeRequired*Additional information
Content

File stream

Collection of byte Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "Content": "SGVsbG8gd29ybGQ="
}
<FileStreamResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Policy">
  <Content>SGVsbG8gd29ybGQ=</Content>
</FileStreamResponse>

POST policies/search

This method is used for searching policies

MethodEndpoint
Search https://stgportalone.processonepayments.com/ExternalApi/policies/search

SearchRequest

NameDescriptionTypeRequired*Additional information
Limit

Maximum number of records in result

integer Yes
Offset

How many records to skip in result

integer Yes
SortBy

Defines sorting order. Only one column sorting is supported

string Yes
SearchParameters

Collection of Key/Value search parameters. Available parameters are configurable by merchant. For example a merchant can configure the portal to send "policyNumber", "accountNumber", "insuredName" fields as search parameters.

Dictionary of string and string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "Limit": 25,
  "Offset": 0,
  "SortBy": "policyNumber:asc",
  "SearchParameters": {
    "accountId": "B55BA07A-94EF-49AF-9B2D-669812C8F070"
  }
}
                                
                                 <SearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Search">
  <Limit>25</Limit>
  <Offset>0</Offset>
  <SearchParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>accountId</d2p1:Key>
      <d2p1:Value>B55BA07A-94EF-49AF-9B2D-669812C8F070</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </SearchParameters>
  <SortBy>policyNumber:asc</SortBy>
</SearchRequest>

Response Information

PolicySearchResponse

NameDescriptionTypeRequired*Additional information
Results

List of policies matching the search criteria

Collection of PolicyDetailsResponse Yes
TotalCount

Total number of results

integer Yes
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "Results": [
    {
      "PolicyId": "123",
      "PolicyNumber": "AB-12345678",
      "Status": "Active",
      "Term": "HalfYear",
      "Type": "Automobile",
      "Premium": 123.0,
      "DueDate": "2020-10-27T07:19:52.0735725",
      "RemainingBalance": 100.0,
      "MinimumAmountDue": 25.0,
      "OtherAmountAllowed": true,
      "ZipCode": "95648",
      "FeeContext": "PaymentWithoutFee",
      "AccountGroupCode": "Default",
      "Documents": [
        {
          "Id": "2000",
          "LinkToDownload": "https://link_to_download_the_document_2000"
        }
      ],
      "Bills": [
        {
          "Id": "500",
          "DocumentId": "2001",
          "Date": "2020-08-27T07:19:52.0735725",
          "Description": "Bill for [smth]",
          "Amount": 80.0,
          "LinkToDownload": "https://link_to_download_the_bill_500"
        },
        {
          "Id": "600",
          "DocumentId": "2002",
          "Date": "2020-09-27T07:19:52.0735725",
          "Description": "Bill for [smth]",
          "Amount": 20.0,
          "LinkToDownload": "https://link_to_download_the_bill_600"
        }
      ],
      "AutoPayOptions": [
        {
          "Frequency": "Monthly",
          "Amount": 100.0,
          "NumberOfInstallments": 12,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19,
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30,
            31
          ]
        },
        {
          "Frequency": "Quarterly",
          "Amount": 300.0,
          "NumberOfInstallments": 6,
          "WithdrawalDates": [
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30
          ]
        },
        {
          "Frequency": "Semiannually",
          "Amount": 600.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10
          ]
        },
        {
          "Frequency": "Annually",
          "Amount": 1200.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19
          ]
        }
      ],
      "PolicyDetails": {
        "Type": "AutoPolicyDetails",
        "Drivers": [
          {
            "FirstName": "John",
            "LastName": "Smith",
            "LicenseNumber": "343434211",
            "RelationToNamedInsured": "Insured"
          },
          {
            "FirstName": "Samantha",
            "LastName": "Smith",
            "LicenseNumber": "343434213",
            "RelationToNamedInsured": "Spouse"
          }
        ],
        "Vehicles": [
          {
            "Make": "BMW",
            "Model": "M850i",
            "Year": 2018,
            "Vin": "WBACA234587960574",
            "Coverages": [
              {
                "Type": "Comprehensive",
                "LimitOrDeductible": "$1,000"
              },
              {
                "Type": "Collision",
                "LimitOrDeductible": "$500"
              }
            ]
          }
        ],
        "PolicyCoverages": [
          {
            "Type": "Bodily Injury",
            "LimitOrDeductible": "$25,000/$50,000"
          },
          {
            "Type": "Property Damage",
            "LimitOrDeductible": "$10,000"
          },
          {
            "Type": "Uninsured Motorist Bodily Injury",
            "LimitOrDeductible": "$25,000/$50,000"
          },
          {
            "Type": "Underinsured Motorist Bodily Injury",
            "LimitOrDeductible": "$25,000/$50,000"
          }
        ],
        "Properties": {
          "CustomField": "Value",
          "CustomField1": "Value1",
          "CustomField2": "Value2",
          "CustomField3": "Value3"
        }
      },
      "InstallmentPlanEngineType": 1,
      "ExternalSchedulerEndpoint": "http://localhost",
      "IsSuccessful": true,
      "ErrorMessage": ""
    },
    {
      "PolicyId": "456",
      "PolicyNumber": "AB-98765432",
      "Status": "Active",
      "Term": "Annual",
      "Type": "Homeowner",
      "Premium": 123.0,
      "DueDate": "2020-10-27T07:19:52.0735725",
      "RemainingBalance": 100.0,
      "MinimumAmountDue": 25.0,
      "OtherAmountAllowed": true,
      "ZipCode": "95648",
      "FeeContext": "PaymentWithFee",
      "AccountGroupCode": "Special",
      "Documents": [
        {
          "Id": "2000",
          "LinkToDownload": "https://link_to_download_the_document_2000"
        }
      ],
      "Bills": [
        {
          "Id": "500",
          "DocumentId": "2001",
          "Date": "2020-08-27T07:19:52.0735725",
          "Description": "Bill for [smth]",
          "Amount": 80.0,
          "LinkToDownload": "https://link_to_download_the_bill_500"
        },
        {
          "Id": "600",
          "DocumentId": "2002",
          "Date": "2020-09-27T07:19:52.0735725",
          "Description": "Bill for [smth]",
          "Amount": 20.0,
          "LinkToDownload": "https://link_to_download_the_bill_600"
        }
      ],
      "AutoPayOptions": [
        {
          "Frequency": "Monthly",
          "Amount": 100.0,
          "NumberOfInstallments": 12,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19,
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30,
            31
          ]
        },
        {
          "Frequency": "Quarterly",
          "Amount": 300.0,
          "NumberOfInstallments": 6,
          "WithdrawalDates": [
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30
          ]
        },
        {
          "Frequency": "Semiannually",
          "Amount": 600.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10
          ]
        },
        {
          "Frequency": "Annually",
          "Amount": 1200.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19
          ]
        }
      ],
      "PolicyDetails": {
        "Type": "HomePolicyDetails",
        "Deductible": 5000.0,
        "Mortgagee": "People First Mortgage",
        "LoanNumber": "1234567890",
        "AgentName": "Samuel Johnson",
        "AgentPhoneNumber": "800-234-6749",
        "Coverages": [
          {
            "Type": "Dwelling",
            "LimitOrDeductible": "$320,000"
          },
          {
            "Type": "Personal Property",
            "LimitOrDeductible": "$240,000"
          },
          {
            "Type": "Personal Liability",
            "LimitOrDeductible": "$100,000"
          },
          {
            "Type": "Medical Payments",
            "LimitOrDeductible": "$1,000"
          }
        ],
        "Properties": {
          "CustomField": "Value"
        }
      },
      "InstallmentPlanEngineType": 0,
      "IsSuccessful": true,
      "ErrorMessage": ""
    },
    {
      "PolicyId": "987",
      "PolicyNumber": "AB-98745643",
      "Status": "Active",
      "Term": "Annual",
      "Type": "Homeowner",
      "Premium": 456.0,
      "DueDate": "2020-11-06T07:19:52.0735725",
      "RemainingBalance": 789.0,
      "MinimumAmountDue": 25.0,
      "OtherAmountAllowed": true,
      "ZipCode": "95648",
      "Documents": [
        {
          "Id": "2000",
          "LinkToDownload": "https://link_to_download_the_document_2000"
        }
      ],
      "Bills": [
        {
          "Id": "500",
          "DocumentId": "2001",
          "Date": "2020-08-27T07:19:52.0735725",
          "Description": "Bill for [smth]",
          "Amount": 80.0,
          "LinkToDownload": "https://link_to_download_the_bill_500"
        },
        {
          "Id": "600",
          "DocumentId": "2002",
          "Date": "2020-09-27T07:19:52.0735725",
          "Description": "Bill for [smth]",
          "Amount": 20.0,
          "LinkToDownload": "https://link_to_download_the_bill_600"
        }
      ],
      "AutoPayOptions": [
        {
          "Frequency": "Monthly",
          "Amount": 100.0,
          "NumberOfInstallments": 12,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19,
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30,
            31
          ]
        },
        {
          "Frequency": "Quarterly",
          "Amount": 300.0,
          "NumberOfInstallments": 6,
          "WithdrawalDates": [
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30
          ]
        },
        {
          "Frequency": "Semiannually",
          "Amount": 600.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10
          ]
        },
        {
          "Frequency": "Annually",
          "Amount": 1200.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19
          ]
        }
      ],
      "PolicyDetails": {
        "Type": "OtherPolicyDetails",
        "Properties": {
          "CustomField": "Value",
          "CustomField1": "Value1",
          "CustomField2": "Value2",
          "CustomField3": "Value3"
        }
      },
      "InstallmentPlanEngineType": 1,
      "ExternalSchedulerEndpoint": "http://localhost",
      "IsSuccessful": true,
      "ErrorMessage": ""
    },
    {
      "PolicyId": "987",
      "PolicyNumber": "AB-98745643",
      "Status": "Active",
      "Term": "Annual",
      "Type": "Other",
      "Premium": 456.0,
      "DueDate": "2020-11-01T07:19:52.0735725",
      "RemainingBalance": 789.0,
      "MinimumAmountDue": 25.0,
      "OtherAmountAllowed": true,
      "ZipCode": "95648",
      "Documents": [
        {
          "Id": "2000",
          "LinkToDownload": "https://link_to_download_the_document_2000"
        }
      ],
      "Bills": [
        {
          "Id": "500",
          "DocumentId": "2001",
          "Date": "2020-08-27T07:19:52.0735725",
          "Description": "Bill for [smth]",
          "Amount": 80.0,
          "LinkToDownload": "https://link_to_download_the_bill_500"
        },
        {
          "Id": "600",
          "DocumentId": "2002",
          "Date": "2020-09-27T07:19:52.0735725",
          "Description": "Bill for [smth]",
          "Amount": 20.0,
          "LinkToDownload": "https://link_to_download_the_bill_600"
        }
      ],
      "AutoPayOptions": [
        {
          "Frequency": "Monthly",
          "Amount": 100.0,
          "NumberOfInstallments": 12,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19,
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30,
            31
          ]
        },
        {
          "Frequency": "Quarterly",
          "Amount": 300.0,
          "NumberOfInstallments": 6,
          "WithdrawalDates": [
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30
          ]
        },
        {
          "Frequency": "Semiannually",
          "Amount": 600.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10
          ]
        },
        {
          "Frequency": "Annually",
          "Amount": 1200.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19
          ]
        }
      ],
      "PolicyDetails": {
        "Type": "WorkersCompPolicyDetails",
        "Properties": {
          "CustomField": "Value",
          "CustomField1": "Value1",
          "CustomField2": "Value2",
          "CustomField3": "Value3"
        }
      },
      "InstallmentPlanEngineType": 0,
      "IsSuccessful": true,
      "ErrorMessage": ""
    }
  ],
  "TotalCount": 0,
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<PolicySearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Policy">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
  <Results>
    <PolicyDetailsResponse>
      <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
      <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
      <AccountGroupCode>Default</AccountGroupCode>
      <AccountId i:nil="true" />
      <AutoPayOptions>
        <FrequencyDetails>
          <Amount>100</Amount>
          <Frequency>Monthly</Frequency>
          <NumberOfInstallments>12</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
            <d6p1:int>31</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>300</Amount>
          <Frequency>Quarterly</Frequency>
          <NumberOfInstallments>6</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>600</Amount>
          <Frequency>Semiannually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>1200</Amount>
          <Frequency>Annually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
      </AutoPayOptions>
      <Bills>
        <BillDetails>
          <Amount>80</Amount>
          <Date>2020-08-27T07:19:52.0735725-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2001</DocumentId>
          <Id>500</Id>
          <LinkToDownload>https://link_to_download_the_bill_500</LinkToDownload>
        </BillDetails>
        <BillDetails>
          <Amount>20</Amount>
          <Date>2020-09-27T07:19:52.0735725-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2002</DocumentId>
          <Id>600</Id>
          <LinkToDownload>https://link_to_download_the_bill_600</LinkToDownload>
        </BillDetails>
      </Bills>
      <CustomerId i:nil="true" />
      <CustomerName i:nil="true" />
      <Documents>
        <DocumentDetails>
          <Id>2000</Id>
          <LinkToDownload>https://link_to_download_the_document_2000</LinkToDownload>
          <Type i:nil="true" />
        </DocumentDetails>
      </Documents>
      <DueDate>2020-10-27T07:19:52.0735725-07:00</DueDate>
      <ExternalCustomerId i:nil="true" />
      <ExternalSchedulerEndpoint>http://localhost</ExternalSchedulerEndpoint>
      <FeeContext>PaymentWithoutFee</FeeContext>
      <InstallmentPlanEngineType>Carrier</InstallmentPlanEngineType>
      <IsAutoPayEnabled i:nil="true" />
      <MinimumAmountDue>25</MinimumAmountDue>
      <OtherAmountAllowed>true</OtherAmountAllowed>
      <PaymentsAreAllowed i:nil="true" />
      <PolicyDetails i:type="AutoPolicyDetails">
        <Properties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField</d5p1:Key>
            <d5p1:Value>Value</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField1</d5p1:Key>
            <d5p1:Value>Value1</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField2</d5p1:Key>
            <d5p1:Value>Value2</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField3</d5p1:Key>
            <d5p1:Value>Value3</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Properties>
        <Drivers>
          <Driver>
            <FirstName>John</FirstName>
            <LastName>Smith</LastName>
            <LicenseNumber>343434211</LicenseNumber>
            <RelationToNamedInsured>Insured</RelationToNamedInsured>
          </Driver>
          <Driver>
            <FirstName>Samantha</FirstName>
            <LastName>Smith</LastName>
            <LicenseNumber>343434213</LicenseNumber>
            <RelationToNamedInsured>Spouse</RelationToNamedInsured>
          </Driver>
        </Drivers>
        <PolicyCoverages>
          <Coverage>
            <LimitOrDeductible>$25,000/$50,000</LimitOrDeductible>
            <Type>Bodily Injury</Type>
          </Coverage>
          <Coverage>
            <LimitOrDeductible>$10,000</LimitOrDeductible>
            <Type>Property Damage</Type>
          </Coverage>
          <Coverage>
            <LimitOrDeductible>$25,000/$50,000</LimitOrDeductible>
            <Type>Uninsured Motorist Bodily Injury</Type>
          </Coverage>
          <Coverage>
            <LimitOrDeductible>$25,000/$50,000</LimitOrDeductible>
            <Type>Underinsured Motorist Bodily Injury</Type>
          </Coverage>
        </PolicyCoverages>
        <Vehicles>
          <Vehicle>
            <Coverages>
              <Coverage>
                <LimitOrDeductible>$1,000</LimitOrDeductible>
                <Type>Comprehensive</Type>
              </Coverage>
              <Coverage>
                <LimitOrDeductible>$500</LimitOrDeductible>
                <Type>Collision</Type>
              </Coverage>
            </Coverages>
            <Make>BMW</Make>
            <Model>M850i</Model>
            <Vin>WBACA234587960574</Vin>
            <Year>2018</Year>
          </Vehicle>
        </Vehicles>
      </PolicyDetails>
      <PolicyId>123</PolicyId>
      <PolicyNumber>AB-12345678</PolicyNumber>
      <Premium>123</Premium>
      <RemainingBalance>100</RemainingBalance>
      <Status>Active</Status>
      <Term>HalfYear</Term>
      <TokenId i:nil="true" />
      <Type>Automobile</Type>
      <ZipCode>95648</ZipCode>
    </PolicyDetailsResponse>
    <PolicyDetailsResponse>
      <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
      <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
      <AccountGroupCode>Special</AccountGroupCode>
      <AccountId i:nil="true" />
      <AutoPayOptions>
        <FrequencyDetails>
          <Amount>100</Amount>
          <Frequency>Monthly</Frequency>
          <NumberOfInstallments>12</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
            <d6p1:int>31</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>300</Amount>
          <Frequency>Quarterly</Frequency>
          <NumberOfInstallments>6</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>600</Amount>
          <Frequency>Semiannually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>1200</Amount>
          <Frequency>Annually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
      </AutoPayOptions>
      <Bills>
        <BillDetails>
          <Amount>80</Amount>
          <Date>2020-08-27T07:19:52.0735725-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2001</DocumentId>
          <Id>500</Id>
          <LinkToDownload>https://link_to_download_the_bill_500</LinkToDownload>
        </BillDetails>
        <BillDetails>
          <Amount>20</Amount>
          <Date>2020-09-27T07:19:52.0735725-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2002</DocumentId>
          <Id>600</Id>
          <LinkToDownload>https://link_to_download_the_bill_600</LinkToDownload>
        </BillDetails>
      </Bills>
      <CustomerId i:nil="true" />
      <CustomerName i:nil="true" />
      <Documents>
        <DocumentDetails>
          <Id>2000</Id>
          <LinkToDownload>https://link_to_download_the_document_2000</LinkToDownload>
          <Type i:nil="true" />
        </DocumentDetails>
      </Documents>
      <DueDate>2020-10-27T07:19:52.0735725-07:00</DueDate>
      <ExternalCustomerId i:nil="true" />
      <ExternalSchedulerEndpoint i:nil="true" />
      <FeeContext>PaymentWithFee</FeeContext>
      <InstallmentPlanEngineType>InstallmentsEngine</InstallmentPlanEngineType>
      <IsAutoPayEnabled i:nil="true" />
      <MinimumAmountDue>25</MinimumAmountDue>
      <OtherAmountAllowed>true</OtherAmountAllowed>
      <PaymentsAreAllowed i:nil="true" />
      <PolicyDetails i:type="HomePolicyDetails">
        <Properties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField</d5p1:Key>
            <d5p1:Value>Value</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Properties>
        <AgentName>Samuel Johnson</AgentName>
        <AgentPhoneNumber>800-234-6749</AgentPhoneNumber>
        <Coverages>
          <Coverage>
            <LimitOrDeductible>$320,000</LimitOrDeductible>
            <Type>Dwelling</Type>
          </Coverage>
          <Coverage>
            <LimitOrDeductible>$240,000</LimitOrDeductible>
            <Type>Personal Property</Type>
          </Coverage>
          <Coverage>
            <LimitOrDeductible>$100,000</LimitOrDeductible>
            <Type>Personal Liability</Type>
          </Coverage>
          <Coverage>
            <LimitOrDeductible>$1,000</LimitOrDeductible>
            <Type>Medical Payments</Type>
          </Coverage>
        </Coverages>
        <Deductible>5000</Deductible>
        <LoanNumber>1234567890</LoanNumber>
        <Mortgagee>People First Mortgage</Mortgagee>
      </PolicyDetails>
      <PolicyId>456</PolicyId>
      <PolicyNumber>AB-98765432</PolicyNumber>
      <Premium>123</Premium>
      <RemainingBalance>100</RemainingBalance>
      <Status>Active</Status>
      <Term>Annual</Term>
      <TokenId i:nil="true" />
      <Type>Homeowner</Type>
      <ZipCode>95648</ZipCode>
    </PolicyDetailsResponse>
    <PolicyDetailsResponse>
      <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
      <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
      <AccountGroupCode i:nil="true" />
      <AccountId i:nil="true" />
      <AutoPayOptions>
        <FrequencyDetails>
          <Amount>100</Amount>
          <Frequency>Monthly</Frequency>
          <NumberOfInstallments>12</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
            <d6p1:int>31</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>300</Amount>
          <Frequency>Quarterly</Frequency>
          <NumberOfInstallments>6</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>600</Amount>
          <Frequency>Semiannually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>1200</Amount>
          <Frequency>Annually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
      </AutoPayOptions>
      <Bills>
        <BillDetails>
          <Amount>80</Amount>
          <Date>2020-08-27T07:19:52.0735725-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2001</DocumentId>
          <Id>500</Id>
          <LinkToDownload>https://link_to_download_the_bill_500</LinkToDownload>
        </BillDetails>
        <BillDetails>
          <Amount>20</Amount>
          <Date>2020-09-27T07:19:52.0735725-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2002</DocumentId>
          <Id>600</Id>
          <LinkToDownload>https://link_to_download_the_bill_600</LinkToDownload>
        </BillDetails>
      </Bills>
      <CustomerId i:nil="true" />
      <CustomerName i:nil="true" />
      <Documents>
        <DocumentDetails>
          <Id>2000</Id>
          <LinkToDownload>https://link_to_download_the_document_2000</LinkToDownload>
          <Type i:nil="true" />
        </DocumentDetails>
      </Documents>
      <DueDate>2020-11-06T07:19:52.0735725-08:00</DueDate>
      <ExternalCustomerId i:nil="true" />
      <ExternalSchedulerEndpoint>http://localhost</ExternalSchedulerEndpoint>
      <FeeContext i:nil="true" />
      <InstallmentPlanEngineType>Carrier</InstallmentPlanEngineType>
      <IsAutoPayEnabled i:nil="true" />
      <MinimumAmountDue>25</MinimumAmountDue>
      <OtherAmountAllowed>true</OtherAmountAllowed>
      <PaymentsAreAllowed i:nil="true" />
      <PolicyDetails i:type="OtherPolicyDetails">
        <Properties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField</d5p1:Key>
            <d5p1:Value>Value</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField1</d5p1:Key>
            <d5p1:Value>Value1</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField2</d5p1:Key>
            <d5p1:Value>Value2</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField3</d5p1:Key>
            <d5p1:Value>Value3</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Properties>
      </PolicyDetails>
      <PolicyId>987</PolicyId>
      <PolicyNumber>AB-98745643</PolicyNumber>
      <Premium>456</Premium>
      <RemainingBalance>789</RemainingBalance>
      <Status>Active</Status>
      <Term>Annual</Term>
      <TokenId i:nil="true" />
      <Type>Homeowner</Type>
      <ZipCode>95648</ZipCode>
    </PolicyDetailsResponse>
    <PolicyDetailsResponse>
      <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
      <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
      <AccountGroupCode i:nil="true" />
      <AccountId i:nil="true" />
      <AutoPayOptions>
        <FrequencyDetails>
          <Amount>100</Amount>
          <Frequency>Monthly</Frequency>
          <NumberOfInstallments>12</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
            <d6p1:int>31</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>300</Amount>
          <Frequency>Quarterly</Frequency>
          <NumberOfInstallments>6</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>600</Amount>
          <Frequency>Semiannually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>1200</Amount>
          <Frequency>Annually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
      </AutoPayOptions>
      <Bills>
        <BillDetails>
          <Amount>80</Amount>
          <Date>2020-08-27T07:19:52.0735725-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2001</DocumentId>
          <Id>500</Id>
          <LinkToDownload>https://link_to_download_the_bill_500</LinkToDownload>
        </BillDetails>
        <BillDetails>
          <Amount>20</Amount>
          <Date>2020-09-27T07:19:52.0735725-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2002</DocumentId>
          <Id>600</Id>
          <LinkToDownload>https://link_to_download_the_bill_600</LinkToDownload>
        </BillDetails>
      </Bills>
      <CustomerId i:nil="true" />
      <CustomerName i:nil="true" />
      <Documents>
        <DocumentDetails>
          <Id>2000</Id>
          <LinkToDownload>https://link_to_download_the_document_2000</LinkToDownload>
          <Type i:nil="true" />
        </DocumentDetails>
      </Documents>
      <DueDate>2020-11-01T07:19:52.0735725-08:00</DueDate>
      <ExternalCustomerId i:nil="true" />
      <ExternalSchedulerEndpoint i:nil="true" />
      <FeeContext i:nil="true" />
      <InstallmentPlanEngineType>InstallmentsEngine</InstallmentPlanEngineType>
      <IsAutoPayEnabled i:nil="true" />
      <MinimumAmountDue>25</MinimumAmountDue>
      <OtherAmountAllowed>true</OtherAmountAllowed>
      <PaymentsAreAllowed i:nil="true" />
      <PolicyDetails i:type="WorkersCompPolicyDetails">
        <Properties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField</d5p1:Key>
            <d5p1:Value>Value</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField1</d5p1:Key>
            <d5p1:Value>Value1</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField2</d5p1:Key>
            <d5p1:Value>Value2</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField3</d5p1:Key>
            <d5p1:Value>Value3</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Properties>
      </PolicyDetails>
      <PolicyId>987</PolicyId>
      <PolicyNumber>AB-98745643</PolicyNumber>
      <Premium>456</Premium>
      <RemainingBalance>789</RemainingBalance>
      <Status>Active</Status>
      <Term>Annual</Term>
      <TokenId i:nil="true" />
      <Type>Other</Type>
      <ZipCode>95648</ZipCode>
    </PolicyDetailsResponse>
  </Results>
  <TotalCount>0</TotalCount>
</PolicySearchResponse>

POST policies/download

Download file

MethodEndpoint
Download https://stgportalone.processonepayments.com/ExternalApi/policies/download

DownloadRequest

NameDescriptionTypeRequired*Additional information
File

File url

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "File": "sample string 1"
}
                                
                                 <DownloadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Policy">
  <File>sample string 1</File>
</DownloadRequest>

Response Information

FileStreamResponse

NameDescriptionTypeRequired*Additional information
Content

File stream

Collection of byte Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "Content": "SGVsbG8gd29ybGQ="
}
<FileStreamResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Policy">
  <Content>SGVsbG8gd29ybGQ=</Content>
</FileStreamResponse>

Account

This section describes Account Operations

GET accounts/{accountId}

This method is used to get Account Details information

MethodEndpoint
Details https://stgportalone.processonepayments.com/ExternalApi/accounts/{accountId}

URI Parameters

NameDescriptionTypeRequired*Additional information
accountId

Account Id

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 

Response Information

AccountDetailsResponse

NameDescriptionTypeRequired*Additional information
AccountId

Gets or sets Customer's Account Id

string Yes
FirstName

Gets or sets Customer's First Name

string No
LastName

Gets or sets Customer's Last Name

string No
AgentLink

Gets or sets the External link to the Customer's Agent Contact page

string No
TimeZone

Gets or sets Customer's Time Zone in Olson/IANA format (e.g. America/Los_Angeles). If not specified, the portal setting will be used.

string No
Phones

Account phones collection

Collection of Phone No
Email

Gets or sets Customer's Email address

string No
Addresses

Gets or sets Customer's Address

Collection of Address No
Properties

Generic Key/Value Property list

Dictionary of string and string No
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Phone

NameDescriptionTypeRequired*Additional information
Type

Phone Type

string Yes
Number

Phone Number

string Yes
Extension

Extension

string No
IsPreferredPhoneNumber

Indicates whether to use this phone as a primary contact

boolean Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Address

NameDescriptionTypeRequired*Additional information
StreetAddress

Street Address

string Yes
City

City

string Yes
State

State

string Yes
ZipCode

Zip Code

string Yes
Country

Country

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "AccountId": "12345",
  "FirstName": "John",
  "LastName": "Smith",
  "AgentLink": "https://example.com/agentsmith",
  "TimeZone": "US/Pacific",
  "Phones": [
    {
      "Type": "Cell",
      "Number": "916-123-4567",
      "Extension": "1",
      "IsPreferredPhoneNumber": true
    },
    {
      "Type": "Home",
      "Number": "916-234-5678",
      "Extension": "2",
      "IsPreferredPhoneNumber": false
    }
  ],
  "Email": "[email protected]",
  "Addresses": [
    {
      "StreetAddress": "123 Main Street",
      "City": "Bigcity",
      "State": "CA",
      "ZipCode": "98765",
      "Country": "USA"
    }
  ],
  "Properties": {
    "CustomField1": "Value1",
    "CustomField2": "Value2"
  },
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<AccountDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
  <AccountId>12345</AccountId>
  <Addresses>
    <Address>
      <City>Bigcity</City>
      <Country>USA</Country>
      <State>CA</State>
      <StreetAddress>123 Main Street</StreetAddress>
      <ZipCode>98765</ZipCode>
    </Address>
  </Addresses>
  <AgentLink>https://example.com/agentsmith</AgentLink>
  <Email>[email protected]</Email>
  <FirstName>John</FirstName>
  <LastName>Smith</LastName>
  <Phones>
    <Phone>
      <Extension>1</Extension>
      <IsPreferredPhoneNumber>true</IsPreferredPhoneNumber>
      <Number>916-123-4567</Number>
      <Type>Cell</Type>
    </Phone>
    <Phone>
      <Extension>2</Extension>
      <IsPreferredPhoneNumber>false</IsPreferredPhoneNumber>
      <Number>916-234-5678</Number>
      <Type>Home</Type>
    </Phone>
  </Phones>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>CustomField1</d2p1:Key>
      <d2p1:Value>Value1</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>CustomField2</d2p1:Key>
      <d2p1:Value>Value2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Properties>
  <TimeZone>US/Pacific</TimeZone>
</AccountDetailsResponse>

POST accounts/{accountId}/updateEmail

This method is used to update customer's email.

MethodEndpoint
UpdateEmail https://stgportalone.processonepayments.com/ExternalApi/accounts/{accountId}/updateEmail

URI Parameters

NameDescriptionTypeRequired*Additional information
accountId

Account Id

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 
                                
                                 {
  "AccountId": "12345",
  "Email": "[email protected]"
}
                                
                                 <UpdateEmailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <AccountId>12345</AccountId>
  <Email>[email protected]</Email>
</UpdateEmailRequest>

Response Information

UpdateEmailResponse

NameDescriptionTypeRequired*Additional information
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<UpdateEmailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
</UpdateEmailResponse>

POST accounts/{accountId}/paymentMethods

This method is used to make changes in payment methods like adding, deleting, set/unset default

MethodEndpoint
UpdatePaymentMethods https://stgportalone.processonepayments.com/ExternalApi/accounts/{accountId}/paymentMethods

URI Parameters

NameDescriptionTypeRequired*Additional information
accountId

Account Id

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 
                                
                                 {
  "Actions": [
    {
      "PaymentMethodToken": "bf067135-78f6-4c9d-99c4-f067469801cc",
      "Action": "Created"
    },
    {
      "PaymentMethodToken": "5515e1a6-717f-4163-a8a3-fdb5bc9dd863",
      "Action": "Deleted"
    },
    {
      "PaymentMethodToken": "ebc51462-d04e-475a-8906-b2e0b3e78ef2",
      "Action": "SetDefault"
    },
    {
      "PaymentMethodToken": "588bce97-80de-48c9-91fa-f8c6ffde7146",
      "Action": "UnsetDefault"
    }
  ],
  "AccountId": "100"
}
                                
                                 <UpdatePaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <AccountId>100</AccountId>
  <Actions>
    <UpdatePaymentMethodAction>
      <Action>Created</Action>
      <PaymentMethodToken>bf067135-78f6-4c9d-99c4-f067469801cc</PaymentMethodToken>
    </UpdatePaymentMethodAction>
    <UpdatePaymentMethodAction>
      <Action>Deleted</Action>
      <PaymentMethodToken>5515e1a6-717f-4163-a8a3-fdb5bc9dd863</PaymentMethodToken>
    </UpdatePaymentMethodAction>
    <UpdatePaymentMethodAction>
      <Action>SetDefault</Action>
      <PaymentMethodToken>ebc51462-d04e-475a-8906-b2e0b3e78ef2</PaymentMethodToken>
    </UpdatePaymentMethodAction>
    <UpdatePaymentMethodAction>
      <Action>UnsetDefault</Action>
      <PaymentMethodToken>588bce97-80de-48c9-91fa-f8c6ffde7146</PaymentMethodToken>
    </UpdatePaymentMethodAction>
  </Actions>
</UpdatePaymentMethodRequest>

Response Information

UpdatePaymentMethodResponse

NameDescriptionTypeRequired*Additional information
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<UpdatePaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
</UpdatePaymentMethodResponse>

GET accounts/{accountId}/policies

Get Active Policies for the customer

MethodEndpoint
ActivePolicies https://stgportalone.processonepayments.com/ExternalApi/accounts/{accountId}/policies

URI Parameters

NameDescriptionTypeRequired*Additional information
accountId

Account Id

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 

Response Information

GetActivePoliciesResponse

NameDescriptionTypeRequired*Additional information
Policies

Collection of Policies

Collection of PolicyDetailsResponse Yes
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "Policies": [
    {
      "PolicyId": "123",
      "PolicyNumber": "AB-12345678",
      "Status": "Active",
      "Term": "HalfYear",
      "Type": "Automobile",
      "Premium": 123.0,
      "DueDate": "2020-10-27T07:19:55.0281593",
      "RemainingBalance": 100.0,
      "MinimumAmountDue": 25.0,
      "OtherAmountAllowed": true,
      "ZipCode": "95648",
      "FeeContext": "PaymentWithoutFee",
      "AccountGroupCode": "Default",
      "Documents": [
        {
          "Id": "2000",
          "LinkToDownload": "https://link_to_download_the_document_2000"
        }
      ],
      "Bills": [
        {
          "Id": "500",
          "DocumentId": "2001",
          "Date": "2020-08-27T07:19:55.0281593",
          "Description": "Bill for [smth]",
          "Amount": 80.0,
          "LinkToDownload": "https://link_to_download_the_bill_500"
        },
        {
          "Id": "600",
          "DocumentId": "2002",
          "Date": "2020-09-27T07:19:55.0281593",
          "Description": "Bill for [smth]",
          "Amount": 20.0,
          "LinkToDownload": "https://link_to_download_the_bill_600"
        }
      ],
      "AutoPayOptions": [
        {
          "Frequency": "Monthly",
          "Amount": 100.0,
          "NumberOfInstallments": 12,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19,
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30,
            31
          ]
        },
        {
          "Frequency": "Quarterly",
          "Amount": 300.0,
          "NumberOfInstallments": 6,
          "WithdrawalDates": [
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30
          ]
        },
        {
          "Frequency": "Semiannually",
          "Amount": 600.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10
          ]
        },
        {
          "Frequency": "Annually",
          "Amount": 1200.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19
          ]
        }
      ],
      "PolicyDetails": {
        "Type": "AutoPolicyDetails",
        "Drivers": [
          {
            "FirstName": "John",
            "LastName": "Smith",
            "LicenseNumber": "343434211",
            "RelationToNamedInsured": "Insured"
          },
          {
            "FirstName": "Samantha",
            "LastName": "Smith",
            "LicenseNumber": "343434213",
            "RelationToNamedInsured": "Spouse"
          }
        ],
        "Vehicles": [
          {
            "Make": "BMW",
            "Model": "M850i",
            "Year": 2018,
            "Vin": "WBACA234587960574",
            "Coverages": [
              {
                "Type": "Comprehensive",
                "LimitOrDeductible": "$1,000"
              },
              {
                "Type": "Collision",
                "LimitOrDeductible": "$500"
              }
            ]
          }
        ],
        "PolicyCoverages": [
          {
            "Type": "Bodily Injury",
            "LimitOrDeductible": "$25,000/$50,000"
          },
          {
            "Type": "Property Damage",
            "LimitOrDeductible": "$10,000"
          },
          {
            "Type": "Uninsured Motorist Bodily Injury",
            "LimitOrDeductible": "$25,000/$50,000"
          },
          {
            "Type": "Underinsured Motorist Bodily Injury",
            "LimitOrDeductible": "$25,000/$50,000"
          }
        ],
        "Properties": {
          "CustomField": "Value",
          "CustomField1": "Value1",
          "CustomField2": "Value2",
          "CustomField3": "Value3"
        }
      },
      "InstallmentPlanEngineType": 1,
      "ExternalSchedulerEndpoint": "http://localhost",
      "IsSuccessful": true,
      "ErrorMessage": ""
    },
    {
      "PolicyId": "456",
      "PolicyNumber": "AB-98765432",
      "Status": "Active",
      "Term": "Annual",
      "Type": "Homeowner",
      "Premium": 123.0,
      "DueDate": "2020-10-27T07:19:55.0281593",
      "RemainingBalance": 100.0,
      "MinimumAmountDue": 25.0,
      "OtherAmountAllowed": true,
      "ZipCode": "95648",
      "FeeContext": "PaymentWithFee",
      "AccountGroupCode": "Special",
      "Documents": [
        {
          "Id": "2000",
          "LinkToDownload": "https://link_to_download_the_document_2000"
        }
      ],
      "Bills": [
        {
          "Id": "500",
          "DocumentId": "2001",
          "Date": "2020-08-27T07:19:55.0281593",
          "Description": "Bill for [smth]",
          "Amount": 80.0,
          "LinkToDownload": "https://link_to_download_the_bill_500"
        },
        {
          "Id": "600",
          "DocumentId": "2002",
          "Date": "2020-09-27T07:19:55.0281593",
          "Description": "Bill for [smth]",
          "Amount": 20.0,
          "LinkToDownload": "https://link_to_download_the_bill_600"
        }
      ],
      "AutoPayOptions": [
        {
          "Frequency": "Monthly",
          "Amount": 100.0,
          "NumberOfInstallments": 12,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19,
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30,
            31
          ]
        },
        {
          "Frequency": "Quarterly",
          "Amount": 300.0,
          "NumberOfInstallments": 6,
          "WithdrawalDates": [
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30
          ]
        },
        {
          "Frequency": "Semiannually",
          "Amount": 600.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10
          ]
        },
        {
          "Frequency": "Annually",
          "Amount": 1200.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19
          ]
        }
      ],
      "PolicyDetails": {
        "Type": "HomePolicyDetails",
        "Deductible": 5000.0,
        "Mortgagee": "People First Mortgage",
        "LoanNumber": "1234567890",
        "AgentName": "Samuel Johnson",
        "AgentPhoneNumber": "800-234-6749",
        "Coverages": [
          {
            "Type": "Dwelling",
            "LimitOrDeductible": "$320,000"
          },
          {
            "Type": "Personal Property",
            "LimitOrDeductible": "$240,000"
          },
          {
            "Type": "Personal Liability",
            "LimitOrDeductible": "$100,000"
          },
          {
            "Type": "Medical Payments",
            "LimitOrDeductible": "$1,000"
          }
        ],
        "Properties": {
          "CustomField": "Value"
        }
      },
      "InstallmentPlanEngineType": 0,
      "IsSuccessful": true,
      "ErrorMessage": ""
    },
    {
      "PolicyId": "987",
      "PolicyNumber": "AB-98745643",
      "Status": "Active",
      "Term": "Annual",
      "Type": "Homeowner",
      "Premium": 456.0,
      "DueDate": "2020-11-06T07:19:55.0281593",
      "RemainingBalance": 789.0,
      "MinimumAmountDue": 25.0,
      "OtherAmountAllowed": true,
      "ZipCode": "95648",
      "Documents": [
        {
          "Id": "2000",
          "LinkToDownload": "https://link_to_download_the_document_2000"
        }
      ],
      "Bills": [
        {
          "Id": "500",
          "DocumentId": "2001",
          "Date": "2020-08-27T07:19:55.0281593",
          "Description": "Bill for [smth]",
          "Amount": 80.0,
          "LinkToDownload": "https://link_to_download_the_bill_500"
        },
        {
          "Id": "600",
          "DocumentId": "2002",
          "Date": "2020-09-27T07:19:55.0281593",
          "Description": "Bill for [smth]",
          "Amount": 20.0,
          "LinkToDownload": "https://link_to_download_the_bill_600"
        }
      ],
      "AutoPayOptions": [
        {
          "Frequency": "Monthly",
          "Amount": 100.0,
          "NumberOfInstallments": 12,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19,
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30,
            31
          ]
        },
        {
          "Frequency": "Quarterly",
          "Amount": 300.0,
          "NumberOfInstallments": 6,
          "WithdrawalDates": [
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30
          ]
        },
        {
          "Frequency": "Semiannually",
          "Amount": 600.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10
          ]
        },
        {
          "Frequency": "Annually",
          "Amount": 1200.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19
          ]
        }
      ],
      "PolicyDetails": {
        "Type": "OtherPolicyDetails",
        "Properties": {
          "CustomField": "Value",
          "CustomField1": "Value1",
          "CustomField2": "Value2",
          "CustomField3": "Value3"
        }
      },
      "InstallmentPlanEngineType": 1,
      "ExternalSchedulerEndpoint": "http://localhost",
      "IsSuccessful": true,
      "ErrorMessage": ""
    },
    {
      "PolicyId": "987",
      "PolicyNumber": "AB-98745643",
      "Status": "Active",
      "Term": "Annual",
      "Type": "Other",
      "Premium": 456.0,
      "DueDate": "2020-11-01T07:19:55.0281593",
      "RemainingBalance": 789.0,
      "MinimumAmountDue": 25.0,
      "OtherAmountAllowed": true,
      "ZipCode": "95648",
      "Documents": [
        {
          "Id": "2000",
          "LinkToDownload": "https://link_to_download_the_document_2000"
        }
      ],
      "Bills": [
        {
          "Id": "500",
          "DocumentId": "2001",
          "Date": "2020-08-27T07:19:55.0281593",
          "Description": "Bill for [smth]",
          "Amount": 80.0,
          "LinkToDownload": "https://link_to_download_the_bill_500"
        },
        {
          "Id": "600",
          "DocumentId": "2002",
          "Date": "2020-09-27T07:19:55.0281593",
          "Description": "Bill for [smth]",
          "Amount": 20.0,
          "LinkToDownload": "https://link_to_download_the_bill_600"
        }
      ],
      "AutoPayOptions": [
        {
          "Frequency": "Monthly",
          "Amount": 100.0,
          "NumberOfInstallments": 12,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19,
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30,
            31
          ]
        },
        {
          "Frequency": "Quarterly",
          "Amount": 300.0,
          "NumberOfInstallments": 6,
          "WithdrawalDates": [
            20,
            21,
            22,
            23,
            24,
            25,
            26,
            27,
            28,
            29,
            30
          ]
        },
        {
          "Frequency": "Semiannually",
          "Amount": 600.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10
          ]
        },
        {
          "Frequency": "Annually",
          "Amount": 1200.0,
          "NumberOfInstallments": 2,
          "WithdrawalDates": [
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19
          ]
        }
      ],
      "PolicyDetails": {
        "Type": "WorkersCompPolicyDetails",
        "Properties": {
          "CustomField": "Value",
          "CustomField1": "Value1",
          "CustomField2": "Value2",
          "CustomField3": "Value3"
        }
      },
      "InstallmentPlanEngineType": 0,
      "IsSuccessful": true,
      "ErrorMessage": ""
    }
  ],
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<GetActivePoliciesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Policy">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
  <Policies>
    <PolicyDetailsResponse>
      <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
      <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
      <AccountGroupCode>Default</AccountGroupCode>
      <AccountId i:nil="true" />
      <AutoPayOptions>
        <FrequencyDetails>
          <Amount>100</Amount>
          <Frequency>Monthly</Frequency>
          <NumberOfInstallments>12</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
            <d6p1:int>31</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>300</Amount>
          <Frequency>Quarterly</Frequency>
          <NumberOfInstallments>6</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>600</Amount>
          <Frequency>Semiannually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>1200</Amount>
          <Frequency>Annually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
      </AutoPayOptions>
      <Bills>
        <BillDetails>
          <Amount>80</Amount>
          <Date>2020-08-27T07:19:55.0281593-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2001</DocumentId>
          <Id>500</Id>
          <LinkToDownload>https://link_to_download_the_bill_500</LinkToDownload>
        </BillDetails>
        <BillDetails>
          <Amount>20</Amount>
          <Date>2020-09-27T07:19:55.0281593-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2002</DocumentId>
          <Id>600</Id>
          <LinkToDownload>https://link_to_download_the_bill_600</LinkToDownload>
        </BillDetails>
      </Bills>
      <CustomerId i:nil="true" />
      <CustomerName i:nil="true" />
      <Documents>
        <DocumentDetails>
          <Id>2000</Id>
          <LinkToDownload>https://link_to_download_the_document_2000</LinkToDownload>
          <Type i:nil="true" />
        </DocumentDetails>
      </Documents>
      <DueDate>2020-10-27T07:19:55.0281593-07:00</DueDate>
      <ExternalCustomerId i:nil="true" />
      <ExternalSchedulerEndpoint>http://localhost</ExternalSchedulerEndpoint>
      <FeeContext>PaymentWithoutFee</FeeContext>
      <InstallmentPlanEngineType>Carrier</InstallmentPlanEngineType>
      <IsAutoPayEnabled i:nil="true" />
      <MinimumAmountDue>25</MinimumAmountDue>
      <OtherAmountAllowed>true</OtherAmountAllowed>
      <PaymentsAreAllowed i:nil="true" />
      <PolicyDetails i:type="AutoPolicyDetails">
        <Properties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField</d5p1:Key>
            <d5p1:Value>Value</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField1</d5p1:Key>
            <d5p1:Value>Value1</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField2</d5p1:Key>
            <d5p1:Value>Value2</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField3</d5p1:Key>
            <d5p1:Value>Value3</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Properties>
        <Drivers>
          <Driver>
            <FirstName>John</FirstName>
            <LastName>Smith</LastName>
            <LicenseNumber>343434211</LicenseNumber>
            <RelationToNamedInsured>Insured</RelationToNamedInsured>
          </Driver>
          <Driver>
            <FirstName>Samantha</FirstName>
            <LastName>Smith</LastName>
            <LicenseNumber>343434213</LicenseNumber>
            <RelationToNamedInsured>Spouse</RelationToNamedInsured>
          </Driver>
        </Drivers>
        <PolicyCoverages>
          <Coverage>
            <LimitOrDeductible>$25,000/$50,000</LimitOrDeductible>
            <Type>Bodily Injury</Type>
          </Coverage>
          <Coverage>
            <LimitOrDeductible>$10,000</LimitOrDeductible>
            <Type>Property Damage</Type>
          </Coverage>
          <Coverage>
            <LimitOrDeductible>$25,000/$50,000</LimitOrDeductible>
            <Type>Uninsured Motorist Bodily Injury</Type>
          </Coverage>
          <Coverage>
            <LimitOrDeductible>$25,000/$50,000</LimitOrDeductible>
            <Type>Underinsured Motorist Bodily Injury</Type>
          </Coverage>
        </PolicyCoverages>
        <Vehicles>
          <Vehicle>
            <Coverages>
              <Coverage>
                <LimitOrDeductible>$1,000</LimitOrDeductible>
                <Type>Comprehensive</Type>
              </Coverage>
              <Coverage>
                <LimitOrDeductible>$500</LimitOrDeductible>
                <Type>Collision</Type>
              </Coverage>
            </Coverages>
            <Make>BMW</Make>
            <Model>M850i</Model>
            <Vin>WBACA234587960574</Vin>
            <Year>2018</Year>
          </Vehicle>
        </Vehicles>
      </PolicyDetails>
      <PolicyId>123</PolicyId>
      <PolicyNumber>AB-12345678</PolicyNumber>
      <Premium>123</Premium>
      <RemainingBalance>100</RemainingBalance>
      <Status>Active</Status>
      <Term>HalfYear</Term>
      <TokenId i:nil="true" />
      <Type>Automobile</Type>
      <ZipCode>95648</ZipCode>
    </PolicyDetailsResponse>
    <PolicyDetailsResponse>
      <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
      <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
      <AccountGroupCode>Special</AccountGroupCode>
      <AccountId i:nil="true" />
      <AutoPayOptions>
        <FrequencyDetails>
          <Amount>100</Amount>
          <Frequency>Monthly</Frequency>
          <NumberOfInstallments>12</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
            <d6p1:int>31</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>300</Amount>
          <Frequency>Quarterly</Frequency>
          <NumberOfInstallments>6</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>600</Amount>
          <Frequency>Semiannually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>1200</Amount>
          <Frequency>Annually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
      </AutoPayOptions>
      <Bills>
        <BillDetails>
          <Amount>80</Amount>
          <Date>2020-08-27T07:19:55.0281593-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2001</DocumentId>
          <Id>500</Id>
          <LinkToDownload>https://link_to_download_the_bill_500</LinkToDownload>
        </BillDetails>
        <BillDetails>
          <Amount>20</Amount>
          <Date>2020-09-27T07:19:55.0281593-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2002</DocumentId>
          <Id>600</Id>
          <LinkToDownload>https://link_to_download_the_bill_600</LinkToDownload>
        </BillDetails>
      </Bills>
      <CustomerId i:nil="true" />
      <CustomerName i:nil="true" />
      <Documents>
        <DocumentDetails>
          <Id>2000</Id>
          <LinkToDownload>https://link_to_download_the_document_2000</LinkToDownload>
          <Type i:nil="true" />
        </DocumentDetails>
      </Documents>
      <DueDate>2020-10-27T07:19:55.0281593-07:00</DueDate>
      <ExternalCustomerId i:nil="true" />
      <ExternalSchedulerEndpoint i:nil="true" />
      <FeeContext>PaymentWithFee</FeeContext>
      <InstallmentPlanEngineType>InstallmentsEngine</InstallmentPlanEngineType>
      <IsAutoPayEnabled i:nil="true" />
      <MinimumAmountDue>25</MinimumAmountDue>
      <OtherAmountAllowed>true</OtherAmountAllowed>
      <PaymentsAreAllowed i:nil="true" />
      <PolicyDetails i:type="HomePolicyDetails">
        <Properties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField</d5p1:Key>
            <d5p1:Value>Value</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Properties>
        <AgentName>Samuel Johnson</AgentName>
        <AgentPhoneNumber>800-234-6749</AgentPhoneNumber>
        <Coverages>
          <Coverage>
            <LimitOrDeductible>$320,000</LimitOrDeductible>
            <Type>Dwelling</Type>
          </Coverage>
          <Coverage>
            <LimitOrDeductible>$240,000</LimitOrDeductible>
            <Type>Personal Property</Type>
          </Coverage>
          <Coverage>
            <LimitOrDeductible>$100,000</LimitOrDeductible>
            <Type>Personal Liability</Type>
          </Coverage>
          <Coverage>
            <LimitOrDeductible>$1,000</LimitOrDeductible>
            <Type>Medical Payments</Type>
          </Coverage>
        </Coverages>
        <Deductible>5000</Deductible>
        <LoanNumber>1234567890</LoanNumber>
        <Mortgagee>People First Mortgage</Mortgagee>
      </PolicyDetails>
      <PolicyId>456</PolicyId>
      <PolicyNumber>AB-98765432</PolicyNumber>
      <Premium>123</Premium>
      <RemainingBalance>100</RemainingBalance>
      <Status>Active</Status>
      <Term>Annual</Term>
      <TokenId i:nil="true" />
      <Type>Homeowner</Type>
      <ZipCode>95648</ZipCode>
    </PolicyDetailsResponse>
    <PolicyDetailsResponse>
      <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
      <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
      <AccountGroupCode i:nil="true" />
      <AccountId i:nil="true" />
      <AutoPayOptions>
        <FrequencyDetails>
          <Amount>100</Amount>
          <Frequency>Monthly</Frequency>
          <NumberOfInstallments>12</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
            <d6p1:int>31</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>300</Amount>
          <Frequency>Quarterly</Frequency>
          <NumberOfInstallments>6</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>600</Amount>
          <Frequency>Semiannually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>1200</Amount>
          <Frequency>Annually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
      </AutoPayOptions>
      <Bills>
        <BillDetails>
          <Amount>80</Amount>
          <Date>2020-08-27T07:19:55.0281593-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2001</DocumentId>
          <Id>500</Id>
          <LinkToDownload>https://link_to_download_the_bill_500</LinkToDownload>
        </BillDetails>
        <BillDetails>
          <Amount>20</Amount>
          <Date>2020-09-27T07:19:55.0281593-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2002</DocumentId>
          <Id>600</Id>
          <LinkToDownload>https://link_to_download_the_bill_600</LinkToDownload>
        </BillDetails>
      </Bills>
      <CustomerId i:nil="true" />
      <CustomerName i:nil="true" />
      <Documents>
        <DocumentDetails>
          <Id>2000</Id>
          <LinkToDownload>https://link_to_download_the_document_2000</LinkToDownload>
          <Type i:nil="true" />
        </DocumentDetails>
      </Documents>
      <DueDate>2020-11-06T07:19:55.0281593-08:00</DueDate>
      <ExternalCustomerId i:nil="true" />
      <ExternalSchedulerEndpoint>http://localhost</ExternalSchedulerEndpoint>
      <FeeContext i:nil="true" />
      <InstallmentPlanEngineType>Carrier</InstallmentPlanEngineType>
      <IsAutoPayEnabled i:nil="true" />
      <MinimumAmountDue>25</MinimumAmountDue>
      <OtherAmountAllowed>true</OtherAmountAllowed>
      <PaymentsAreAllowed i:nil="true" />
      <PolicyDetails i:type="OtherPolicyDetails">
        <Properties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField</d5p1:Key>
            <d5p1:Value>Value</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField1</d5p1:Key>
            <d5p1:Value>Value1</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField2</d5p1:Key>
            <d5p1:Value>Value2</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField3</d5p1:Key>
            <d5p1:Value>Value3</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Properties>
      </PolicyDetails>
      <PolicyId>987</PolicyId>
      <PolicyNumber>AB-98745643</PolicyNumber>
      <Premium>456</Premium>
      <RemainingBalance>789</RemainingBalance>
      <Status>Active</Status>
      <Term>Annual</Term>
      <TokenId i:nil="true" />
      <Type>Homeowner</Type>
      <ZipCode>95648</ZipCode>
    </PolicyDetailsResponse>
    <PolicyDetailsResponse>
      <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
      <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
      <AccountGroupCode i:nil="true" />
      <AccountId i:nil="true" />
      <AutoPayOptions>
        <FrequencyDetails>
          <Amount>100</Amount>
          <Frequency>Monthly</Frequency>
          <NumberOfInstallments>12</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
            <d6p1:int>31</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>300</Amount>
          <Frequency>Quarterly</Frequency>
          <NumberOfInstallments>6</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>20</d6p1:int>
            <d6p1:int>21</d6p1:int>
            <d6p1:int>22</d6p1:int>
            <d6p1:int>23</d6p1:int>
            <d6p1:int>24</d6p1:int>
            <d6p1:int>25</d6p1:int>
            <d6p1:int>26</d6p1:int>
            <d6p1:int>27</d6p1:int>
            <d6p1:int>28</d6p1:int>
            <d6p1:int>29</d6p1:int>
            <d6p1:int>30</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>600</Amount>
          <Frequency>Semiannually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
            <d6p1:int>3</d6p1:int>
            <d6p1:int>4</d6p1:int>
            <d6p1:int>5</d6p1:int>
            <d6p1:int>6</d6p1:int>
            <d6p1:int>7</d6p1:int>
            <d6p1:int>8</d6p1:int>
            <d6p1:int>9</d6p1:int>
            <d6p1:int>10</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>1200</Amount>
          <Frequency>Annually</Frequency>
          <NumberOfInstallments>2</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>10</d6p1:int>
            <d6p1:int>11</d6p1:int>
            <d6p1:int>12</d6p1:int>
            <d6p1:int>13</d6p1:int>
            <d6p1:int>14</d6p1:int>
            <d6p1:int>15</d6p1:int>
            <d6p1:int>16</d6p1:int>
            <d6p1:int>17</d6p1:int>
            <d6p1:int>18</d6p1:int>
            <d6p1:int>19</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
      </AutoPayOptions>
      <Bills>
        <BillDetails>
          <Amount>80</Amount>
          <Date>2020-08-27T07:19:55.0281593-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2001</DocumentId>
          <Id>500</Id>
          <LinkToDownload>https://link_to_download_the_bill_500</LinkToDownload>
        </BillDetails>
        <BillDetails>
          <Amount>20</Amount>
          <Date>2020-09-27T07:19:55.0281593-07:00</Date>
          <Description>Bill for [smth]</Description>
          <DocumentId>2002</DocumentId>
          <Id>600</Id>
          <LinkToDownload>https://link_to_download_the_bill_600</LinkToDownload>
        </BillDetails>
      </Bills>
      <CustomerId i:nil="true" />
      <CustomerName i:nil="true" />
      <Documents>
        <DocumentDetails>
          <Id>2000</Id>
          <LinkToDownload>https://link_to_download_the_document_2000</LinkToDownload>
          <Type i:nil="true" />
        </DocumentDetails>
      </Documents>
      <DueDate>2020-11-01T07:19:55.0281593-08:00</DueDate>
      <ExternalCustomerId i:nil="true" />
      <ExternalSchedulerEndpoint i:nil="true" />
      <FeeContext i:nil="true" />
      <InstallmentPlanEngineType>InstallmentsEngine</InstallmentPlanEngineType>
      <IsAutoPayEnabled i:nil="true" />
      <MinimumAmountDue>25</MinimumAmountDue>
      <OtherAmountAllowed>true</OtherAmountAllowed>
      <PaymentsAreAllowed i:nil="true" />
      <PolicyDetails i:type="WorkersCompPolicyDetails">
        <Properties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField</d5p1:Key>
            <d5p1:Value>Value</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField1</d5p1:Key>
            <d5p1:Value>Value1</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField2</d5p1:Key>
            <d5p1:Value>Value2</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>CustomField3</d5p1:Key>
            <d5p1:Value>Value3</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Properties>
      </PolicyDetails>
      <PolicyId>987</PolicyId>
      <PolicyNumber>AB-98745643</PolicyNumber>
      <Premium>456</Premium>
      <RemainingBalance>789</RemainingBalance>
      <Status>Active</Status>
      <Term>Annual</Term>
      <TokenId i:nil="true" />
      <Type>Other</Type>
      <ZipCode>95648</ZipCode>
    </PolicyDetailsResponse>
  </Policies>
</GetActivePoliciesResponse>

POST accounts/search

This method is used for searching accounts

MethodEndpoint
Search https://stgportalone.processonepayments.com/ExternalApi/accounts/search

SearchRequest

NameDescriptionTypeRequired*Additional information
Limit

Maximum number of records in result

integer Yes
Offset

How many records to skip in result

integer Yes
SortBy

Defines sorting order. Only one column sorting is supported

string Yes
SearchParameters

Collection of Key/Value search parameters. Available parameters are configurable by merchant. For example a merchant can configure the portal to send "policyNumber", "accountNumber", "insuredName" fields as search parameters.

Dictionary of string and string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "Limit": 25,
  "Offset": 0,
  "SortBy": "policyNumber:asc",
  "SearchParameters": {
    "accountId": "B55BA07A-94EF-49AF-9B2D-669812C8F070"
  }
}
                                
                                 <SearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Search">
  <Limit>25</Limit>
  <Offset>0</Offset>
  <SearchParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>accountId</d2p1:Key>
      <d2p1:Value>B55BA07A-94EF-49AF-9B2D-669812C8F070</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </SearchParameters>
  <SortBy>policyNumber:asc</SortBy>
</SearchRequest>

Response Information

AccountSearchResponse

NameDescriptionTypeRequired*Additional information
Results

List of accounts matching the search criteria

Collection of AccountSearchResult Yes
TotalCount

Total number of results

integer Yes
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "Results": [
    {
      "CustomerId": "49437EE0-9C1D-483A-99C3-3C3197FEF8C2",
      "AccountId": "12345",
      "Properties": {
        "policyNumber": "AB-123-456",
        "customerName": "John Smith",
        "accountNumber": "B55BA07A-94EF-49AF-9B2D-669812C8F070"
      }
    },
    {
      "CustomerId": "4D82B38F-1521-4DEE-B811-A3596B21755B",
      "AccountId": "56789",
      "Properties": {
        "policyNumber": "AB-456-789",
        "customerName": "Jane Doe",
        "accountNumber": "B55BA07A-94EF-49AF-9B2D-669812C8F070"
      }
    }
  ],
  "TotalCount": 0,
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<AccountSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Search">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
  <Results>
    <AccountSearchResult>
      <AccountId>12345</AccountId>
      <CustomerId>49437EE0-9C1D-483A-99C3-3C3197FEF8C2</CustomerId>
      <Properties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>policyNumber</d4p1:Key>
          <d4p1:Value>AB-123-456</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>customerName</d4p1:Key>
          <d4p1:Value>John Smith</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>accountNumber</d4p1:Key>
          <d4p1:Value>B55BA07A-94EF-49AF-9B2D-669812C8F070</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Properties>
    </AccountSearchResult>
    <AccountSearchResult>
      <AccountId>56789</AccountId>
      <CustomerId>4D82B38F-1521-4DEE-B811-A3596B21755B</CustomerId>
      <Properties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>policyNumber</d4p1:Key>
          <d4p1:Value>AB-456-789</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>customerName</d4p1:Key>
          <d4p1:Value>Jane Doe</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>accountNumber</d4p1:Key>
          <d4p1:Value>B55BA07A-94EF-49AF-9B2D-669812C8F070</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Properties>
    </AccountSearchResult>
  </Results>
  <TotalCount>0</TotalCount>
</AccountSearchResponse>

POST accounts/{accountId}/getUserDetails

This method is used to get the user details.

MethodEndpoint
GetUserDetails https://stgportalone.processonepayments.com/ExternalApi/accounts/{accountId}/getUserDetails

URI Parameters

NameDescriptionTypeRequired*Additional information
accountId

Account Id

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 
                                
                                 {
  "AccountId": "sample string 1"
}
                                
                                 <GetUserDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <AccountId>sample string 1</AccountId>
</GetUserDetailsRequest>

Response Information

GetUserDetailsResponse

NameDescriptionTypeRequired*Additional information
AccountId

Gets or sets Customer's Account Id

string No
CustomerId

Gets or sets Customer Id

string No
FirstName

Gets or sets Customer's First Name

string No
LastName

Gets or sets Customer's Last Name

string No
Roles

Gets or sets Customer's User Roles List

Collection of string No
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "AccountId": "sample string 1",
  "CustomerId": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "Roles": [
    "sample string 1",
    "sample string 2"
  ],
  "IsSuccessful": true,
  "ErrorMessage": "sample string 6"
}
<GetUserDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">sample string 6</ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
  <AccountId>sample string 1</AccountId>
  <CustomerId>sample string 2</CustomerId>
  <FirstName>sample string 3</FirstName>
  <LastName>sample string 4</LastName>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Roles>
</GetUserDetailsResponse>

POST accounts/submitPayments?url={url}&portalOneAuthKey={portalOneAuthKey}

This method is used for submit payment acknowledge

MethodEndpoint
SubmitPaymentsAcknowledge https://stgportalone.processonepayments.com/ExternalApi/accounts/submitPayments?url={url}&portalOneAuthKey={portalOneAuthKey}

URI Parameters

NameDescriptionTypeRequired*Additional information
url

string Yes
portalOneAuthKey

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 

Response Information

SubmitPaymentsAcknowledgeResponse

NameDescriptionTypeRequired*Additional information
IsAcknowledgeDelivered

Indicate if Acknowledge is delivered.

boolean No
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "IsAcknowledgeDelivered": true,
  "IsSuccessful": true,
  "ErrorMessage": "sample string 3"
}
<SubmitPaymentsAcknowledgeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Account">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">sample string 3</ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
  <IsAcknowledgeDelivered>true</IsAcknowledgeDelivered>
</SubmitPaymentsAcknowledgeResponse>

Notification

This section describes the APIs sent to notify Customers of Payment Acknowledgements.

POST notifications/acknowledgePayments

Acknowledgement Payment API will be used to notify the source system when a Quick Pay Payment is successfully processed. This API can be used for single/ multiple Payment Acknowledgements at a time. This is the preferred API for clients to implement as it caters to multiple feature families. Acknowledgement via this endpoint can be controlled via settings in Portal One.

MethodEndpoint
AcknowledgePayments https://stgportalone.processonepayments.com/ExternalApi/notifications/acknowledgePayments

AcknowledgePaymentsRequest

NameDescriptionTypeRequired*Additional information
SubmitPaymentAcknowledgeRequests

Payment acknowledgement request models.

Collection of AcknowledgePaymentDetails Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "SubmitPaymentAcknowledgeRequests": [
    {
      "CustomerId": "sample string 1",
      "ExternalCustomerId": "sample string 2",
      "AccountId": "sample string 3",
      "CustomerName": "sample string 4",
      "AuthCode": "sample string 5",
      "TokenId": "sample string 6",
      "BatchNumber": 1,
      "TransactionId": "sample string 7",
      "SessionId": "sample string 8",
      "PaymentAmount": 1.0,
      "Timezone": "sample string 9",
      "TransactionDate": "2020-10-27T07:19:57",
      "OutboundApiKey": "sample string 10",
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "ExtendedParameters": {
        "sample string 1": {},
        "sample string 3": {}
      }
    },
    {
      "CustomerId": "sample string 1",
      "ExternalCustomerId": "sample string 2",
      "AccountId": "sample string 3",
      "CustomerName": "sample string 4",
      "AuthCode": "sample string 5",
      "TokenId": "sample string 6",
      "BatchNumber": 1,
      "TransactionId": "sample string 7",
      "SessionId": "sample string 8",
      "PaymentAmount": 1.0,
      "Timezone": "sample string 9",
      "TransactionDate": "2020-10-27T07:19:57",
      "OutboundApiKey": "sample string 10",
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "ExtendedParameters": {
        "sample string 1": {},
        "sample string 3": {}
      }
    }
  ]
}
                                
                                 <AcknowledgePaymentsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Payment">
  <SubmitPaymentAcknowledgeRequests>
    <AcknowledgePaymentDetails>
      <AccountId>sample string 3</AccountId>
      <AuthCode>sample string 5</AuthCode>
      <BatchNumber>1</BatchNumber>
      <ClientReferenceData>
        <ClientReferenceData1>sample string 1</ClientReferenceData1>
        <ClientReferenceData2>sample string 2</ClientReferenceData2>
        <ClientReferenceData3>sample string 3</ClientReferenceData3>
        <ClientReferenceData4>sample string 4</ClientReferenceData4>
        <ClientReferenceData5>sample string 5</ClientReferenceData5>
      </ClientReferenceData>
      <CustomerId>sample string 1</CustomerId>
      <CustomerName>sample string 4</CustomerName>
      <ExtendedParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </ExtendedParameters>
      <ExternalCustomerId>sample string 2</ExternalCustomerId>
      <OutboundApiKey>sample string 10</OutboundApiKey>
      <PaymentAmount>1</PaymentAmount>
      <PaymentMethod i:nil="true" />
      <SessionId>sample string 8</SessionId>
      <Timezone>sample string 9</Timezone>
      <TokenId>sample string 6</TokenId>
      <TransactionDate>2020-10-27T07:19:57.2665373-07:00</TransactionDate>
      <TransactionId>sample string 7</TransactionId>
    </AcknowledgePaymentDetails>
    <AcknowledgePaymentDetails>
      <AccountId>sample string 3</AccountId>
      <AuthCode>sample string 5</AuthCode>
      <BatchNumber>1</BatchNumber>
      <ClientReferenceData>
        <ClientReferenceData1>sample string 1</ClientReferenceData1>
        <ClientReferenceData2>sample string 2</ClientReferenceData2>
        <ClientReferenceData3>sample string 3</ClientReferenceData3>
        <ClientReferenceData4>sample string 4</ClientReferenceData4>
        <ClientReferenceData5>sample string 5</ClientReferenceData5>
      </ClientReferenceData>
      <CustomerId>sample string 1</CustomerId>
      <CustomerName>sample string 4</CustomerName>
      <ExtendedParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </ExtendedParameters>
      <ExternalCustomerId>sample string 2</ExternalCustomerId>
      <OutboundApiKey>sample string 10</OutboundApiKey>
      <PaymentAmount>1</PaymentAmount>
      <PaymentMethod i:nil="true" />
      <SessionId>sample string 8</SessionId>
      <Timezone>sample string 9</Timezone>
      <TokenId>sample string 6</TokenId>
      <TransactionDate>2020-10-27T07:19:57.2665373-07:00</TransactionDate>
      <TransactionId>sample string 7</TransactionId>
    </AcknowledgePaymentDetails>
  </SubmitPaymentAcknowledgeRequests>
</AcknowledgePaymentsRequest>

Response Information

AcknowledgePaymentsResponse

NameDescriptionTypeRequired*Additional information
IsSuccessful

Is Successful

boolean Yes
ErrorMessage

Error Message

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "IsSuccessful": true,
  "ErrorMessage": ""
}
<AcknowledgePaymentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Payment">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts"></ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
</AcknowledgePaymentsResponse>

POST notifications/acknowledgePaymentMethods

This method is used to notify the source system that payment method has been submitted. This Payment Acknowledgement is specifically used for IVR in the case when the Policy System originates Payment transactions via IVR and cannot consume Payment Postbacks.

MethodEndpoint
AcknowledgePaymentMethods https://stgportalone.processonepayments.com/ExternalApi/notifications/acknowledgePaymentMethods

AcknowledgePaymentMethodsRequest

NameDescriptionTypeRequired*Additional information
SubmitPaymentMethodsDetails

Payment method acknowledgement details models

Collection of SubmitPaymentMethodsDetails No
ExtendedParameters

Extended parameters

Dictionary of string and object No

* If field is not required, it can be omitted. Please do not send Null or invalid values.