User

User Operations

GET users/{accountId}

This method is used to get User Details information

URI Parameters

NameDescriptionTypeAdditional information
accountId

Account Id

string

Required

None.

Response Information

UserDetailsResponse

NameDescriptionTypeAdditional information
AccountId

Account Id

string

Required

FirstName

First Name

string
LastName

Last Name

string
CustomerId

One Inc Customer Id

string

Required

Roles

Roles collection assigned to the current user

Collection of string

Required

IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

String

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>

Account

Account Operations

GET accounts/{accountId}

This method is used to get Account Details information

URI Parameters

NameDescriptionTypeAdditional information
accountId

Account Id

string

Required

None.

Response Information

AccountDetailsResponse

NameDescriptionTypeAdditional information
AccountId

Gets or sets Customer's Account Id

string

Required

FirstName

Gets or sets Customer's First Name

string
LastName

Gets or sets Customer's Last Name

string
AgentLink

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

string
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
Phones

Account phones collection

Collection of Phone
Email

Gets or sets Customer's Email address

string
Addresses

Gets or sets Customer's Address

Collection of Address
IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

Phone

NameDescriptionTypeAdditional information
Type

Phone Type

string

Required

Number

Phone Number

string

Required

Extension

Extension

string
IsPreferredPhoneNumber

Indicates whether to use this phone as a primary contact

boolean

Required

Address

NameDescriptionTypeAdditional information
StreetAddress

Street Address

string

Required

City

City

string

Required

State

State

string

Required

ZipCode

Zip Code

string

Required

Country

Country

string

Required

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"
    }
  ],
  "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>
  <TimeZone>US/Pacific</TimeZone>
</AccountDetailsResponse>

POST accounts/signUpForTexts

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

SignUpForTextsRequest

NameDescriptionTypeAdditional information
AccountId

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

string
CustomerId

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

string
PhoneNumber

Phone Number

string

Required

IsSubscribedForTexts

Is subscribed for Texts

boolean

Required

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

NameDescriptionTypeAdditional information
IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

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>

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.

SignUpForEmailsRequest

NameDescriptionTypeAdditional information
AccountId

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

string
CustomerId

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

string
Email

Email

string

Required

IsSubscribedForEmails

Is subscribed for Emails

boolean

Required

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

NameDescriptionTypeAdditional information
IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

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.

SignUpForPhoneCallsRequest

NameDescriptionTypeAdditional information
AccountId

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

string
CustomerId

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

string
PhoneNumber

Phone Number

string

Required

IsSubscribedForPhoneCalls

Is subscribed for Phone Calls

boolean

Required

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

NameDescriptionTypeAdditional information
IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

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>

POST accounts/{accountId}/paymentMethods

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

URI Parameters

NameDescriptionTypeAdditional information
accountId

Account Id

string

Required

UpdatePaymentMethodRequest

NameDescriptionTypeAdditional information
AccountId

Account Id to modify (for scenarios when privileged user makes changes on behalf of the Customer

string

Required

Actions

Action(s) to be done with the payment method(s)

Collection of UpdatePaymentMethodAction

UpdatePaymentMethodAction

NameDescriptionTypeAdditional information
PaymentMethodToken

Payment Method Token

string

Required

Action

Action. Available Options: Created, Deleted, SetDefault, UnsetDefault

string

Required

Request Formats

 
{
  "Actions": [
    {
      "PaymentMethodToken": "7fa1fc26-3b45-4849-9ce7-ff450c17df28",
      "Action": "Created"
    },
    {
      "PaymentMethodToken": "b68862ea-7bb4-42d3-93fb-edfa766c748d",
      "Action": "Deleted"
    },
    {
      "PaymentMethodToken": "e9cc00a8-d91c-4bb8-8183-edfb23c574d5",
      "Action": "SetDefault"
    },
    {
      "PaymentMethodToken": "54159bce-06bd-4a38-ba09-3e187db1e730",
      "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>7fa1fc26-3b45-4849-9ce7-ff450c17df28</PaymentMethodToken>
    </UpdatePaymentMethodAction>
    <UpdatePaymentMethodAction>
      <Action>Deleted</Action>
      <PaymentMethodToken>b68862ea-7bb4-42d3-93fb-edfa766c748d</PaymentMethodToken>
    </UpdatePaymentMethodAction>
    <UpdatePaymentMethodAction>
      <Action>SetDefault</Action>
      <PaymentMethodToken>e9cc00a8-d91c-4bb8-8183-edfb23c574d5</PaymentMethodToken>
    </UpdatePaymentMethodAction>
    <UpdatePaymentMethodAction>
      <Action>UnsetDefault</Action>
      <PaymentMethodToken>54159bce-06bd-4a38-ba09-3e187db1e730</PaymentMethodToken>
    </UpdatePaymentMethodAction>
  </Actions>
</UpdatePaymentMethodRequest>

Response Information

UpdatePaymentMethodResponse

NameDescriptionTypeAdditional information
IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

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

URI Parameters

NameDescriptionTypeAdditional information
accountId

Account Id

string

Required

None.

Response Information

GetActivePoliciesResponse

NameDescriptionTypeAdditional information
Policies

Collection of Policies

Collection of PolicyDetailsResponse

Required

IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

PolicyDetailsResponse

NameDescriptionTypeAdditional information
PolicyId

Policy Identifier

string

Required

PolicyNumber

Policy Number

string

Required

CustomerId

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

string
ExternalCustomerId

External generated ID of Customer

string
CustomerName

Name of the customer

string
AccountId

Account Identifier

string
Status

Policy Status

string
Term

Policy Term

string
Type

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

string
Premium

Policy Premium

decimal number
DueDate

Policy Due Date

date
RemainingBalance

Remaining Balance

decimal number
MinimumAmountDue

Minimum Amount Due

decimal number

Required

OtherAmountAllowed

Other Amount Allowed

boolean

Required

PaymentsAreAllowed

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

boolean
IsAutoPayEnabled

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

boolean
ZipCode

Policy Zip Code

string
FeeContext

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

string
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
Documents

Collection of policy documents (Proof of insurance document details)

Collection of DocumentDetails
Bills

Collection of policy bills

Collection of BillDetails
AutoPayOptions

Collection of possible recurring payment options

Collection of FrequencyDetails
PolicyDetails

PolicyDetails

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

Required

IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

DocumentDetails

NameDescriptionTypeAdditional information
Id

Document Id

string

Required

Type

Document Type (e.g. ProofOfInsurance)

string

Required

LinkToDownload

LinkToDownload to download the document (proof of insurance)

string

BillDetails

NameDescriptionTypeAdditional information
Id

Bill Id

string

Required

DocumentId

Document Id

string
Date

Date

date
Description

Description

string

Required

Amount

Amount

decimal number
LinkToDownload

Link to download the bill

string

FrequencyDetails

NameDescriptionTypeAdditional information
Frequency

Frequency type: Monthly, Quarterly, Semiannually, Annually

string

Required

Amount

Payment amount for each installment

decimal number

Required

NumberOfInstallments

Number of total installments

integer

Required

WithdrawalDates

Available dates fo withdrawal

Collection of integer

Required

Int32

PolicyDetailsBase

NameDescriptionTypeAdditional information
Type

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

string

Required

Properties

Generic Key/Value Property list

Dictionary of string and string

Required

AutoPolicyDetails

NameDescriptionTypeAdditional information
Drivers

Drivers collection

Collection of Driver
Vehicles

Vehicles collection

Collection of Vehicle
PolicyCoverages

Policy Coverages

Collection of Coverage
Type

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

string

Required

Properties

Generic Key/Value Property list

Dictionary of string and string

Required

Driver

NameDescriptionTypeAdditional information
FirstName

First Name

string

Required

LastName

LastName

string

Required

LicenseNumber

License Number

string

Required

RelationToNamedInsured

Relation To Named Insured

string

Vehicle

NameDescriptionTypeAdditional information
Make

Make

string

Required

Model

Model

string

Required

Year

Year

integer

Required

Vin

Vin

string

Required

Coverages

Coverages

Collection of Coverage

Coverage

NameDescriptionTypeAdditional information
Type

Type

string

Required

LimitOrDeductible

Limit And/Or Deductible

string

Required

HomePolicyDetails

NameDescriptionTypeAdditional information
Deductible

Deductible

decimal number
Mortgagee

Mortgagee

string
LoanNumber

Loan Number

string
AgentName

Agent Name

string
AgentPhoneNumber

Agent Phone Number

string
Coverages

Coverages

Collection of Coverage
Type

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

string

Required

Properties

Generic Key/Value Property list

Dictionary of string and string

Required

OtherPolicyDetails

NameDescriptionTypeAdditional information
Type

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

string

Required

Properties

Generic Key/Value Property list

Dictionary of string and string

Required

WorkersCompPolicyDetails

NameDescriptionTypeAdditional information
Type

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

string

Required

Properties

Generic Key/Value Property list

Dictionary of string and string

Required

Response Formats

{
  "Policies": [
    {
      "PolicyId": "123",
      "PolicyNumber": "AB-12345678",
      "CustomerId": null,
      "ExternalCustomerId": null,
      "CustomerName": null,
      "AccountId": null,
      "Status": "Active",
      "Term": "HalfYear",
      "Type": "Automobile",
      "Premium": 123.0,
      "DueDate": "2020-08-09T21:23:16.736101",
      "RemainingBalance": 100.0,
      "MinimumAmountDue": 25.0,
      "OtherAmountAllowed": true,
      "PaymentsAreAllowed": null,
      "IsAutoPayEnabled": null,
      "ZipCode": "95648",
      "FeeContext": "PaymentWithoutFee",
      "AccountGroupCode": "Default",
      "Documents": [
        {
          "Id": "2000",
          "Type": null,
          "LinkToDownload": "https://link_to_download_the_document_2000"
        }
      ],
      "Bills": [
        {
          "Id": "500",
          "DocumentId": "2001",
          "Date": "2020-06-09T21:23:16.736101",
          "Description": "Bill for [smth]",
          "Amount": 80.0,
          "LinkToDownload": "https://link_to_download_the_bill_500"
        },
        {
          "Id": "600",
          "DocumentId": "2002",
          "Date": "2020-07-09T21:23:16.736101",
          "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"
        }
      },
      "IsSuccessful": true,
      "ErrorMessage": ""
    },
    {
      "PolicyId": "456",
      "PolicyNumber": "AB-98765432",
      "CustomerId": null,
      "ExternalCustomerId": null,
      "CustomerName": null,
      "AccountId": null,
      "Status": "Active",
      "Term": "Annual",
      "Type": "Homeowner",
      "Premium": 123.0,
      "DueDate": "2020-08-09T21:23:16.736101",
      "RemainingBalance": 100.0,
      "MinimumAmountDue": 25.0,
      "OtherAmountAllowed": true,
      "PaymentsAreAllowed": null,
      "IsAutoPayEnabled": null,
      "ZipCode": "95648",
      "FeeContext": "PaymentWithFee",
      "AccountGroupCode": "Special",
      "Documents": [
        {
          "Id": "2000",
          "Type": null,
          "LinkToDownload": "https://link_to_download_the_document_2000"
        }
      ],
      "Bills": [
        {
          "Id": "500",
          "DocumentId": "2001",
          "Date": "2020-06-09T21:23:16.736101",
          "Description": "Bill for [smth]",
          "Amount": 80.0,
          "LinkToDownload": "https://link_to_download_the_bill_500"
        },
        {
          "Id": "600",
          "DocumentId": "2002",
          "Date": "2020-07-09T21:23:16.736101",
          "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"
        }
      },
      "IsSuccessful": true,
      "ErrorMessage": ""
    },
    {
      "PolicyId": "987",
      "PolicyNumber": "AB-98745643",
      "CustomerId": null,
      "ExternalCustomerId": null,
      "CustomerName": null,
      "AccountId": null,
      "Status": "Active",
      "Term": "Annual",
      "Type": "Homeowner",
      "Premium": 456.0,
      "DueDate": "2020-08-19T21:23:16.736101",
      "RemainingBalance": 789.0,
      "MinimumAmountDue": 25.0,
      "OtherAmountAllowed": true,
      "PaymentsAreAllowed": null,
      "IsAutoPayEnabled": null,
      "ZipCode": "95648",
      "FeeContext": null,
      "AccountGroupCode": null,
      "Documents": [
        {
          "Id": "2000",
          "Type": null,
          "LinkToDownload": "https://link_to_download_the_document_2000"
        }
      ],
      "Bills": [
        {
          "Id": "500",
          "DocumentId": "2001",
          "Date": "2020-06-09T21:23:16.736101",
          "Description": "Bill for [smth]",
          "Amount": 80.0,
          "LinkToDownload": "https://link_to_download_the_bill_500"
        },
        {
          "Id": "600",
          "DocumentId": "2002",
          "Date": "2020-07-09T21:23:16.736101",
          "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"
        }
      },
      "IsSuccessful": true,
      "ErrorMessage": ""
    },
    {
      "PolicyId": "987",
      "PolicyNumber": "AB-98745643",
      "CustomerId": null,
      "ExternalCustomerId": null,
      "CustomerName": null,
      "AccountId": null,
      "Status": "Active",
      "Term": "Annual",
      "Type": "Other",
      "Premium": 456.0,
      "DueDate": "2020-08-14T21:23:16.736101",
      "RemainingBalance": 789.0,
      "MinimumAmountDue": 25.0,
      "OtherAmountAllowed": true,
      "PaymentsAreAllowed": null,
      "IsAutoPayEnabled": null,
      "ZipCode": "95648",
      "FeeContext": null,
      "AccountGroupCode": null,
      "Documents": [
        {
          "Id": "2000",
          "Type": null,
          "LinkToDownload": "https://link_to_download_the_document_2000"
        }
      ],
      "Bills": [
        {
          "Id": "500",
          "DocumentId": "2001",
          "Date": "2020-06-09T21:23:16.736101",
          "Description": "Bill for [smth]",
          "Amount": 80.0,
          "LinkToDownload": "https://link_to_download_the_bill_500"
        },
        {
          "Id": "600",
          "DocumentId": "2002",
          "Date": "2020-07-09T21:23:16.736101",
          "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"
        }
      },
      "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-06-09T21:23:16.736101-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-07-09T21:23:16.736101-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-08-09T21:23:16.736101-07:00</DueDate>
      <ExternalCustomerId i:nil="true" />
      <FeeContext>PaymentWithoutFee</FeeContext>
      <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>
      <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-06-09T21:23:16.736101-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-07-09T21:23:16.736101-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-08-09T21:23:16.736101-07:00</DueDate>
      <ExternalCustomerId i:nil="true" />
      <FeeContext>PaymentWithFee</FeeContext>
      <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>
      <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-06-09T21:23:16.736101-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-07-09T21:23:16.736101-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-08-19T21:23:16.736101-07:00</DueDate>
      <ExternalCustomerId i:nil="true" />
      <FeeContext i:nil="true" />
      <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>
      <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-06-09T21:23:16.736101-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-07-09T21:23:16.736101-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-08-14T21:23:16.736101-07:00</DueDate>
      <ExternalCustomerId i:nil="true" />
      <FeeContext i:nil="true" />
      <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>
      <Type>Other</Type>
      <ZipCode>95648</ZipCode>
    </PolicyDetailsResponse>
  </Policies>
</GetActivePoliciesResponse>

GET accounts/{accountId}/subscriptions

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

URI Parameters

NameDescriptionTypeAdditional information
accountId

Account Id

string

Required

None.

Response Information

AccountSubscriptionDetailsResponse

NameDescriptionTypeAdditional information
Subscriptions

Collection of SubscriptionDetail
IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

SubscriptionDetail

NameDescriptionTypeAdditional information
Type

Subscription type

SubscriptionType
Status

Subscription status

SubscriptionStatus
Target

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

string

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

SearchRequest

NameDescriptionTypeAdditional information
Limit

Maximum number of records in result

integer

Required

Offset

How many records to skip in result

integer

Required

SortBy

Defines sorting order. Only one column sorting is supported

string

Required

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

Required

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

NameDescriptionTypeAdditional information
Results

List of accounts matching the search criteria

Collection of AccountSearchResult

Required

TotalCount

Total number of results

integer

Required

IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

AccountSearchResult

NameDescriptionTypeAdditional information
CustomerId

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

string

Required

AccountId

Account Identifier

string

Required

Properties

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

Dictionary of string and string

Required

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>

Policy

Policy Operations.

GET policies/{policyId}

This method is used to get Policy Details information

URI Parameters

NameDescriptionTypeAdditional information
policyId

Policy Id

string

Required

None.

Response Information

PolicyDetailsResponse

NameDescriptionTypeAdditional information
PolicyId

Policy Identifier

string

Required

PolicyNumber

Policy Number

string

Required

CustomerId

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

string
ExternalCustomerId

External generated ID of Customer

string
CustomerName

Name of the customer

string
AccountId

Account Identifier

string
Status

Policy Status

string
Term

Policy Term

string
Type

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

string
Premium

Policy Premium

decimal number
DueDate

Policy Due Date

date
RemainingBalance

Remaining Balance

decimal number
MinimumAmountDue

Minimum Amount Due

decimal number

Required

OtherAmountAllowed

Other Amount Allowed

boolean

Required

PaymentsAreAllowed

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

boolean
IsAutoPayEnabled

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

boolean
ZipCode

Policy Zip Code

string
FeeContext

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

string
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
Documents

Collection of policy documents (Proof of insurance document details)

Collection of DocumentDetails
Bills

Collection of policy bills

Collection of BillDetails
AutoPayOptions

Collection of possible recurring payment options

Collection of FrequencyDetails
PolicyDetails

PolicyDetails

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

Required

IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

Response Formats

{
  "PolicyId": "123",
  "PolicyNumber": "AB-12345678",
  "CustomerId": null,
  "ExternalCustomerId": null,
  "CustomerName": null,
  "AccountId": null,
  "Status": "Active",
  "Term": "HalfYear",
  "Type": "Automobile",
  "Premium": 123.0,
  "DueDate": "2020-08-09T21:23:17.3767292",
  "RemainingBalance": 100.0,
  "MinimumAmountDue": 25.0,
  "OtherAmountAllowed": true,
  "PaymentsAreAllowed": null,
  "IsAutoPayEnabled": null,
  "ZipCode": "95648",
  "FeeContext": "PaymentWithoutFee",
  "AccountGroupCode": "Default",
  "Documents": [
    {
      "Id": "2000",
      "Type": null,
      "LinkToDownload": "https://link_to_download_the_document_2000"
    }
  ],
  "Bills": [
    {
      "Id": "500",
      "DocumentId": "2001",
      "Date": "2020-06-09T21:23:17.3767292",
      "Description": "Bill for [smth]",
      "Amount": 80.0,
      "LinkToDownload": "https://link_to_download_the_bill_500"
    },
    {
      "Id": "600",
      "DocumentId": "2002",
      "Date": "2020-07-09T21:23:17.3767292",
      "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"
    }
  },
  "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-06-09T21:23:17.3767292-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-07-09T21:23:17.3767292-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-08-09T21:23:17.3767292-07:00</DueDate>
  <ExternalCustomerId i:nil="true" />
  <FeeContext>PaymentWithoutFee</FeeContext>
  <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>
  <Type>Automobile</Type>
  <ZipCode>95648</ZipCode>
</PolicyDetailsResponse>

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

Download Policy document

URI Parameters

NameDescriptionTypeAdditional information
policyId

Policy Id

string

Required

documentId

Document Id

string

Required

None.

Response Information

FileStreamResponse

NameDescriptionTypeAdditional information
Content

File stream

Collection of byte

Required

Byte

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

SearchRequest

NameDescriptionTypeAdditional information
Limit

Maximum number of records in result

integer

Required

Offset

How many records to skip in result

integer

Required

SortBy

Defines sorting order. Only one column sorting is supported

string

Required

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

Required

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

NameDescriptionTypeAdditional information
Results

List of policies matching the search criteria

Collection of PolicyDetailsResponse

Required

TotalCount

Total number of results

integer

Required

IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

Response Formats

{
  "Results": [
    {
      "PolicyId": "sample string 1",
      "PolicyNumber": "sample string 2",
      "CustomerId": "sample string 3",
      "ExternalCustomerId": "sample string 4",
      "CustomerName": "sample string 5",
      "AccountId": "sample string 6",
      "Status": "sample string 7",
      "Term": "sample string 8",
      "Type": "sample string 9",
      "Premium": 10.0,
      "DueDate": "2020-08-09T21:23:17",
      "RemainingBalance": 12.0,
      "MinimumAmountDue": 13.0,
      "OtherAmountAllowed": true,
      "PaymentsAreAllowed": true,
      "IsAutoPayEnabled": true,
      "ZipCode": "sample string 15",
      "FeeContext": "sample string 16",
      "AccountGroupCode": "sample string 17",
      "Documents": [
        {
          "Id": "sample string 1",
          "Type": "sample string 2",
          "LinkToDownload": "sample string 3"
        },
        {
          "Id": "sample string 1",
          "Type": "sample string 2",
          "LinkToDownload": "sample string 3"
        }
      ],
      "Bills": [
        {
          "Id": "sample string 1",
          "DocumentId": "sample string 2",
          "Date": "2020-08-09T21:23:17",
          "Description": "sample string 4",
          "Amount": 5.0,
          "LinkToDownload": "sample string 6"
        },
        {
          "Id": "sample string 1",
          "DocumentId": "sample string 2",
          "Date": "2020-08-09T21:23:17",
          "Description": "sample string 4",
          "Amount": 5.0,
          "LinkToDownload": "sample string 6"
        }
      ],
      "AutoPayOptions": [
        {
          "Frequency": "sample string 1",
          "Amount": 2.0,
          "NumberOfInstallments": 3,
          "WithdrawalDates": [
            1,
            2
          ]
        },
        {
          "Frequency": "sample string 1",
          "Amount": 2.0,
          "NumberOfInstallments": 3,
          "WithdrawalDates": [
            1,
            2
          ]
        }
      ],
      "PolicyDetails": null,
      "IsSuccessful": true,
      "ErrorMessage": "sample string 19"
    },
    {
      "PolicyId": "sample string 1",
      "PolicyNumber": "sample string 2",
      "CustomerId": "sample string 3",
      "ExternalCustomerId": "sample string 4",
      "CustomerName": "sample string 5",
      "AccountId": "sample string 6",
      "Status": "sample string 7",
      "Term": "sample string 8",
      "Type": "sample string 9",
      "Premium": 10.0,
      "DueDate": "2020-08-09T21:23:17",
      "RemainingBalance": 12.0,
      "MinimumAmountDue": 13.0,
      "OtherAmountAllowed": true,
      "PaymentsAreAllowed": true,
      "IsAutoPayEnabled": true,
      "ZipCode": "sample string 15",
      "FeeContext": "sample string 16",
      "AccountGroupCode": "sample string 17",
      "Documents": [
        {
          "Id": "sample string 1",
          "Type": "sample string 2",
          "LinkToDownload": "sample string 3"
        },
        {
          "Id": "sample string 1",
          "Type": "sample string 2",
          "LinkToDownload": "sample string 3"
        }
      ],
      "Bills": [
        {
          "Id": "sample string 1",
          "DocumentId": "sample string 2",
          "Date": "2020-08-09T21:23:17",
          "Description": "sample string 4",
          "Amount": 5.0,
          "LinkToDownload": "sample string 6"
        },
        {
          "Id": "sample string 1",
          "DocumentId": "sample string 2",
          "Date": "2020-08-09T21:23:17",
          "Description": "sample string 4",
          "Amount": 5.0,
          "LinkToDownload": "sample string 6"
        }
      ],
      "AutoPayOptions": [
        {
          "Frequency": "sample string 1",
          "Amount": 2.0,
          "NumberOfInstallments": 3,
          "WithdrawalDates": [
            1,
            2
          ]
        },
        {
          "Frequency": "sample string 1",
          "Amount": 2.0,
          "NumberOfInstallments": 3,
          "WithdrawalDates": [
            1,
            2
          ]
        }
      ],
      "PolicyDetails": null,
      "IsSuccessful": true,
      "ErrorMessage": "sample string 19"
    }
  ],
  "TotalCount": 1,
  "IsSuccessful": true,
  "ErrorMessage": "sample string 3"
}
<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">sample string 3</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">sample string 19</ErrorMessage>
      <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
      <AccountGroupCode>sample string 17</AccountGroupCode>
      <AccountId>sample string 6</AccountId>
      <AutoPayOptions>
        <FrequencyDetails>
          <Amount>2</Amount>
          <Frequency>sample string 1</Frequency>
          <NumberOfInstallments>3</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>2</Amount>
          <Frequency>sample string 1</Frequency>
          <NumberOfInstallments>3</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
      </AutoPayOptions>
      <Bills>
        <BillDetails>
          <Amount>5</Amount>
          <Date>2020-08-09T21:23:17.8860975-07:00</Date>
          <Description>sample string 4</Description>
          <DocumentId>sample string 2</DocumentId>
          <Id>sample string 1</Id>
          <LinkToDownload>sample string 6</LinkToDownload>
        </BillDetails>
        <BillDetails>
          <Amount>5</Amount>
          <Date>2020-08-09T21:23:17.8860975-07:00</Date>
          <Description>sample string 4</Description>
          <DocumentId>sample string 2</DocumentId>
          <Id>sample string 1</Id>
          <LinkToDownload>sample string 6</LinkToDownload>
        </BillDetails>
      </Bills>
      <CustomerId>sample string 3</CustomerId>
      <CustomerName>sample string 5</CustomerName>
      <Documents>
        <DocumentDetails>
          <Id>sample string 1</Id>
          <LinkToDownload>sample string 3</LinkToDownload>
          <Type>sample string 2</Type>
        </DocumentDetails>
        <DocumentDetails>
          <Id>sample string 1</Id>
          <LinkToDownload>sample string 3</LinkToDownload>
          <Type>sample string 2</Type>
        </DocumentDetails>
      </Documents>
      <DueDate>2020-08-09T21:23:17.8860975-07:00</DueDate>
      <ExternalCustomerId>sample string 4</ExternalCustomerId>
      <FeeContext>sample string 16</FeeContext>
      <IsAutoPayEnabled>true</IsAutoPayEnabled>
      <MinimumAmountDue>13</MinimumAmountDue>
      <OtherAmountAllowed>true</OtherAmountAllowed>
      <PaymentsAreAllowed>true</PaymentsAreAllowed>
      <PolicyDetails i:nil="true" />
      <PolicyId>sample string 1</PolicyId>
      <PolicyNumber>sample string 2</PolicyNumber>
      <Premium>10</Premium>
      <RemainingBalance>12</RemainingBalance>
      <Status>sample string 7</Status>
      <Term>sample string 8</Term>
      <Type>sample string 9</Type>
      <ZipCode>sample string 15</ZipCode>
    </PolicyDetailsResponse>
    <PolicyDetailsResponse>
      <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">sample string 19</ErrorMessage>
      <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts">true</IsSuccessful>
      <AccountGroupCode>sample string 17</AccountGroupCode>
      <AccountId>sample string 6</AccountId>
      <AutoPayOptions>
        <FrequencyDetails>
          <Amount>2</Amount>
          <Frequency>sample string 1</Frequency>
          <NumberOfInstallments>3</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
        <FrequencyDetails>
          <Amount>2</Amount>
          <Frequency>sample string 1</Frequency>
          <NumberOfInstallments>3</NumberOfInstallments>
          <WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </WithdrawalDates>
        </FrequencyDetails>
      </AutoPayOptions>
      <Bills>
        <BillDetails>
          <Amount>5</Amount>
          <Date>2020-08-09T21:23:17.8860975-07:00</Date>
          <Description>sample string 4</Description>
          <DocumentId>sample string 2</DocumentId>
          <Id>sample string 1</Id>
          <LinkToDownload>sample string 6</LinkToDownload>
        </BillDetails>
        <BillDetails>
          <Amount>5</Amount>
          <Date>2020-08-09T21:23:17.8860975-07:00</Date>
          <Description>sample string 4</Description>
          <DocumentId>sample string 2</DocumentId>
          <Id>sample string 1</Id>
          <LinkToDownload>sample string 6</LinkToDownload>
        </BillDetails>
      </Bills>
      <CustomerId>sample string 3</CustomerId>
      <CustomerName>sample string 5</CustomerName>
      <Documents>
        <DocumentDetails>
          <Id>sample string 1</Id>
          <LinkToDownload>sample string 3</LinkToDownload>
          <Type>sample string 2</Type>
        </DocumentDetails>
        <DocumentDetails>
          <Id>sample string 1</Id>
          <LinkToDownload>sample string 3</LinkToDownload>
          <Type>sample string 2</Type>
        </DocumentDetails>
      </Documents>
      <DueDate>2020-08-09T21:23:17.8860975-07:00</DueDate>
      <ExternalCustomerId>sample string 4</ExternalCustomerId>
      <FeeContext>sample string 16</FeeContext>
      <IsAutoPayEnabled>true</IsAutoPayEnabled>
      <MinimumAmountDue>13</MinimumAmountDue>
      <OtherAmountAllowed>true</OtherAmountAllowed>
      <PaymentsAreAllowed>true</PaymentsAreAllowed>
      <PolicyDetails i:nil="true" />
      <PolicyId>sample string 1</PolicyId>
      <PolicyNumber>sample string 2</PolicyNumber>
      <Premium>10</Premium>
      <RemainingBalance>12</RemainingBalance>
      <Status>sample string 7</Status>
      <Term>sample string 8</Term>
      <Type>sample string 9</Type>
      <ZipCode>sample string 15</ZipCode>
    </PolicyDetailsResponse>
  </Results>
  <TotalCount>1</TotalCount>
</PolicySearchResponse>

Notification

Notification operations.

POST notifications/acknowledgePayments

This method is used to notify the source system that payments has been submitted

AcknowledgePaymentsRequest

NameDescriptionTypeAdditional information
SubmitPaymentAcknowledgeRequests

Payment acknowledgement request models.

Collection of AcknowledgePaymentDetails

Required

AcknowledgePaymentDetails

NameDescriptionTypeAdditional information
CustomerId

One Inc customer identifier.

string
ExternalCustomerId

External generated ID of Customer

string
AccountId

Account Identifier

string
CustomerName

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

string

Required

AuthCode

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

string
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
PaymentMethod

Payment method

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

Required

BatchNumber

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

integer

Required

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

Required

SessionId

Unique identifier echoed back from call to a PortalOne operation.

string
PaymentAmount

The premium payment amount excluding any convenience fees.

decimal number

Required

Timezone

Time zone code. (PST, EST)

string

Required

TransactionDate

Date Stamp of the payment

date

Required

OutboundApiKey

Unique Identifier for the outbound API.

string
ClientReferenceData

Client reference data

ClientReferenceData

Required

ExtendedParameters

Extended parameters

Dictionary of string and object

PaymentMethodBase

NameDescriptionTypeAdditional information
Type

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

string

Required

LastFourDigits

Last 4 digits of the card or bank account

string

CreditCardPaymentMethodDetails

NameDescriptionTypeAdditional information
CardType

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

CreditCardType

Required

HolderZip

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

string

Required

CardExpirationMonth

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

integer

Required

CardExpirationYear

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

integer

Required

Type

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

string

Required

LastFourDigits

Last 4 digits of the card or bank account

string

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

NameDescriptionTypeAdditional information
AccountType

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

EftAccountType

Required

BankName

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

string

Required

Type

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

string

Required

LastFourDigits

Last 4 digits of the card or bank account

string

EftAccountType

Possible enumeration values:

NameValueDescription
Checking

1

Checking.

Savings

2

Savings.

ClientReferenceData

NameDescriptionTypeAdditional information
ClientReferenceData1

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

string

Required

ClientReferenceData2

External TransactionId value.

string
ClientReferenceData3

Location data such as the office the transaction originated.

string
ClientReferenceData4

Transaction additional information.

string
ClientReferenceData5

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

string

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",
      "PaymentMethod": null,
      "BatchNumber": 1,
      "TransactionId": "sample string 7",
      "SessionId": "sample string 8",
      "PaymentAmount": 1.0,
      "Timezone": "sample string 9",
      "TransactionDate": "2020-08-09T21:23:18",
      "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",
      "PaymentMethod": null,
      "BatchNumber": 1,
      "TransactionId": "sample string 7",
      "SessionId": "sample string 8",
      "PaymentAmount": 1.0,
      "Timezone": "sample string 9",
      "TransactionDate": "2020-08-09T21:23:18",
      "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-08-09T21:23:18.2296066-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-08-09T21:23:18.2296066-07:00</TransactionDate>
      <TransactionId>sample string 7</TransactionId>
    </AcknowledgePaymentDetails>
  </SubmitPaymentAcknowledgeRequests>
</AcknowledgePaymentsRequest>

Response Information

AcknowledgePaymentsResponse

NameDescriptionTypeAdditional information
IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

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

AcknowledgePaymentMethodsRequest

NameDescriptionTypeAdditional information
SubmitPaymentMethodsDetails

Payment method acknowledgement details models

Collection of SubmitPaymentMethodsDetails
ExtendedParameters

Extended parameters

Dictionary of string and object

SubmitPaymentMethodsDetails

NameDescriptionTypeAdditional information
CustomerId

One Inc customer identifier.

string
ExternalCustomerId

External generated ID of Customer

string
AccountId

Account Identifier

string
CustomerName

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

string
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
PaymentMethod

Payment method

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

Client reference data

ClientReferenceData
ExtendedParameters

Extended parameters

Dictionary of string and object

Request Formats

 
{
  "SubmitPaymentMethodsDetails": [
    {
      "CustomerId": "sample string 1",
      "ExternalCustomerId": "sample string 2",
      "AccountId": "sample string 3",
      "CustomerName": "sample string 4",
      "TokenId": "sample string 5",
      "PaymentMethod": null,
      "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",
      "PaymentMethod": null,
      "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

NameDescriptionTypeAdditional information
ExtendedParameters

Dictionary of string and object
IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

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

Auto Pay Enrollment Operations

POST autopay/paymentProcessed

This method is used to notify that recurring payment was processed

PaymentProcessedNotificationRequest

NameDescriptionTypeAdditional information
TransactionId

Payment transaction identifier.

integer
InstallmentPaymentStatus

Installment payment status.

InstallmentPlanPaymentStatus

Required

Amount

Payment amount.

decimal number
Type

Transaction payment type.

PaymentType
TransactionDate

Transaction processing date.

date

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-08-09T21:23:18"
}
<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-08-09T21:23:18</TransactionDate>
  <TransactionId>123456</TransactionId>
  <Type>Eft</Type>
</PaymentProcessedNotificationRequest>

Response Information

PaymentProcessedNotificationResponse

NameDescriptionTypeAdditional information
IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

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

InstallmentPlanChangedNotificationRequest

NameDescriptionTypeAdditional information
InstallmentPlanDetails

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

InstallmentPlanDetails

Required

InstallmentPlanDetails

NameDescriptionTypeAdditional information
InstallmentPlanId

Unique identifier for the installment plan

integer

Required

PolicyRefNumber

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

string

Required

InstallmentPlanStatus

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

InstallmentPlanStatus

Required

ProfileId

The ProfileId associated to the Installment Plan.

integer

Required

InstallmentPlanTokenId

Payment method TokenId that will be used for the payments.

string

Required

ClientRefValues

Array of ClientRefValueDetails associated to the ProfileId.

Collection of ClientRefValueDetails

Required

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

Required

CustomerId

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

string
ExternalCustomerId

External generated ID of Customer.

string
Email

Customer email address.

string
WithdrawalFrequency

Specifies how often payments should be made.

WithdrawalFrequency

Required

AmountPerInstallment

Payment amount for each installment.

decimal number

Required

NumberOfInstallments

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

integer

Required

WithdrawalDay

Specifies day of month when payments should be made.

integer

Required

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
PaymentMethod

Payment method

PaymentMethodBase Can be one of the following types: CreditCardPaymentMethodDetails EftPaymentMethodDetails

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

NameDescriptionTypeAdditional information
PropertyName

Property name.

string

Required

String length: inclusive between 0 and 250

PropertyValue

Property value.

string

String length: inclusive between 0 and 250

InstallmentPlanPaymentDetails

NameDescriptionTypeAdditional information
InstallmentPlanPaymentId

Unique value for each payment under the installment payment plan.

integer

Required

PolicyRefNumber

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

string

Required

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

Required

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

Required

Amount

The dollar amount of the payment.

decimal number

Required

IncludeFee

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

boolean

Required

PostedAmount

The total amount processed. Includes the amount of fees.

decimal number
EffectiveDate

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

date

Required

NextRetryDate

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

date
UpdatedDate

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

date
PaymentCategory

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

PaymentType

Required

TokenId

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

string

Required

TimeZone

Timezone code (PST, EST).

string

Required

TransactionDetails

Payment transaction results details. See TransactionDetails object definition.

TransactionDetails

Required

CreditCardDetails

Credit Card payment response details. See ProcessedCreditCardDetails object definition.

ProcessedCreditCardDetails
EftDetails

Eft payment response details. See ProcessedEftDetails object definition.

ProcessedEftDetails

TransactionDetails

NameDescriptionTypeAdditional information
ProcessedDate

Date and time stamp on which the payment was processed.

date

Required

ProcessOneTransactionId

ProcessOne payment Transaction number.

integer

Required

AuthCode

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

string
BatchNumber

The batch number to which the ProcessOne transaction was attached.

integer
PaymentResponseCode

Response code received when payment was made.

string

Required

PaymentResponseMessage

Readable response description received when payment was made.

string

ProcessedCreditCardDetails

NameDescriptionTypeAdditional information
LastFourDigits

Last four digits for the credit card number.

string

Required

ExpirationMonth

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

integer

Required

ExpirationYear

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

integer

Required

HolderAddress

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

string
Zip

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

string
CardHolderName

The cardholder name.

string

Required

CardType

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

CreditCardType

Required

ProcessedEftDetails

NameDescriptionTypeAdditional information
LastFourDigits

Last four digits of the bank account.

string

Required

CustomerName

Customer Name associated to the bank account.

string

Required

BankName

The name of the Bank based off of Routing Number.

string

Required

AccountType

Type of bank account: checking or savings.

EftAccountType

Required

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-07-09T21:23:18.7764776",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 2,
        "TokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
        "TimeZone": "US/Pacific",
        "TransactionDetails": {
          "ProcessedDate": "2020-07-10T21:23:18.7764776",
          "ProcessOneTransactionId": 123456,
          "AuthCode": "1234",
          "BatchNumber": 111,
          "PaymentResponseCode": "Success",
          "PaymentResponseMessage": ""
        },
        "CreditCardDetails": null,
        "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-08-09T21:23:18.7764776",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 2,
        "TokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
        "TimeZone": "US/Pacific",
        "TransactionDetails": {
          "ProcessedDate": "2020-08-09T21:23:18.7764776",
          "ProcessOneTransactionId": 123456,
          "AuthCode": "1234",
          "BatchNumber": 111,
          "PaymentResponseCode": "Success",
          "PaymentResponseMessage": ""
        },
        "CreditCardDetails": null,
        "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-07-09T21:23:18.7764776-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-07-10T21:23:18.7764776-07:00</ProcessedDate>
        </TransactionDetails>
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>10</Amount>
        <CreditCardDetails i:nil="true" />
        <EffectiveDate>2020-08-09T21:23:18.7764776-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-08-09T21:23:18.7764776-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

NameDescriptionTypeAdditional information
IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

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

CurrentPaymentAmountRequest

NameDescriptionTypeAdditional information
PolicyNumber

Policy number.

string

Required

ZipCode

Policy zip code.

string

Required

InstallmentPlanId

Auto pay installment plan identifier.

string

Required

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

NameDescriptionTypeAdditional information
PolicyId

Policy Identifier.

string

Required

IsRecurringPaymentDue

Is recurring payment due today.

boolean

Required

Amount

Amount to charge.

decimal number

Required

IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

Response Formats

{
  "PolicyId": "12345",
  "IsRecurringPaymentDue": true,
  "Amount": 100.0,
  "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>
</CurrentPaymentAmountResponse>

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.

GetIdentificationCriteriaRequest

NameDescriptionTypeAdditional information
AccountId

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

integer
ContactId

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

integer
EpayRequestId

The identifier for the ePay request.

integer
ExtendedParameters

The collection of key value pairs for optional parameters.

Dictionary of string and object
Extended Parameters

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

NameDescriptionTypeAdditional 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
ValidationRules

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

Collection of ValidationRule
ResponseCode

Operation response code.

string

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string

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

ValidationRule

NameDescriptionTypeAdditional information
Name

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

string
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
MinLength

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

integer
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

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

VerifyIdentityRequest

NameDescriptionTypeAdditional information
AccountId

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

integer
ContactId

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

integer
EpayRequestId

The identifier for the ePay request.

integer
ExtendedParameters

The collection of key value pairs for optional parameters.

Dictionary of string and string
VerificationResponse

The data for verification.

Collection of VerificationResponse

VerificationResponse

NameDescriptionTypeAdditional information
VerificationCriteria

The validation criteria that was provided with the GetIdentificationCriteriaResponse.

string
VerificationValue

The user entered value for each requested verification.

string

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

NameDescriptionTypeAdditional information
ResponseCode

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

string

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string

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

ContactOption

NameDescriptionTypeAdditional information
ContactOptionMethod

Value is phone.

string
ContactOptionValue

10 digit number with no spaces or symbols.

string

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 epaysavecomplete

EPay functionality has been replaced with the Approval Request ProcessType of SinglePartySave.

EpaySaveCompleteRequest

NameDescriptionTypeAdditional information
EpayRequestId

Unique Identifier for the ePay record.

integer
AccountId

One Inc, unique identifier for the individual or company account.

integer
ContactId

Contact identifier for a company contact. Only applicable to company accounts.

integer
ClaimNumber

The claim number that was passed to the save payment modal when ePay was initiated.

string
BankAccountSummary

Token and supporting information that can be used to process an EFT Credit payments.

BankAccountSummary
ExtendedParameters

The collection of key value pairs for optional parameters.

Dictionary of string and string

BankAccountSummary

NameDescriptionTypeAdditional information
Token

Saved bank account token.

string
AccountType

Account type.

EftAccountType
LastFourDigits

Last four digits of the bank account number.

string
BankName

Name of Bank based off of Routing Number.

string
NameOnAccount

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

string

Request Formats

 
{
  "EpayRequestId": 369,
  "AccountId": 135,
  "ContactId": 246,
  "ClaimNumber": "123123123",
  "BankAccountSummary": {
    "Token": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
    "AccountType": 1,
    "LastFourDigits": "1234",
    "BankName": "Some Bank",
    "NameOnAccount": "John Smith"
  },
  "ExtendedParameters": {
    "ExtendedParameter1": "Extended Parameter 1 Value",
    "ExtendedParameter2": "Extended Parameter 2 Value"
  }
}
<EpaySaveCompleteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.ClamsSystem">
  <AccountId>135</AccountId>
  <BankAccountSummary>
    <AccountType>Checking</AccountType>
    <BankName>Some Bank</BankName>
    <LastFourDigits>1234</LastFourDigits>
    <NameOnAccount>John Smith</NameOnAccount>
    <Token>1E8E5E3B-B438-4405-82AE-F5C64E1FF060</Token>
  </BankAccountSummary>
  <ClaimNumber>123123123</ClaimNumber>
  <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>
</EpaySaveCompleteRequest>

Response Information

EpaySaveCompleteResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code.

string

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string

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

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<EpaySaveCompleteResponse 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>
</EpaySaveCompleteResponse>

POST approvalrequestupdate

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

ApprovalRequestUpdateRequest

NameDescriptionTypeAdditional 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
EventType

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

ApprovalRequestUpdateEventType
EventDate

The date of the event.

date
TimeZone

Time zone code. (PST, EST)

string
ClaimNumber

Claim number for which the approval process will be completed.

string
ApprovalRequestId

Unique identifier for the approval request.

integer
ProcessType

The process type for the approval request.

string
Process Type Values
Status

The status of the approval request.

ApprovalRequestStatus

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 if ProcessPayment = true, 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-08-09T21:23:19",
  "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-08-09T21:23:19</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

NameDescriptionTypeAdditional information
ResponseCode

Operation response code.

string

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string

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

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.

ApprovalRequestPartyUpdateRequest

NameDescriptionTypeAdditional 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
EventType

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

ApprovalRequestPartyUpdateEventType
EventDate

The date of the event.

date
TimeZone

Time zone code. (PST, EST)

string
ApprovalRequestPartyId

Approval Request Party Identifier.

integer
AccountId

ClaimsPay Account Identifier.

integer
ContactId

Company Contact identifier. Only applicable to company accounts.

integer
ProcessType

The process type for the approval request.

string
Process Type Values
ApprovalRole

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

ApprovalRequestPartyRole
LinkDeliveryType

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

InvitationMessageDeliveryType
EmailAddress

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

string
PhoneNumber

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

string
FullName

First and Last name of the claim party.

string
CompanyName

Company name if the ClaimsPayAccountType is Company.

string
Status

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

ApprovalRequestPartyStatus
DisputeComment

Applicable to ApprovalRequestPartyStatus is Rejected.

string
PaymentSummary

Payment information.

PaymentSummary

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

NameDescriptionTypeAdditional information
PaymentMethodType

Selected payment method type.

PaymentMethodType
BankAccountSummary

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

BankAccountSummary
CardSummary

Card summary information that was saved with the Approval request.

CardSummary
CheckSummary

Check summary information that was saved with the Approval request.

CheckSummary
Address

Selected mailing address for check.

MailingAddress
TransactionSummary

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

TransactionSummary

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.

CardSummary

NameDescriptionTypeAdditional information
Token

Card payment token.

string
LastFourDigits

Card type.

string
CardType

Last four digits of the card number.

CreditCardType
ExpirationYear

Year of the expiration of the card.

string
ExpirationMonth

Month of the expiration of the card.

string
Holder

Card holder.

Customer

Customer

NameDescriptionTypeAdditional information
Name

Customer name.

string
Zip

Customer ZIP code.

string
Address

Customer address.

string
Phone

Customer phone.

string

CheckSummary

NameDescriptionTypeAdditional information
PayTo

Name(s) on the check.

string
CheckMemo

Check Memo

string
CheckStubData

Information that was printed on the check stub.

Collection of string
DocumentUrl

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

string
MailDeliveryType

Defines the mailing method that was used for the check.

MailDeliveryType
CheckFulfillmentOwner

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

CheckFulfillmentOwnerType

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

NameDescriptionTypeAdditional information
CompanyContactInformation

Additional company address field.

string
Attention

For payment method of check, attention line.

string
Address

The street address.

string
Address2

Address Line 2 to which the check will be mailed.

string
City

The city.

string
State

The state.

string
Zip

The zip code.

string

TransactionSummary

NameDescriptionTypeAdditional information
TransactionId

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

string
TransactionDate

The date when transaction was executed.

date
PaymentProcessingStatus

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

PaymentProcessingStatus
PaymentResponseMessage

Payment response message.

string
BatchNumber

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

integer

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-08-09T21:23:19",
  "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,
  "DisputeComment": null,
  "PaymentSummary": {
    "PaymentMethodType": 1,
    "BankAccountSummary": {
      "Token": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
      "AccountType": 1,
      "LastFourDigits": "1234",
      "BankName": "Some Bank",
      "NameOnAccount": "John Smith"
    },
    "CardSummary": null,
    "CheckSummary": null,
    "Address": {
      "CompanyContactInformation": null,
      "Attention": null,
      "Address": "Street",
      "Address2": null,
      "City": "City",
      "State": "ST",
      "Zip": "95123"
    },
    "TransactionSummary": {
      "TransactionId": "123456",
      "TransactionDate": "2020-08-09T21:23:19",
      "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-08-09T21:23:19</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>
    <CardSummary i:nil="true" />
    <CheckSummary i:nil="true" />
    <PaymentMethodType>BankAccount</PaymentMethodType>
    <TransactionSummary>
      <BatchNumber>123456</BatchNumber>
      <PaymentProcessingStatus>Successful</PaymentProcessingStatus>
      <PaymentResponseMessage>Success</PaymentResponseMessage>
      <TransactionDate>2020-08-09T21:23:19</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

NameDescriptionTypeAdditional information
ResponseCode

Operation response code.

string

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string

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

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>

Communication

Communication Module Operations

POST messagesProcessingResults

This method is used to export messages processing result from Communication Module

MessageProcessingResultsRequest

NameDescriptionTypeAdditional information
CommunicationMessages

Collection of communication messages with processing results

Collection of CommunicationMessageDto

CommunicationMessageDto

NameDescriptionTypeAdditional information
Id

Message Id

string
Channel

Channel type for sending communication message

CommunicationMessageChannelType

Required

Type

Type of message

CommunicationMessageType

Required

Template

Message template

string

Required

Timezone

Timezone

string
Properties

Additional message properties

Dictionary of string and string

CommunicationMessageChannelType

Possible enumeration values:

NameValueDescription
Email

1

Email Communication Channel

Text

2

Text message Communication Channel

PhoneCall

3

Phone Call Communication Channel

CommunicationMessageType

Possible enumeration values:

NameValueDescription
Message

1

Communication Message

Conversation

2

Payment Message for TextPay

VerificationCode

3

Message for Sending Verification Code

Request Formats

 
{
  "CommunicationMessages": [
    {
      "Id": "sample string 1",
      "Channel": 0,
      "Type": 0,
      "Template": "sample string 2",
      "Timezone": "sample string 3",
      "Properties": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    },
    {
      "Id": "sample string 1",
      "Channel": 0,
      "Type": 0,
      "Template": "sample string 2",
      "Timezone": "sample string 3",
      "Properties": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    }
  ]
}
<MessageProcessingResultsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ExternalApi.DataContracts.Communication">
  <CommunicationMessages>
    <CommunicationMessageDto>
      <Channel>Undefined</Channel>
      <Id>sample string 1</Id>
      <Properties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Properties>
      <Template>sample string 2</Template>
      <Timezone>sample string 3</Timezone>
      <Type>Undefined</Type>
    </CommunicationMessageDto>
    <CommunicationMessageDto>
      <Channel>Undefined</Channel>
      <Id>sample string 1</Id>
      <Properties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Properties>
      <Template>sample string 2</Template>
      <Timezone>sample string 3</Timezone>
      <Type>Undefined</Type>
    </CommunicationMessageDto>
  </CommunicationMessages>
</MessageProcessingResultsRequest>

Response Information

MessageProcessingResultsResponse

NameDescriptionTypeAdditional information
IsSuccessful

Is Successful

boolean

Required

ErrorMessage

Error Message

string

Required

Response Formats

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

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.

EpayChargedRequest

NameDescriptionTypeAdditional information
CommunicationKey

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

string
PaymentAmount

Payment Amount passed by Client.

decimal number
TransactionId

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

integer
TransactionDate

Date Stamp of the payment.

date
BatchNumber

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

integer
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
SavedCardTokenId

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

string
SavedEftTokenId

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

string
IsPaymentMethodRecurring

Is payment method recurring.

boolean
ClientReferenceData

Client Reference Data.

ClientReferenceData

Request Formats

 
{
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "PaymentAmount": 100.0,
  "TransactionId": 123456,
  "TransactionDate": "2020-08-09T21:23:20",
  "BatchNumber": 5444,
  "AccountGroupCode": "Default",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "SavedEftTokenId": null,
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company",
    "ClientReferenceData4": null
  }
}
<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-08-09T21:23:20</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayChargedRequest>

Response Information

None.

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.

EpayChargedRequest

NameDescriptionTypeAdditional information
CommunicationKey

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

string
PaymentAmount

Payment Amount passed by Client.

decimal number
TransactionId

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

integer
TransactionDate

Date Stamp of the payment.

date
BatchNumber

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

integer
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
SavedCardTokenId

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

string
SavedEftTokenId

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

string
IsPaymentMethodRecurring

Is payment method recurring.

boolean
ClientReferenceData

Client Reference Data.

ClientReferenceData

Request Formats

 
{
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "PaymentAmount": 100.0,
  "TransactionId": 123456,
  "TransactionDate": "2020-08-09T21:23:20",
  "BatchNumber": 5444,
  "AccountGroupCode": "Default",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "SavedEftTokenId": null,
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company",
    "ClientReferenceData4": null
  }
}
<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-08-09T21:23:20</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayChargedRequest>

Response Information

None.

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.

EpayChargedRequest

NameDescriptionTypeAdditional information
CommunicationKey

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

string
PaymentAmount

Payment Amount passed by Client.

decimal number
TransactionId

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

integer
TransactionDate

Date Stamp of the payment.

date
BatchNumber

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

integer
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
SavedCardTokenId

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

string
SavedEftTokenId

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

string
IsPaymentMethodRecurring

Is payment method recurring.

boolean
ClientReferenceData

Client Reference Data.

ClientReferenceData

Request Formats

 
{
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "PaymentAmount": 100.0,
  "TransactionId": 123456,
  "TransactionDate": "2020-08-09T21:23:20",
  "BatchNumber": 5444,
  "AccountGroupCode": "Default",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "SavedEftTokenId": null,
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company",
    "ClientReferenceData4": null
  }
}
<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-08-09T21:23:20</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayChargedRequest>

Response Information

None.

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.

EpayChargedRequest

NameDescriptionTypeAdditional information
CommunicationKey

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

string
PaymentAmount

Payment Amount passed by Client.

decimal number
TransactionId

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

integer
TransactionDate

Date Stamp of the payment.

date
BatchNumber

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

integer
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
SavedCardTokenId

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

string
SavedEftTokenId

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

string
IsPaymentMethodRecurring

Is payment method recurring.

boolean
ClientReferenceData

Client Reference Data.

ClientReferenceData

Request Formats

 
{
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "PaymentAmount": 100.0,
  "TransactionId": 123456,
  "TransactionDate": "2020-08-09T21:23:20",
  "BatchNumber": 5444,
  "AccountGroupCode": "Default",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "SavedEftTokenId": null,
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company",
    "ClientReferenceData4": null
  }
}
<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-08-09T21:23:20</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayChargedRequest>

Response Information

None.

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.

EpayChargedRequest

NameDescriptionTypeAdditional information
CommunicationKey

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

string
PaymentAmount

Payment Amount passed by Client.

decimal number
TransactionId

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

integer
TransactionDate

Date Stamp of the payment.

date
BatchNumber

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

integer
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
SavedCardTokenId

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

string
SavedEftTokenId

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

string
IsPaymentMethodRecurring

Is payment method recurring.

boolean
ClientReferenceData

Client Reference Data.

ClientReferenceData

Request Formats

 
{
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "PaymentAmount": 100.0,
  "TransactionId": 123456,
  "TransactionDate": "2020-08-09T21:23:20",
  "BatchNumber": 5444,
  "AccountGroupCode": "Default",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "SavedEftTokenId": null,
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company",
    "ClientReferenceData4": null
  }
}
<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-08-09T21:23:20</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayChargedRequest>

Response Information

None.

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.

EpayChargedRequest

NameDescriptionTypeAdditional information
CommunicationKey

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

string
PaymentAmount

Payment Amount passed by Client.

decimal number
TransactionId

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

integer
TransactionDate

Date Stamp of the payment.

date
BatchNumber

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

integer
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
SavedCardTokenId

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

string
SavedEftTokenId

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

string
IsPaymentMethodRecurring

Is payment method recurring.

boolean
ClientReferenceData

Client Reference Data.

ClientReferenceData

Request Formats

 
{
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "PaymentAmount": 100.0,
  "TransactionId": 123456,
  "TransactionDate": "2020-08-09T21:23:20",
  "BatchNumber": 5444,
  "AccountGroupCode": "Default",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "SavedEftTokenId": null,
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company",
    "ClientReferenceData4": null
  }
}
<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-08-09T21:23:20</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayChargedRequest>

Response Information

None.

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.

EpayLinkCreatedRequest

NameDescriptionTypeAdditional information
CommunicationKey

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

string
PortalUrl

Portal url.

string

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

None.

POST ePayPostbackCreateLinkForSavePaymentMethod

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

EpayLinkCreatedRequest

NameDescriptionTypeAdditional information
CommunicationKey

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

string
PortalUrl

Portal url.

string

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

None.

POST ePayPostbackCreateLinkForChargeBySavedPaymentMethod

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

EpayLinkCreatedRequest

NameDescriptionTypeAdditional information
CommunicationKey

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

string
PortalUrl

Portal url.

string

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

None.

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.

EpayPaymentMethodSavedRequest

NameDescriptionTypeAdditional information
CommunicationKey

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

string
TransactionId

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

integer
TransactionDate

Date Stamp of the payment.

date
SavedCardTokenId

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

string
SavedEftTokenId

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

string
IsPaymentMethodRecurring

Is payment method recurring.

boolean
ClientReferenceData

Client Reference Data.

ClientReferenceData

Request Formats

 
{
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "TransactionId": 123456,
  "TransactionDate": "2020-08-09T21:23:21",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "SavedEftTokenId": null,
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company",
    "ClientReferenceData4": null
  }
}
<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-08-09T21:23:21</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayPaymentMethodSavedRequest>

Response Information

None.

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.

EpayPaymentMethodSavedRequest

NameDescriptionTypeAdditional information
CommunicationKey

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

string
TransactionId

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

integer
TransactionDate

Date Stamp of the payment.

date
SavedCardTokenId

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

string
SavedEftTokenId

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

string
IsPaymentMethodRecurring

Is payment method recurring.

boolean
ClientReferenceData

Client Reference Data.

ClientReferenceData

Request Formats

 
{
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "TransactionId": 123456,
  "TransactionDate": "2020-08-09T21:23:21",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "SavedEftTokenId": null,
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company",
    "ClientReferenceData4": null
  }
}
<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-08-09T21:23:21</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayPaymentMethodSavedRequest>

Response Information

None.

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.

EpayPaymentMethodSavedRequest

NameDescriptionTypeAdditional information
CommunicationKey

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

string
TransactionId

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

integer
TransactionDate

Date Stamp of the payment.

date
SavedCardTokenId

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

string
SavedEftTokenId

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

string
IsPaymentMethodRecurring

Is payment method recurring.

boolean
ClientReferenceData

Client Reference Data.

ClientReferenceData

Request Formats

 
{
  "CommunicationKey": "EA3EAA87-6466-4C04-B915-CFF836D9EB4D",
  "TransactionId": 123456,
  "TransactionDate": "2020-08-09T21:23:21",
  "SavedCardTokenId": "1E8E5E3B-B438-4405-82AE-F5C64E1FF060",
  "SavedEftTokenId": null,
  "IsPaymentMethodRecurring": true,
  "ClientReferenceData": {
    "ClientReferenceData1": "AB-98765432",
    "ClientReferenceData2": "123456",
    "ClientReferenceData3": "Some Company",
    "ClientReferenceData4": null
  }
}
<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-08-09T21:23:21</TransactionDate>
  <TransactionId>123456</TransactionId>
</EpayPaymentMethodSavedRequest>

Response Information

None.

Response Code Definitions

Response Code Description Applicable Methods
Success Indicates a successful response result. All
InternalServerError Indicates unexpected error. All
InvalidRequest Indicates validation error for a request. All