Account

Account Operations

GET api/account/current

This method is used get current user's Account Details Information (based on access token provided in header)

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
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

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": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "AgentLink": "sample string 4",
  "TimeZone": "sample string 5",
  "Phones": [
    {
      "Type": "sample string 1",
      "Number": "sample string 2",
      "Extension": "sample string 3",
      "IsPreferredPhoneNumber": true
    },
    {
      "Type": "sample string 1",
      "Number": "sample string 2",
      "Extension": "sample string 3",
      "IsPreferredPhoneNumber": true
    }
  ],
  "Email": "sample string 6",
  "Addresses": [
    {
      "StreetAddress": "sample string 1",
      "City": "sample string 2",
      "State": "sample string 3",
      "ZipCode": "sample string 4",
      "Country": "sample string 5"
    },
    {
      "StreetAddress": "sample string 1",
      "City": "sample string 2",
      "State": "sample string 3",
      "ZipCode": "sample string 4",
      "Country": "sample string 5"
    }
  ],
  "ResponseCode": "sample string 7",
  "ResponseMessage": "sample string 8"
}
<AccountDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>sample string 7</ResponseCode><ResponseMessage>sample string 8</ResponseMessage><AccountId>sample string 1</AccountId><Addresses><Address><City>sample string 2</City><Country>sample string 5</Country><State>sample string 3</State><StreetAddress>sample string 1</StreetAddress><ZipCode>sample string 4</ZipCode></Address><Address><City>sample string 2</City><Country>sample string 5</Country><State>sample string 3</State><StreetAddress>sample string 1</StreetAddress><ZipCode>sample string 4</ZipCode></Address></Addresses><AgentLink>sample string 4</AgentLink><Email>sample string 6</Email><FirstName>sample string 2</FirstName><LastName>sample string 3</LastName><Phones><Phone><Extension>sample string 3</Extension><IsPreferredPhoneNumber>true</IsPreferredPhoneNumber><Number>sample string 2</Number><Type>sample string 1</Type></Phone><Phone><Extension>sample string 3</Extension><IsPreferredPhoneNumber>true</IsPreferredPhoneNumber><Number>sample string 2</Number><Type>sample string 1</Type></Phone></Phones><TimeZone>sample string 5</TimeZone></AccountDetailsResponse>

POST api/account/paymentMethods

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

UpdatePaymentMethodRequest

NameDescriptionTypeAdditional information
AccountId

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

string
PortalOneSessionKey

Session key

string
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": "sample string 1",
      "Action": "sample string 2"
    },
    {
      "PaymentMethodToken": "sample string 1",
      "Action": "sample string 2"
    }
  ],
  "AccountId": "sample string 1",
  "PortalOneSessionKey": "sample string 2"
}
<UpdatePaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>sample string 2</PortalOneSessionKey><AccountId>sample string 1</AccountId><Actions><UpdatePaymentMethodAction><Action>sample string 2</Action><PaymentMethodToken>sample string 1</PaymentMethodToken></UpdatePaymentMethodAction><UpdatePaymentMethodAction><Action>sample string 2</Action><PaymentMethodToken>sample string 1</PaymentMethodToken></UpdatePaymentMethodAction></Actions></UpdatePaymentMethodRequest>

Response Information

UpdatePaymentMethodResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<UpdatePaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
</UpdatePaymentMethodResponse>

POST api/account/policies

Get Active Policies for the customer

GetActivePoliciesRequest

NameDescriptionTypeAdditional information
AccountId

Account Id

string
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "AccountId": "sample string 1",
  "PortalOneSessionKey": "sample string 2"
}
<GetActivePoliciesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>sample string 2</PortalOneSessionKey>
  <AccountId>sample string 1</AccountId>
</GetActivePoliciesRequest>

Response Information

GetActivePoliciesResponse

NameDescriptionTypeAdditional information
Policies

Collection of Policies

Collection of PolicyDetailsResponse

Required

ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

PolicyDetailsResponse

NameDescriptionTypeAdditional information
PolicyId

Policy Identifier

string
PolicyNumber

Policy Number

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

Expiration Date of the policy

date
RemainingBalance

Remaining Balance

decimal number
MinimumAmountDue

Minimum Amount Due

decimal number
OtherAmountAllowed

Other Amount Allowed

boolean
ZipCode

Policy Zip Code

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
IsAutopayEnrolled

Is Autopay Enrolled

boolean
NextWithdrawalDate

Next withdrawal date for Autopay

date
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

DocumentDetails

NameDescriptionTypeAdditional information
Id

Document Id

string
Type

Document Type (e.g. ProofOfInsurance)

string
LinkToDownload

LinkToDownload to download the document (proof of insurance)

string

BillDetails

NameDescriptionTypeAdditional information
Id

Bill Id

string
DocumentId

Document Id

string
Date

Date

date
Description

Description

string
Amount

Amount

decimal number
LinkToDownload

Link to download the bill

string

FrequencyDetails

NameDescriptionTypeAdditional information
Frequency

Frequency type: Monthly, Quarterly, Semiannually, Annually

string
Amount

Payment amount for each installment

decimal number
NumberOfInstallments

Number of total installments

integer
WithdrawalDates

Available dates fo withdrawal

Collection of integer

Int32

PolicyDetailsBase

NameDescriptionTypeAdditional information
Type

Name of the Policy Details Type, like "Auto", "Home", "Other", "WorkersComp"

string
Properties

Generic Key/Value Property list

Dictionary of string and string

Response Formats

{"Policies":[{"PolicyId":"sample string 1","PolicyNumber":"sample string 2","Status":"sample string 3","Term":"sample string 4","Type":"sample string 5","Premium":6.0,"DueDate":"2020-02-19T12:50:40.183939-08:00","RemainingBalance":8.0,"MinimumAmountDue":9.0,"OtherAmountAllowed":true,"ZipCode":"sample string 11","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-02-19T12:50:40.183939-08:00","Description":"sample string 4","Amount":5.0,"LinkToDownload":"sample string 6"},{"Id":"sample string 1","DocumentId":"sample string 2","Date":"2020-02-19T12:50:40.183939-08:00","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,"IsAutopayEnrolled":true,"NextWithdrawalDate":"2020-02-19T12:50:40.183939-08:00","ResponseCode":"sample string 13","ResponseMessage":"sample string 14"},{"PolicyId":"sample string 1","PolicyNumber":"sample string 2","Status":"sample string 3","Term":"sample string 4","Type":"sample string 5","Premium":6.0,"DueDate":"2020-02-19T12:50:40.183939-08:00","RemainingBalance":8.0,"MinimumAmountDue":9.0,"OtherAmountAllowed":true,"ZipCode":"sample string 11","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-02-19T12:50:40.183939-08:00","Description":"sample string 4","Amount":5.0,"LinkToDownload":"sample string 6"},{"Id":"sample string 1","DocumentId":"sample string 2","Date":"2020-02-19T12:50:40.183939-08:00","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,"IsAutopayEnrolled":true,"NextWithdrawalDate":"2020-02-19T12:50:40.183939-08:00","ResponseCode":"sample string 13","ResponseMessage":"sample string 14"}],"ResponseCode":"sample string 1","ResponseMessage":"sample string 2"}
<GetActivePoliciesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>sample string 1</ResponseCode><ResponseMessage>sample string 2</ResponseMessage><Policies><PolicyDetailsResponse><ResponseCode>sample string 13</ResponseCode><ResponseMessage>sample string 14</ResponseMessage><AutoPayOptions xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts.Policy"><d4p1:FrequencyDetails><d4p1:Amount>2</d4p1:Amount><d4p1:Frequency>sample string 1</d4p1:Frequency><d4p1:NumberOfInstallments>3</d4p1:NumberOfInstallments><d4p1:WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d6p1:int>1</d6p1:int><d6p1:int>2</d6p1:int></d4p1:WithdrawalDates></d4p1:FrequencyDetails><d4p1:FrequencyDetails><d4p1:Amount>2</d4p1:Amount><d4p1:Frequency>sample string 1</d4p1:Frequency><d4p1:NumberOfInstallments>3</d4p1:NumberOfInstallments><d4p1:WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d6p1:int>1</d6p1:int><d6p1:int>2</d6p1:int></d4p1:WithdrawalDates></d4p1:FrequencyDetails></AutoPayOptions><Bills xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts.Policy"><d4p1:BillDetails><d4p1:Amount>5</d4p1:Amount><d4p1:Date>2020-02-19T12:50:40.183939-08:00</d4p1:Date><d4p1:Description>sample string 4</d4p1:Description><d4p1:DocumentId>sample string 2</d4p1:DocumentId><d4p1:Id>sample string 1</d4p1:Id><d4p1:LinkToDownload>sample string 6</d4p1:LinkToDownload></d4p1:BillDetails><d4p1:BillDetails><d4p1:Amount>5</d4p1:Amount><d4p1:Date>2020-02-19T12:50:40.183939-08:00</d4p1:Date><d4p1:Description>sample string 4</d4p1:Description><d4p1:DocumentId>sample string 2</d4p1:DocumentId><d4p1:Id>sample string 1</d4p1:Id><d4p1:LinkToDownload>sample string 6</d4p1:LinkToDownload></d4p1:BillDetails></Bills><Documents xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts.Policy"><d4p1:DocumentDetails><d4p1:Id>sample string 1</d4p1:Id><d4p1:LinkToDownload>sample string 3</d4p1:LinkToDownload><d4p1:Type>sample string 2</d4p1:Type></d4p1:DocumentDetails><d4p1:DocumentDetails><d4p1:Id>sample string 1</d4p1:Id><d4p1:LinkToDownload>sample string 3</d4p1:LinkToDownload><d4p1:Type>sample string 2</d4p1:Type></d4p1:DocumentDetails></Documents><DueDate>2020-02-19T12:50:40.183939-08:00</DueDate><IsAutopayEnrolled>true</IsAutopayEnrolled><MinimumAmountDue>9</MinimumAmountDue><NextWithdrawalDate>2020-02-19T12:50:40.183939-08:00</NextWithdrawalDate><OtherAmountAllowed>true</OtherAmountAllowed><PolicyDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts.Policy" i:nil="true" /><PolicyId>sample string 1</PolicyId><PolicyNumber>sample string 2</PolicyNumber><Premium>6</Premium><RemainingBalance>8</RemainingBalance><Status>sample string 3</Status><Term>sample string 4</Term><Type>sample string 5</Type><ZipCode>sample string 11</ZipCode></PolicyDetailsResponse><PolicyDetailsResponse><ResponseCode>sample string 13</ResponseCode><ResponseMessage>sample string 14</ResponseMessage><AutoPayOptions xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts.Policy"><d4p1:FrequencyDetails><d4p1:Amount>2</d4p1:Amount><d4p1:Frequency>sample string 1</d4p1:Frequency><d4p1:NumberOfInstallments>3</d4p1:NumberOfInstallments><d4p1:WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d6p1:int>1</d6p1:int><d6p1:int>2</d6p1:int></d4p1:WithdrawalDates></d4p1:FrequencyDetails><d4p1:FrequencyDetails><d4p1:Amount>2</d4p1:Amount><d4p1:Frequency>sample string 1</d4p1:Frequency><d4p1:NumberOfInstallments>3</d4p1:NumberOfInstallments><d4p1:WithdrawalDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d6p1:int>1</d6p1:int><d6p1:int>2</d6p1:int></d4p1:WithdrawalDates></d4p1:FrequencyDetails></AutoPayOptions><Bills xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts.Policy"><d4p1:BillDetails><d4p1:Amount>5</d4p1:Amount><d4p1:Date>2020-02-19T12:50:40.183939-08:00</d4p1:Date><d4p1:Description>sample string 4</d4p1:Description><d4p1:DocumentId>sample string 2</d4p1:DocumentId><d4p1:Id>sample string 1</d4p1:Id><d4p1:LinkToDownload>sample string 6</d4p1:LinkToDownload></d4p1:BillDetails><d4p1:BillDetails><d4p1:Amount>5</d4p1:Amount><d4p1:Date>2020-02-19T12:50:40.183939-08:00</d4p1:Date><d4p1:Description>sample string 4</d4p1:Description><d4p1:DocumentId>sample string 2</d4p1:DocumentId><d4p1:Id>sample string 1</d4p1:Id><d4p1:LinkToDownload>sample string 6</d4p1:LinkToDownload></d4p1:BillDetails></Bills><Documents xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts.Policy"><d4p1:DocumentDetails><d4p1:Id>sample string 1</d4p1:Id><d4p1:LinkToDownload>sample string 3</d4p1:LinkToDownload><d4p1:Type>sample string 2</d4p1:Type></d4p1:DocumentDetails><d4p1:DocumentDetails><d4p1:Id>sample string 1</d4p1:Id><d4p1:LinkToDownload>sample string 3</d4p1:LinkToDownload><d4p1:Type>sample string 2</d4p1:Type></d4p1:DocumentDetails></Documents><DueDate>2020-02-19T12:50:40.183939-08:00</DueDate><IsAutopayEnrolled>true</IsAutopayEnrolled><MinimumAmountDue>9</MinimumAmountDue><NextWithdrawalDate>2020-02-19T12:50:40.183939-08:00</NextWithdrawalDate><OtherAmountAllowed>true</OtherAmountAllowed><PolicyDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts.Policy" i:nil="true" /><PolicyId>sample string 1</PolicyId><PolicyNumber>sample string 2</PolicyNumber><Premium>6</Premium><RemainingBalance>8</RemainingBalance><Status>sample string 3</Status><Term>sample string 4</Term><Type>sample string 5</Type><ZipCode>sample string 11</ZipCode></PolicyDetailsResponse></Policies></GetActivePoliciesResponse>

GET api/account/signin/{clientKey}

URI Parameters

NameDescriptionTypeAdditional information
clientKey

string

Required

None.

Response Information

IHttpActionResult

None.

POST api/account/signout

None.

Response Information

SignOutResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<SignOutResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
</SignOutResponse>

GET api/account/subscriptions?CustomerId={CustomerId}&AccountId={AccountId}&PortalOneSessionKey={PortalOneSessionKey}

This endpoint that returns subscription model for an account

URI Parameters

NameDescriptionTypeAdditional information
CustomerId

Client facing customer identifier

string
AccountId

Account Id

string
PortalOneSessionKey

Session key

string

None.

Response Information

AccountSubscriptionsResponse

NameDescriptionTypeAdditional information
Subscriptions

List of subscriptions

Collection of AccountSubscription
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

AccountSubscription

NameDescriptionTypeAdditional information
Type

Subscription Type

AccountSubscriptionType
Status

Subscription Status

AccountSubscriptionStatus
Details

Details

Dictionary of string and string

AccountSubscriptionType

Possible enumeration values:

NameValueDescription
Email

1

Email

Text

2

Text

AccountSubscriptionStatus

Possible enumeration values:

NameValueDescription
Requested

1

Email

Subscribed

2

Subscribed

Unsubscribed

3

Subscribed

Response Formats

{
  "Subscriptions": [
    {
      "Type": 1,
      "Status": 3,
      "Details": {
        "Email": "[email protected]"
      }
    },
    {
      "Type": 2,
      "Status": 2,
      "Details": {
        "PhoneNumber": "19161231234"
      }
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<AccountSubscriptionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>Success</ResponseCode><ResponseMessage i:nil="true" /><Subscriptions><AccountSubscription><Details xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d4p1:KeyValueOfstringstring><d4p1:Key>Email</d4p1:Key><d4p1:Value>[email protected]</d4p1:Value></d4p1:KeyValueOfstringstring></Details><Status>Unsubscribed</Status><Type>Email</Type></AccountSubscription><AccountSubscription><Details xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d4p1:KeyValueOfstringstring><d4p1:Key>PhoneNumber</d4p1:Key><d4p1:Value>19161231234</d4p1:Value></d4p1:KeyValueOfstringstring></Details><Status>Subscribed</Status><Type>Text</Type></AccountSubscription></Subscriptions></AccountSubscriptionsResponse>

POST api/Account/Details

This method is used to get Account Details information

AccountDetailsRequest

NameDescriptionTypeAdditional information
AccountId

Gets or sets Customer's Account Id

string
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "AccountId": "sample string 1",
  "PortalOneSessionKey": "sample string 2"
}
<AccountDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>sample string 2</PortalOneSessionKey>
  <AccountId>sample string 1</AccountId>
</AccountDetailsRequest>

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
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

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": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "AgentLink": "sample string 4",
  "TimeZone": "sample string 5",
  "Phones": [
    {
      "Type": "sample string 1",
      "Number": "sample string 2",
      "Extension": "sample string 3",
      "IsPreferredPhoneNumber": true
    },
    {
      "Type": "sample string 1",
      "Number": "sample string 2",
      "Extension": "sample string 3",
      "IsPreferredPhoneNumber": true
    }
  ],
  "Email": "sample string 6",
  "Addresses": [
    {
      "StreetAddress": "sample string 1",
      "City": "sample string 2",
      "State": "sample string 3",
      "ZipCode": "sample string 4",
      "Country": "sample string 5"
    },
    {
      "StreetAddress": "sample string 1",
      "City": "sample string 2",
      "State": "sample string 3",
      "ZipCode": "sample string 4",
      "Country": "sample string 5"
    }
  ],
  "ResponseCode": "sample string 7",
  "ResponseMessage": "sample string 8"
}
<AccountDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>sample string 7</ResponseCode><ResponseMessage>sample string 8</ResponseMessage><AccountId>sample string 1</AccountId><Addresses><Address><City>sample string 2</City><Country>sample string 5</Country><State>sample string 3</State><StreetAddress>sample string 1</StreetAddress><ZipCode>sample string 4</ZipCode></Address><Address><City>sample string 2</City><Country>sample string 5</Country><State>sample string 3</State><StreetAddress>sample string 1</StreetAddress><ZipCode>sample string 4</ZipCode></Address></Addresses><AgentLink>sample string 4</AgentLink><Email>sample string 6</Email><FirstName>sample string 2</FirstName><LastName>sample string 3</LastName><Phones><Phone><Extension>sample string 3</Extension><IsPreferredPhoneNumber>true</IsPreferredPhoneNumber><Number>sample string 2</Number><Type>sample string 1</Type></Phone><Phone><Extension>sample string 3</Extension><IsPreferredPhoneNumber>true</IsPreferredPhoneNumber><Number>sample string 2</Number><Type>sample string 1</Type></Phone></Phones><TimeZone>sample string 5</TimeZone></AccountDetailsResponse>

POST api/Account/SignUpForTexts

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

SignUpForTextsRequest

NameDescriptionTypeAdditional information
AccountId

Account Id

string
CustomerId

Customer Id

string
PhoneNumber

Phone Number

string

Required

IsSubscribedForTexts

Is subscribed for Texts

boolean

Required

ExtendedParameters

The collection of key value pairs for optional parameters

Dictionary of string and string
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "AccountId": "sample string 1",
  "CustomerId": "sample string 2",
  "PhoneNumber": "sample string 3",
  "IsSubscribedForTexts": true,
  "ExtendedParameters": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "PortalOneSessionKey": "sample string 5"
}
<SignUpForTextsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>sample string 5</PortalOneSessionKey><AccountId>sample string 1</AccountId><CustomerId>sample string 2</CustomerId><ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:KeyValueOfstringstring><d2p1:Key>sample string 1</d2p1:Key><d2p1:Value>sample string 2</d2p1:Value></d2p1:KeyValueOfstringstring><d2p1:KeyValueOfstringstring><d2p1:Key>sample string 3</d2p1:Key><d2p1:Value>sample string 4</d2p1:Value></d2p1:KeyValueOfstringstring></ExtendedParameters><IsSubscribedForTexts>true</IsSubscribedForTexts><PhoneNumber>sample string 3</PhoneNumber></SignUpForTextsRequest>

Response Information

SignUpForTextsResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<SignUpForTextsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
</SignUpForTextsResponse>

POST api/Account/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

string
CustomerId

Customer Id

string
Email

Email

string

Required

IsSubscribedForEmails

Is subscribed for Emails

boolean

Required

ExtendedParameters

The collection of key value pairs for optional parameters

Dictionary of string and string
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "AccountId": "sample string 1",
  "CustomerId": "sample string 2",
  "Email": "sample string 3",
  "IsSubscribedForEmails": true,
  "ExtendedParameters": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "PortalOneSessionKey": "sample string 5"
}
<SignUpForEmailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>sample string 5</PortalOneSessionKey><AccountId>sample string 1</AccountId><CustomerId>sample string 2</CustomerId><Email>sample string 3</Email><ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:KeyValueOfstringstring><d2p1:Key>sample string 1</d2p1:Key><d2p1:Value>sample string 2</d2p1:Value></d2p1:KeyValueOfstringstring><d2p1:KeyValueOfstringstring><d2p1:Key>sample string 3</d2p1:Key><d2p1:Value>sample string 4</d2p1:Value></d2p1:KeyValueOfstringstring></ExtendedParameters><IsSubscribedForEmails>true</IsSubscribedForEmails></SignUpForEmailsRequest>

Response Information

SignUpForEmailsResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<SignUpForEmailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
</SignUpForEmailsResponse>

POST api/Account/UpdateEmail

This method is used to update customer's email.

UpdateEmailRequest

NameDescriptionTypeAdditional information
AccountId

Account Id

string
Email

Email.

string
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "AccountId": "sample string 1",
  "Email": "sample string 2",
  "PortalOneSessionKey": "sample string 3"
}
<UpdateEmailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>sample string 3</PortalOneSessionKey>
  <AccountId>sample string 1</AccountId>
  <Email>sample string 2</Email>
</UpdateEmailRequest>

Response Information

UpdateEmailResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<UpdateEmailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
</UpdateEmailResponse>

Cdn

GET api/Cdn/{portalName}/{relativeJsPath}

This operation generates a js-script using a template downloaded from a portal.

URI Parameters

NameDescriptionTypeAdditional information
portalName

Portal name

string

Required

relativeJsPath

Relative path to js-script template in the portal

string

Required

None.

Response Information

HttpResponseMessage

NameDescriptionTypeAdditional information
Version

Version
Content

HttpContent
StatusCode

HttpStatusCode
ReasonPhrase

string
Headers

Collection of object
RequestMessage

HttpRequestMessage
IsSuccessStatusCode

boolean

Version

NameDescriptionTypeAdditional information
Major

integer
Minor

integer
Build

integer
Revision

integer
MajorRevision

integer
MinorRevision

integer

HttpContent

NameDescriptionTypeAdditional information
Headers

Collection of object

HttpContentHeaders

HttpStatusCode

Possible enumeration values:

NameValueDescription
Continue

100

SwitchingProtocols

101

OK

200

Created

201

Accepted

202

NonAuthoritativeInformation

203

NoContent

204

ResetContent

205

PartialContent

206

MultipleChoices

300

Ambiguous

300

MovedPermanently

301

Moved

301

Found

302

Redirect

302

SeeOther

303

RedirectMethod

303

NotModified

304

UseProxy

305

Unused

306

TemporaryRedirect

307

RedirectKeepVerb

307

BadRequest

400

Unauthorized

401

PaymentRequired

402

Forbidden

403

NotFound

404

MethodNotAllowed

405

NotAcceptable

406

ProxyAuthenticationRequired

407

RequestTimeout

408

Conflict

409

Gone

410

LengthRequired

411

PreconditionFailed

412

RequestEntityTooLarge

413

RequestUriTooLong

414

UnsupportedMediaType

415

RequestedRangeNotSatisfiable

416

ExpectationFailed

417

UpgradeRequired

426

InternalServerError

500

NotImplemented

501

BadGateway

502

ServiceUnavailable

503

GatewayTimeout

504

HttpVersionNotSupported

505

HttpResponseHeaders

HttpRequestMessage

NameDescriptionTypeAdditional information
Version

Version
Content

HttpContent
Method

HttpMethod
RequestUri

URI
Headers

Collection of object
Properties

Dictionary of string and object

HttpMethod

NameDescriptionTypeAdditional information
Method

string

HttpRequestHeaders

User

Account Operations

GET api/user/current

This method is used to get current user's User Details Information

None.

Response Information

UserDetailsResponse

NameDescriptionTypeAdditional information
AccountId

Gets or sets Customer's Account Id

string

Required

CustomerId

Gets or sets Customer's Customer Id

string
FirstName

Gets or sets Customer's First Name

string
LastName

Gets or sets Customer's Last Name

string
Roles

Collection of string
Permissions

Collection of string
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

ListOfString

Response Formats

{
  "AccountId": "75dc458e-565c-40e3-906c-f802b95f4b56",
  "CustomerId": null,
  "FirstName": "John",
  "LastName": "Smith",
  "Roles": [
    "Insured"
  ],
  "Permissions": [
    "MakePayment"
  ],
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<UserDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>Success</ResponseCode><ResponseMessage i:nil="true" /><AccountId>75dc458e-565c-40e3-906c-f802b95f4b56</AccountId><CustomerId i:nil="true" /><FirstName>John</FirstName><LastName>Smith</LastName><Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>MakePayment</d2p1:string></Permissions><Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>Insured</d2p1:string></Roles></UserDetailsResponse>

Policy

GET api/policy/{policyId}/documents/{documentId}

Download Policy document

URI Parameters

NameDescriptionTypeAdditional information
policyId

Policy Id

string

Required

documentId

Document Id

string

Required

None.

Response Information

HttpResponseMessage

NameDescriptionTypeAdditional information
Version

Version
Content

HttpContent
StatusCode

HttpStatusCode
ReasonPhrase

string
Headers

Collection of object
RequestMessage

HttpRequestMessage
IsSuccessStatusCode

boolean

Version

NameDescriptionTypeAdditional information
Major

integer
Minor

integer
Build

integer
Revision

integer
MajorRevision

integer
MinorRevision

integer

HttpContent

NameDescriptionTypeAdditional information
Headers

Collection of object

HttpContentHeaders

HttpStatusCode

Possible enumeration values:

NameValueDescription
Continue

100

SwitchingProtocols

101

OK

200

Created

201

Accepted

202

NonAuthoritativeInformation

203

NoContent

204

ResetContent

205

PartialContent

206

MultipleChoices

300

Ambiguous

300

MovedPermanently

301

Moved

301

Found

302

Redirect

302

SeeOther

303

RedirectMethod

303

NotModified

304

UseProxy

305

Unused

306

TemporaryRedirect

307

RedirectKeepVerb

307

BadRequest

400

Unauthorized

401

PaymentRequired

402

Forbidden

403

NotFound

404

MethodNotAllowed

405

NotAcceptable

406

ProxyAuthenticationRequired

407

RequestTimeout

408

Conflict

409

Gone

410

LengthRequired

411

PreconditionFailed

412

RequestEntityTooLarge

413

RequestUriTooLong

414

UnsupportedMediaType

415

RequestedRangeNotSatisfiable

416

ExpectationFailed

417

UpgradeRequired

426

InternalServerError

500

NotImplemented

501

BadGateway

502

ServiceUnavailable

503

GatewayTimeout

504

HttpVersionNotSupported

505

HttpResponseHeaders

HttpRequestMessage

NameDescriptionTypeAdditional information
Version

Version
Content

HttpContent
Method

HttpMethod
RequestUri

URI
Headers

Collection of object
Properties

Dictionary of string and object

HttpMethod

NameDescriptionTypeAdditional information
Method

string

HttpRequestHeaders

POST api/Policy/GetById

This operation returns Policy Details information.

PolicyDetailsRequest

NameDescriptionTypeAdditional information
PolicyId

An identifier of a Policy

string

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "PolicyId": "sample string 1",
  "PortalOneSessionKey": "sample string 2"
}
<PolicyDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>sample string 2</PortalOneSessionKey>
  <PolicyId>sample string 1</PolicyId>
</PolicyDetailsRequest>

Response Information

PolicyDetailsResponse

NameDescriptionTypeAdditional information
PolicyId

Policy Identifier

string
PolicyNumber

Policy Number

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

Expiration Date of the policy

date
RemainingBalance

Remaining Balance

decimal number
MinimumAmountDue

Minimum Amount Due

decimal number
OtherAmountAllowed

Other Amount Allowed

boolean
ZipCode

Policy Zip Code

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
IsAutopayEnrolled

Is Autopay Enrolled

boolean
NextWithdrawalDate

Next withdrawal date for Autopay

date
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{"PolicyId":"sample string 1","PolicyNumber":"sample string 2","Status":"sample string 3","Term":"sample string 4","Type":"sample string 5","Premium":6.0,"DueDate":"2020-02-19T12:50:41.5903056-08:00","RemainingBalance":8.0,"MinimumAmountDue":9.0,"OtherAmountAllowed":true,"ZipCode":"sample string 11","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-02-19T12:50:41.5903056-08:00","Description":"sample string 4","Amount":5.0,"LinkToDownload":"sample string 6"},{"Id":"sample string 1","DocumentId":"sample string 2","Date":"2020-02-19T12:50:41.5903056-08:00","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,"IsAutopayEnrolled":true,"NextWithdrawalDate":"2020-02-19T12:50:41.5903056-08:00","ResponseCode":"sample string 13","ResponseMessage":"sample string 14"}
<PolicyDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>sample string 13</ResponseCode><ResponseMessage>sample string 14</ResponseMessage><AutoPayOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts.Policy"><d2p1:FrequencyDetails><d2p1:Amount>2</d2p1:Amount><d2p1:Frequency>sample string 1</d2p1:Frequency><d2p1:NumberOfInstallments>3</d2p1:NumberOfInstallments><d2p1:WithdrawalDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d4p1:int>1</d4p1:int><d4p1:int>2</d4p1:int></d2p1:WithdrawalDates></d2p1:FrequencyDetails><d2p1:FrequencyDetails><d2p1:Amount>2</d2p1:Amount><d2p1:Frequency>sample string 1</d2p1:Frequency><d2p1:NumberOfInstallments>3</d2p1:NumberOfInstallments><d2p1:WithdrawalDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d4p1:int>1</d4p1:int><d4p1:int>2</d4p1:int></d2p1:WithdrawalDates></d2p1:FrequencyDetails></AutoPayOptions><Bills xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts.Policy"><d2p1:BillDetails><d2p1:Amount>5</d2p1:Amount><d2p1:Date>2020-02-19T12:50:41.5903056-08:00</d2p1:Date><d2p1:Description>sample string 4</d2p1:Description><d2p1:DocumentId>sample string 2</d2p1:DocumentId><d2p1:Id>sample string 1</d2p1:Id><d2p1:LinkToDownload>sample string 6</d2p1:LinkToDownload></d2p1:BillDetails><d2p1:BillDetails><d2p1:Amount>5</d2p1:Amount><d2p1:Date>2020-02-19T12:50:41.5903056-08:00</d2p1:Date><d2p1:Description>sample string 4</d2p1:Description><d2p1:DocumentId>sample string 2</d2p1:DocumentId><d2p1:Id>sample string 1</d2p1:Id><d2p1:LinkToDownload>sample string 6</d2p1:LinkToDownload></d2p1:BillDetails></Bills><Documents xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts.Policy"><d2p1:DocumentDetails><d2p1:Id>sample string 1</d2p1:Id><d2p1:LinkToDownload>sample string 3</d2p1:LinkToDownload><d2p1:Type>sample string 2</d2p1:Type></d2p1:DocumentDetails><d2p1:DocumentDetails><d2p1:Id>sample string 1</d2p1:Id><d2p1:LinkToDownload>sample string 3</d2p1:LinkToDownload><d2p1:Type>sample string 2</d2p1:Type></d2p1:DocumentDetails></Documents><DueDate>2020-02-19T12:50:41.5903056-08:00</DueDate><IsAutopayEnrolled>true</IsAutopayEnrolled><MinimumAmountDue>9</MinimumAmountDue><NextWithdrawalDate>2020-02-19T12:50:41.5903056-08:00</NextWithdrawalDate><OtherAmountAllowed>true</OtherAmountAllowed><PolicyDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts.Policy" i:nil="true" /><PolicyId>sample string 1</PolicyId><PolicyNumber>sample string 2</PolicyNumber><Premium>6</Premium><RemainingBalance>8</RemainingBalance><Status>sample string 3</Status><Term>sample string 4</Term><Type>sample string 5</Type><ZipCode>sample string 11</ZipCode></PolicyDetailsResponse>

POST api/Policy/Search

This method is used for searching policies

PolicySearchRequest

NameDescriptionTypeAdditional information
PageSize

The number of items to display on a page.

integer

Required

PageNumber

The index of the current page.

integer

Required

Range: inclusive between 1 and 2147483647

SortBy

Defines sorting order. Only one column sorting is supported

string
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

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "PageSize": 1,
  "PageNumber": 2,
  "SortBy": "sample string 3",
  "SearchParameters": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "PortalOneSessionKey": "sample string 4"
}
<PolicySearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>sample string 4</PortalOneSessionKey><PageNumber>2</PageNumber><PageSize>1</PageSize><SearchParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:KeyValueOfstringstring><d2p1:Key>sample string 1</d2p1:Key><d2p1:Value>sample string 2</d2p1:Value></d2p1:KeyValueOfstringstring><d2p1:KeyValueOfstringstring><d2p1:Key>sample string 3</d2p1:Key><d2p1:Value>sample string 4</d2p1:Value></d2p1:KeyValueOfstringstring></SearchParameters><SortBy>sample string 3</SortBy></PolicySearchRequest>

Response Information

PolicySearchResponse

NameDescriptionTypeAdditional information
Results

List of policies matching the search criteria

Collection of PolicyDetailSearchResult
TotalResultsNumber

The total number of policies

integer
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

PolicyDetailSearchResult

NameDescriptionTypeAdditional information
CustomerId

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

string
AccountId

Account Identifier

string
Properties

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

Dictionary of string and string

Response Formats

{
  "Results": [
    {
      "CustomerId": "sample string 1",
      "AccountId": "sample string 2",
      "Properties": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    },
    {
      "CustomerId": "sample string 1",
      "AccountId": "sample string 2",
      "Properties": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    }
  ],
  "TotalResultsNumber": 1,
  "ResponseCode": "sample string 2",
  "ResponseMessage": "sample string 3"
}
<PolicySearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>sample string 2</ResponseCode><ResponseMessage>sample string 3</ResponseMessage><Results><PolicyDetailSearchResult><AccountId>sample string 2</AccountId><CustomerId>sample string 1</CustomerId><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></PolicyDetailSearchResult><PolicyDetailSearchResult><AccountId>sample string 2</AccountId><CustomerId>sample string 1</CustomerId><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></PolicyDetailSearchResult></Results><TotalResultsNumber>1</TotalResultsNumber></PolicySearchResponse>

Card

POST api/Card/SaveMobile

This operation tokenizes all the required information for Apple Pay payment. Once the information is tokenized, you no longer have to provide us any sensitive information to make payments to this card. To initiate transactions with a token simply provide the token that is returned in the SaveMobile results in the ProcessOne RESTful API. Note: the first payment must be made with the token within 30 minutes of the SaveMobile request.

SaveMobileCardRequest

NameDescriptionTypeAdditional information
MobilePaymentToken

Payment data object provided by Apple API.

string

Required

HolderAddress

Optional: Cardholder address

string
HolderZip

Optional: Cardholder zip code

string
HolderName

Optional: Cardholder name

string
CallbackId

A callback id associated to save mobile transaction

string
DisplayName

Optional: Display Name value for card, usually containing last 4 numbers. Acquired from Apple Pay PKPaymentToken object

string
ClientReferenceData

ClientReferenceData

ClientReferenceData
CustomerId

Client facing customer identifier

string
PortalOneSessionKey

Session key

string

ClientReferenceData

NameDescriptionTypeAdditional information
ClientReferenceData1

Used to pass a reference number such as Policy, Quote, or Claim Number. The value will be searchable in the transaction search report.

string
ClientReferenceData2

Used to pass and External TransactionId value. The value will be searchable in the transaction search report.

string
ClientReferenceData3

Used to pass location data such as the office the transaction originated. The value will be searchable in the transaction search report.

string
ClientReferenceData4

Used to pass additional information with the transaction. The value will be displayed in the transaction details.

string
ClientReferenceData5

Used to pass additional reference source account data such as an account number for a multi-policy account. The value will be searchable in the transaction search report.

string

Request Formats

 
{
  "MobilePaymentToken": "PaymentData property of PKPaymentToken",
  "HolderAddress": "620 Coolidge Drive Suite 200 Folsom, CA 95630",
  "HolderZip": "95630",
  "HolderName": "Janet Smith",
  "CallbackId": "2dbe05e1-7a30-41df-8e53-e2b6005bafcf",
  "DisplayName": "MasterCard 1471",
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "CustomerId": "D60039CB-DC29-4B9E-B290-C2C233155B9F",
  "PortalOneSessionKey": "c58cc107-560d-42ca-934f-6a7b4fc6ade3"
}
<SaveMobileCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>c58cc107-560d-42ca-934f-6a7b4fc6ade3</PortalOneSessionKey>
  <CallbackId>2dbe05e1-7a30-41df-8e53-e2b6005bafcf</CallbackId>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <CustomerId>D60039CB-DC29-4B9E-B290-C2C233155B9F</CustomerId>
  <DisplayName>MasterCard 1471</DisplayName>
  <HolderAddress>620 Coolidge Drive Suite 200 Folsom, CA 95630</HolderAddress>
  <HolderName>Janet Smith</HolderName>
  <HolderZip>95630</HolderZip>
  <MobilePaymentToken>PaymentData property of PKPaymentToken</MobilePaymentToken>
</SaveMobileCardRequest>

Response Information

SaveMobileCardResponse

NameDescriptionTypeAdditional information
TransactionId

ProcessOne transaction ID

string
Token

ProcessOne Token

string
TokenCreationTime

Time of token creation

date
TimeZone

Time zone of TokenCreationTime

string
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "TransactionId": "123",
  "Token": "0c489598-d7f9-4f5a-8c91-eeb78e8fd358",
  "TokenCreationTime": "2020-02-19T12:50:42",
  "TimeZone": "PDT",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<SaveMobileCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <TimeZone>PDT</TimeZone>
  <Token>0c489598-d7f9-4f5a-8c91-eeb78e8fd358</Token>
  <TokenCreationTime>2020-02-19T12:50:42</TokenCreationTime>
  <TransactionId>123</TransactionId>
</SaveMobileCardResponse>

POST api/Card/ChargeMobile

This operation allows making a payment using the Apple Pay as a provider, which initiates a transfer of money from a particular customer account to the merchant account. You have to provide a valid payment token in your request.

ChargeMobileCardRequest

NameDescriptionTypeAdditional information
MobilePaymentToken

Payment data object provided by Apple API.

string

Required

HolderAddress

Optional: Cardholder address

string
HolderZip

Optional: Cardholder zip code

string
HolderName

Optional: Cardholder name

string
CallbackId

A callback id associated to charge mobile transaction

string
DisplayName

Optional: Display Name value for card, usually containing last 4 numbers

string
Amount

Charge amount

decimal number

Required

ChargeFee

Should we charge with fee (default - true)

boolean
ConvenienceFeeType

Customizable convenience fee type that is matched with different types of transactions

string
AccountGroupCode

Account group code

string
ClientReferenceData

Client reference data

ClientReferenceData
AcknowledgmentRequired

Indicates that successful payment must be acknowledged by a customer service

boolean
CustomerId

Client facing customer identifier

string
ExtendedParameters

The collection of key value pairs for optional parameters

Dictionary of string and string
AccessToken

AccessToken

globally unique identifier
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "MobilePaymentToken": "PaymentData property of PKPaymentToken",
  "HolderAddress": "620 Coolidge Drive Suite 200 Folsom, CA 95630",
  "HolderZip": "95630",
  "HolderName": "Janet Smith",
  "CallbackId": "8913aefb-0f61-483c-a481-55c176edc045",
  "DisplayName": "MasterCard 1471",
  "Amount": 312.0,
  "ChargeFee": true,
  "ConvenienceFeeType": "Extra",
  "AccountGroupCode": "Default",
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "AcknowledgmentRequired": null,
  "CustomerId": "D60039CB-DC29-4B9E-B290-C2C233155B9F",
  "ExtendedParameters": {
    "CustomerName": "John Smith"
  },
  "AccessToken": null,
  "PortalOneSessionKey": "9eea9b03-06d1-4661-ae45-36211025b640"
}
<ChargeMobileCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>9eea9b03-06d1-4661-ae45-36211025b640</PortalOneSessionKey><AccessToken i:nil="true" /><AcknowledgmentRequired i:nil="true" /><Amount>0</Amount><ClientReferenceData><ClientReferenceData1>POL-123</ClientReferenceData1><ClientReferenceData2>12345</ClientReferenceData2><ClientReferenceData3 i:nil="true" /><ClientReferenceData4 i:nil="true" /><ClientReferenceData5 i:nil="true" /></ClientReferenceData><CustomerId>D60039CB-DC29-4B9E-B290-C2C233155B9F</CustomerId><ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:KeyValueOfstringstring><d2p1:Key>CustomerName</d2p1:Key><d2p1:Value>John Smith</d2p1:Value></d2p1:KeyValueOfstringstring></ExtendedParameters><AccountGroupCode>Default</AccountGroupCode><Amount>312</Amount><CallbackId>8913aefb-0f61-483c-a481-55c176edc045</CallbackId><ChargeFee>true</ChargeFee><ConvenienceFeeType>Extra</ConvenienceFeeType><DisplayName>MasterCard 1471</DisplayName><HolderAddress>620 Coolidge Drive Suite 200 Folsom, CA 95630</HolderAddress><HolderName>Janet Smith</HolderName><HolderZip>95630</HolderZip><MobilePaymentToken>PaymentData property of PKPaymentToken</MobilePaymentToken></ChargeMobileCardRequest>

Response Information

ChargeMobileCardResponse

NameDescriptionTypeAdditional information
AuthorizationCode

A gateway Authorization Code

string
HolderName

Card Holder Name

string
HolderZip

Card Holder Zip code

string
TransactionId

Transaction ID

string
TransactionDate

Transaction date and time

date
TimeZone

Transaction time zone

string
BatchNumber

Number of the batch

integer
ReceiptId

Receipt ID

string
AcknowledgmentDelivered

Indicates that successful payment has been acknowledged by a customer service

boolean
ClientReferenceData1

Reference number such as Policy, Quote, or Claim Number for which payment is made.

string
OriginalAmount

Original amount of the transaction

decimal number
FeeAmount

Fee amount

decimal number
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "AuthorizationCode": "AUX225",
  "HolderName": "Janet Smith",
  "HolderZip": "95630",
  "TransactionId": "123",
  "TransactionDate": "2020-02-19T12:50:42",
  "TimeZone": "PDT",
  "BatchNumber": 10,
  "ReceiptId": "523eb10f-b5fc-460d-a5e1-be83ee695202",
  "AcknowledgmentDelivered": null,
  "ClientReferenceData1": null,
  "OriginalAmount": 0.0,
  "FeeAmount": 0.0,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<ChargeMobileCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <AcknowledgmentDelivered i:nil="true" />
  <BatchNumber>10</BatchNumber>
  <ClientReferenceData1 i:nil="true" />
  <FeeAmount>0</FeeAmount>
  <OriginalAmount>0</OriginalAmount>
  <ReceiptId>523eb10f-b5fc-460d-a5e1-be83ee695202</ReceiptId>
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2020-02-19T12:50:42</TransactionDate>
  <TransactionId>123</TransactionId>
  <AuthorizationCode>AUX225</AuthorizationCode>
  <HolderName>Janet Smith</HolderName>
  <HolderZip>95630</HolderZip>
</ChargeMobileCardResponse>

POST api/Card/Save

This operation tokenizes all the required information about a credit card payment method. Once the card information is tokenized, you no longer have to provide us any sensitive credit card information. To initiate transactions with a tokenized card simply provide the token that is returned by our API.

SaveCardRequest

NameDescriptionTypeAdditional information
Card

Card information

CardDetails

Required

CallbackId

A callback id associated to save transaction

string
ClientReferenceData

Client reference data

ClientReferenceData
CustomerId

Client facing customer identifier

string
IsDefaultPaymentMethod

Is default payment method flag

boolean
PortalOneSessionKey

Session key. Either Session key or Authentication key parameter is required

string
PortalOneAuthenticationKey

Authentication key. Either Session key or Authentication key parameter is required

string

CardDetails

NameDescriptionTypeAdditional information
ExpirationYear

Card expiration year

integer

Required

ExpirationMonth

Card expiration month

integer

Required

Holder

Card holder details

Customer
Number

Card number

string
ValidationValue

Card validation value

string

Customer

NameDescriptionTypeAdditional information
Name

Name

string
Zip

Zip code

string
Address

Address

string

Request Formats

 
{
  "Card": {
    "ExpirationYear": 2021,
    "ExpirationMonth": 1,
    "Holder": {
      "Name": "Janet Smith",
      "Zip": "95630",
      "Address": "620 Coolidge Drive Suite 200 Folsom, CA 95630"
    },
    "Number": "4111111111111111",
    "ValidationValue": "123"
  },
  "CallbackId": "f54730f5-c199-494f-8c96-424eb78d9718",
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "CustomerId": "D60039CB-DC29-4B9E-B290-C2C233155B9F",
  "IsDefaultPaymentMethod": false,
  "PortalOneSessionKey": "1304542e-6102-4ae0-a214-a3cdb15e7a05",
  "PortalOneAuthenticationKey": null
}
<SaveCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneAuthenticationKey i:nil="true" />
  <PortalOneSessionKey>1304542e-6102-4ae0-a214-a3cdb15e7a05</PortalOneSessionKey>
  <CallbackId>f54730f5-c199-494f-8c96-424eb78d9718</CallbackId>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <CustomerId>D60039CB-DC29-4B9E-B290-C2C233155B9F</CustomerId>
  <IsDefaultPaymentMethod>false</IsDefaultPaymentMethod>
  <Card>
    <ExpirationMonth>1</ExpirationMonth>
    <ExpirationYear>2021</ExpirationYear>
    <Holder>
      <Address>620 Coolidge Drive Suite 200 Folsom, CA 95630</Address>
      <Name>Janet Smith</Name>
      <Zip>95630</Zip>
    </Holder>
    <Number>4111111111111111</Number>
    <ValidationValue>123</ValidationValue>
  </Card>
</SaveCardRequest>

Response Information

SaveCardResponse

NameDescriptionTypeAdditional information
BaseCardType

Base Card type

CreditCardType
Token

ProcessOne payment token

string
TokenCreationTime

Token creation date and time in merchant time zone

date
TimeZone

Short time zone name with daylight saving time suffix

string
PaymentMethodId

Related payment method identifier

integer
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

CreditCardType

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

Visa

1

Visa

MasterCard

2

MasterCard

AmericanExpress

3

AmericanExpress

Discover

4

Discover

PinlessDebitGeneric

5

PinlessDebitGeneric

Star

6

Star

Nyce

7

Nyce

Pulse

8

Pulse

Other

99

Other

Response Formats

{
  "BaseCardType": 1,
  "Token": "b379bc99-bee7-472d-a5d9-8b485307d4e5",
  "TokenCreationTime": "2020-02-19T12:50:42",
  "TimeZone": "PDT",
  "PaymentMethodId": null,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<SaveCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <PaymentMethodId i:nil="true" />
  <TimeZone>PDT</TimeZone>
  <Token>b379bc99-bee7-472d-a5d9-8b485307d4e5</Token>
  <TokenCreationTime>2020-02-19T12:50:42</TokenCreationTime>
  <BaseCardType>Visa</BaseCardType>
</SaveCardResponse>

POST api/Card/Charge

This operation allows making a payment with a given credit card, which initiates a transfer of money from a particular customer account to the merchant account. You either have to provide a valid token or include credit card information in your request.

ChargeCardRequest

NameDescriptionTypeAdditional information
ChargeFee

Should we charge with fee (default - true)

boolean
Token

Saved Card token

string
Card

Either Card or token parameter is required. If both are sent, token will be used

CardDetails
IsRecurring

Is recurring charge

boolean
AccountGroupCode

Account group code

string
CallbackId

A callback id associated to charge card transaction

string
Save

Enables to save and tokenize credit card information

boolean
ConvenienceFeeType

Customizable convenience fee type that is matched with different types of transactions

string
Amount

Charge amount

decimal number
ClientReferenceData

Client reference data

ClientReferenceData
AcknowledgmentRequired

Indicates that successful payment must be acknowledged by a customer service

boolean
CustomerId

Client facing customer identifier

string
ExtendedParameters

The collection of key value pairs for optional parameters

Dictionary of string and string
AccessToken

AccessToken

globally unique identifier
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "ChargeFee": true,
  "Token": "b2f22c1a-f3e3-467c-8aae-ccd764f31ab6",
  "Card": null,
  "IsRecurring": false,
  "AccountGroupCode": "Default",
  "CallbackId": "c0296e85-e277-4cae-a49d-b0fa99792616",
  "Save": false,
  "ConvenienceFeeType": "Extra",
  "Amount": 312.0,
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "AcknowledgmentRequired": null,
  "CustomerId": null,
  "ExtendedParameters": {
    "CustomerName": "John Smith",
    "AgentFee": "10"
  },
  "AccessToken": null,
  "PortalOneSessionKey": "daac32cd-9a51-40c9-a04d-de628d69b032"
}
<ChargeCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>daac32cd-9a51-40c9-a04d-de628d69b032</PortalOneSessionKey><AccessToken i:nil="true" /><AcknowledgmentRequired i:nil="true" /><Amount>312</Amount><ClientReferenceData><ClientReferenceData1>POL-123</ClientReferenceData1><ClientReferenceData2>12345</ClientReferenceData2><ClientReferenceData3 i:nil="true" /><ClientReferenceData4 i:nil="true" /><ClientReferenceData5 i:nil="true" /></ClientReferenceData><CustomerId i:nil="true" /><ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:KeyValueOfstringstring><d2p1:Key>CustomerName</d2p1:Key><d2p1:Value>John Smith</d2p1:Value></d2p1:KeyValueOfstringstring><d2p1:KeyValueOfstringstring><d2p1:Key>AgentFee</d2p1:Key><d2p1:Value>10</d2p1:Value></d2p1:KeyValueOfstringstring></ExtendedParameters><AccountGroupCode>Default</AccountGroupCode><CallbackId>c0296e85-e277-4cae-a49d-b0fa99792616</CallbackId><Card i:nil="true" /><ChargeFee>true</ChargeFee><ConvenienceFeeType>Extra</ConvenienceFeeType><IsRecurring>false</IsRecurring><Save>false</Save><Token>b2f22c1a-f3e3-467c-8aae-ccd764f31ab6</Token></ChargeCardRequest>

Response Information

ChargeCardResponse

NameDescriptionTypeAdditional information
Token

ProcessOne payment token

string
AuthorizationCode

A gateway Authorization Code

string
CreditCardType

Credit Card type

CreditCardType
HolderName

Card Holder Name

string
HolderZip

Card Holder Zip code

string
BaseCardType

Base Credit Card type

CreditCardType
TransactionId

Transaction ID

string
TransactionDate

Transaction date and time

date
TimeZone

Transaction time zone

string
BatchNumber

Number of the batch

integer
ReceiptId

Receipt ID

string
AcknowledgmentDelivered

Indicates that successful payment has been acknowledged by a customer service

boolean
ClientReferenceData1

Reference number such as Policy, Quote, or Claim Number for which payment is made.

string
OriginalAmount

Original amount of the transaction

decimal number
FeeAmount

Fee amount

decimal number
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "Token": null,
  "AuthorizationCode": "AUX225",
  "CreditCardType": 1,
  "HolderName": "Janet Smith",
  "HolderZip": "95630",
  "BaseCardType": 1,
  "TransactionId": "123",
  "TransactionDate": "2020-02-19T12:50:42",
  "TimeZone": "PDT",
  "BatchNumber": 10,
  "ReceiptId": "e15a8e37-b93c-4369-a811-913ac7330fde",
  "AcknowledgmentDelivered": null,
  "ClientReferenceData1": null,
  "OriginalAmount": 0.0,
  "FeeAmount": 0.0,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<ChargeCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <AcknowledgmentDelivered i:nil="true" />
  <BatchNumber>10</BatchNumber>
  <ClientReferenceData1 i:nil="true" />
  <FeeAmount>0</FeeAmount>
  <OriginalAmount>0</OriginalAmount>
  <ReceiptId>e15a8e37-b93c-4369-a811-913ac7330fde</ReceiptId>
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2020-02-19T12:50:42</TransactionDate>
  <TransactionId>123</TransactionId>
  <AuthorizationCode>AUX225</AuthorizationCode>
  <BaseCardType>Visa</BaseCardType>
  <CreditCardType>Visa</CreditCardType>
  <HolderName>Janet Smith</HolderName>
  <HolderZip>95630</HolderZip>
  <Token i:nil="true" />
</ChargeCardResponse>

POST api/Card/ChargeCards

This operation allows making payments with a given credit cards, which initiates a transfer of money from a particular customer accounts to the merchant accounts. You either have to provide a valid tokens or include credit cards information in your request.

ChargeCardsRequest

NameDescriptionTypeAdditional information
ChargeCardRequests

Charge Credit card operation requests

Collection of ChargeCardRequest

Required

PortalOneSessionKey

Session key

string

ChargeCardRequest

NameDescriptionTypeAdditional information
ChargeFee

Should we charge with fee (default - true)

boolean
Token

Saved Card token

string
Card

Either Card or token parameter is required. If both are sent, token will be used

CardDetails
IsRecurring

Is recurring charge

boolean
AccountGroupCode

Account group code

string
CallbackId

A callback id associated to charge card transaction

string
Save

Enables to save and tokenize credit card information

boolean
ConvenienceFeeType

Customizable convenience fee type that is matched with different types of transactions

string
Amount

Charge amount

decimal number
ClientReferenceData

Client reference data

ClientReferenceData
AcknowledgmentRequired

Indicates that successful payment must be acknowledged by a customer service

boolean
CustomerId

Client facing customer identifier

string
ExtendedParameters

The collection of key value pairs for optional parameters

Dictionary of string and string
AccessToken

AccessToken

globally unique identifier
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "ChargeCardRequests": [
    {
      "ChargeFee": true,
      "Token": "sample string 2",
      "Card": {
        "ExpirationYear": 1,
        "ExpirationMonth": 1,
        "Holder": {
          "Name": "sample string 1",
          "Zip": "sample string 2",
          "Address": "sample string 3"
        },
        "Number": "sample string 1",
        "ValidationValue": "sample string 2"
      },
      "IsRecurring": true,
      "AccountGroupCode": "sample string 4",
      "CallbackId": "sample string 5",
      "Save": true,
      "ConvenienceFeeType": "sample string 7",
      "Amount": 8.0,
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "AcknowledgmentRequired": true,
      "CustomerId": "sample string 9",
      "ExtendedParameters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "AccessToken": "3befe0c5-0c7d-46eb-b1f4-3542191e365c",
      "PortalOneSessionKey": "sample string 10"
    },
    {
      "ChargeFee": true,
      "Token": "sample string 2",
      "Card": {
        "ExpirationYear": 1,
        "ExpirationMonth": 1,
        "Holder": {
          "Name": "sample string 1",
          "Zip": "sample string 2",
          "Address": "sample string 3"
        },
        "Number": "sample string 1",
        "ValidationValue": "sample string 2"
      },
      "IsRecurring": true,
      "AccountGroupCode": "sample string 4",
      "CallbackId": "sample string 5",
      "Save": true,
      "ConvenienceFeeType": "sample string 7",
      "Amount": 8.0,
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "AcknowledgmentRequired": true,
      "CustomerId": "sample string 9",
      "ExtendedParameters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "AccessToken": "3befe0c5-0c7d-46eb-b1f4-3542191e365c",
      "PortalOneSessionKey": "sample string 10"
    }
  ],
  "PortalOneSessionKey": "sample string 1"
}
<ChargeCardsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>sample string 1</PortalOneSessionKey><ChargeCardRequests><ChargeCardRequest><PortalOneSessionKey>sample string 10</PortalOneSessionKey><AccessToken>3befe0c5-0c7d-46eb-b1f4-3542191e365c</AccessToken><AcknowledgmentRequired>true</AcknowledgmentRequired><Amount>8</Amount><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 9</CustomerId><ExtendedParameters 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></ExtendedParameters><AccountGroupCode>sample string 4</AccountGroupCode><CallbackId>sample string 5</CallbackId><Card><ExpirationMonth>1</ExpirationMonth><ExpirationYear>1</ExpirationYear><Holder><Address>sample string 3</Address><Name>sample string 1</Name><Zip>sample string 2</Zip></Holder><Number>sample string 1</Number><ValidationValue>sample string 2</ValidationValue></Card><ChargeFee>true</ChargeFee><ConvenienceFeeType>sample string 7</ConvenienceFeeType><IsRecurring>true</IsRecurring><Save>true</Save><Token>sample string 2</Token></ChargeCardRequest><ChargeCardRequest><PortalOneSessionKey>sample string 10</PortalOneSessionKey><AccessToken>3befe0c5-0c7d-46eb-b1f4-3542191e365c</AccessToken><AcknowledgmentRequired>true</AcknowledgmentRequired><Amount>8</Amount><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 9</CustomerId><ExtendedParameters 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></ExtendedParameters><AccountGroupCode>sample string 4</AccountGroupCode><CallbackId>sample string 5</CallbackId><Card><ExpirationMonth>1</ExpirationMonth><ExpirationYear>1</ExpirationYear><Holder><Address>sample string 3</Address><Name>sample string 1</Name><Zip>sample string 2</Zip></Holder><Number>sample string 1</Number><ValidationValue>sample string 2</ValidationValue></Card><ChargeFee>true</ChargeFee><ConvenienceFeeType>sample string 7</ConvenienceFeeType><IsRecurring>true</IsRecurring><Save>true</Save><Token>sample string 2</Token></ChargeCardRequest></ChargeCardRequests></ChargeCardsRequest>

Response Information

ChargeCardsResponse

NameDescriptionTypeAdditional information
ChargeCardResponses

Charge Credit card operation responses

Collection of ChargeCardResponse
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

ChargeCardResponse

NameDescriptionTypeAdditional information
Token

ProcessOne payment token

string
AuthorizationCode

A gateway Authorization Code

string
CreditCardType

Credit Card type

CreditCardType
HolderName

Card Holder Name

string
HolderZip

Card Holder Zip code

string
BaseCardType

Base Credit Card type

CreditCardType
TransactionId

Transaction ID

string
TransactionDate

Transaction date and time

date
TimeZone

Transaction time zone

string
BatchNumber

Number of the batch

integer
ReceiptId

Receipt ID

string
AcknowledgmentDelivered

Indicates that successful payment has been acknowledged by a customer service

boolean
ClientReferenceData1

Reference number such as Policy, Quote, or Claim Number for which payment is made.

string
OriginalAmount

Original amount of the transaction

decimal number
FeeAmount

Fee amount

decimal number
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "ChargeCardResponses": [
    {
      "Token": "sample string 1",
      "AuthorizationCode": "sample string 2",
      "CreditCardType": 0,
      "HolderName": "sample string 3",
      "HolderZip": "sample string 4",
      "BaseCardType": 0,
      "TransactionId": "sample string 5",
      "TransactionDate": "2020-02-19T12:50:43",
      "TimeZone": "sample string 6",
      "BatchNumber": 7,
      "ReceiptId": "sample string 8",
      "AcknowledgmentDelivered": true,
      "ClientReferenceData1": "sample string 9",
      "OriginalAmount": 10.0,
      "FeeAmount": 11.0,
      "ResponseCode": "sample string 12",
      "ResponseMessage": "sample string 13"
    },
    {
      "Token": "sample string 1",
      "AuthorizationCode": "sample string 2",
      "CreditCardType": 0,
      "HolderName": "sample string 3",
      "HolderZip": "sample string 4",
      "BaseCardType": 0,
      "TransactionId": "sample string 5",
      "TransactionDate": "2020-02-19T12:50:43",
      "TimeZone": "sample string 6",
      "BatchNumber": 7,
      "ReceiptId": "sample string 8",
      "AcknowledgmentDelivered": true,
      "ClientReferenceData1": "sample string 9",
      "OriginalAmount": 10.0,
      "FeeAmount": 11.0,
      "ResponseCode": "sample string 12",
      "ResponseMessage": "sample string 13"
    }
  ],
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<ChargeCardsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>sample string 1</ResponseCode><ResponseMessage>sample string 2</ResponseMessage><ChargeCardResponses><ChargeCardResponse><ResponseCode>sample string 12</ResponseCode><ResponseMessage>sample string 13</ResponseMessage><AcknowledgmentDelivered>true</AcknowledgmentDelivered><BatchNumber>7</BatchNumber><ClientReferenceData1>sample string 9</ClientReferenceData1><FeeAmount>11</FeeAmount><OriginalAmount>10</OriginalAmount><ReceiptId>sample string 8</ReceiptId><TimeZone>sample string 6</TimeZone><TransactionDate>2020-02-19T12:50:43.0134429-08:00</TransactionDate><TransactionId>sample string 5</TransactionId><AuthorizationCode>sample string 2</AuthorizationCode><BaseCardType>Undefined</BaseCardType><CreditCardType>Undefined</CreditCardType><HolderName>sample string 3</HolderName><HolderZip>sample string 4</HolderZip><Token>sample string 1</Token></ChargeCardResponse><ChargeCardResponse><ResponseCode>sample string 12</ResponseCode><ResponseMessage>sample string 13</ResponseMessage><AcknowledgmentDelivered>true</AcknowledgmentDelivered><BatchNumber>7</BatchNumber><ClientReferenceData1>sample string 9</ClientReferenceData1><FeeAmount>11</FeeAmount><OriginalAmount>10</OriginalAmount><ReceiptId>sample string 8</ReceiptId><TimeZone>sample string 6</TimeZone><TransactionDate>2020-02-19T12:50:43.0134429-08:00</TransactionDate><TransactionId>sample string 5</TransactionId><AuthorizationCode>sample string 2</AuthorizationCode><BaseCardType>Undefined</BaseCardType><CreditCardType>Undefined</CreditCardType><HolderName>sample string 3</HolderName><HolderZip>sample string 4</HolderZip><Token>sample string 1</Token></ChargeCardResponse></ChargeCardResponses></ChargeCardsResponse>

POST api/Card/GetAcceptedCardTypes

This operation returns available card types.

GetAcceptedCardTypesRequest

NameDescriptionTypeAdditional information
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "PortalOneSessionKey": "8609a821-c7ef-468f-b944-fa810d79f486"
}
<GetAcceptedCardTypesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>8609a821-c7ef-468f-b944-fa810d79f486</PortalOneSessionKey>
</GetAcceptedCardTypesRequest>

Response Information

GetAcceptedCardTypesResponse

NameDescriptionTypeAdditional information
AcceptedCardTypes

Accepted card types

Collection of string
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

IEnumerableOfString

Response Formats

{
  "AcceptedCardTypes": [
    "Visa",
    "MasterCard",
    "AmericanExpress"
  ],
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetAcceptedCardTypesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>Success</ResponseCode><ResponseMessage i:nil="true" /><AcceptedCardTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>Visa</d2p1:string><d2p1:string>MasterCard</d2p1:string><d2p1:string>AmericanExpress</d2p1:string></AcceptedCardTypes></GetAcceptedCardTypesResponse>

POST api/Card/ValidateBin

This operation returns card information.

ValidateBinRequest

NameDescriptionTypeAdditional information
CardNumber

Card number

string

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "CardNumber": "4111111111111111",
  "PortalOneSessionKey": "5d34897a-1d92-472c-a29a-fb3f434ff2ac"
}
<ValidateBinRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>5d34897a-1d92-472c-a29a-fb3f434ff2ac</PortalOneSessionKey>
  <CardNumber>4111111111111111</CardNumber>
</ValidateBinRequest>

Response Information

ValidateBinResponse

NameDescriptionTypeAdditional information
CreditCardNetworkType

Credit Card Network type

CreditCardNetworkType
BaseCardType

Credit Card type

CreditCardType
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

CreditCardNetworkType

Possible enumeration values:

NameValueDescription
Unknown

0

Unknown

Hybrid

1

Hybrid

Debit

2

Debit

Credit

3

Credit

Response Formats

{
  "CreditCardNetworkType": 3,
  "BaseCardType": 1,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<ValidateBinResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <BaseCardType>Visa</BaseCardType>
  <CreditCardNetworkType>Credit</CreditCardNetworkType>
</ValidateBinResponse>

POST api/Card/GetConvenienceFee

This operation returns convenience fee.

GetCardConvenienceFeeRequest

NameDescriptionTypeAdditional information
ChargeAmount

Charge amount

decimal number

Required

ConvenienceFeeType

Convenience fee type

string

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "ChargeAmount": 100.0,
  "ConvenienceFeeType": "PaymentWithFee",
  "PortalOneSessionKey": "2b330847-b642-4d4b-832a-8778310eb43c"
}
<GetCardConvenienceFeeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>2b330847-b642-4d4b-832a-8778310eb43c</PortalOneSessionKey>
  <ChargeAmount>100</ChargeAmount>
  <ConvenienceFeeType>PaymentWithFee</ConvenienceFeeType>
</GetCardConvenienceFeeRequest>

Response Information

GetCardConvenienceFeeResponse

NameDescriptionTypeAdditional information
ConvenienceFee

Convenience fee amount

decimal number
CalculationType

Calculation type

string
FlatRate

Flat rate

decimal number
Percent

Percent

decimal number
MinimumAmount

Minimum amount

decimal number
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "ConvenienceFee": 5.0,
  "CalculationType": "FlatRate",
  "FlatRate": 5.0,
  "Percent": null,
  "MinimumAmount": null,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetCardConvenienceFeeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <CalculationType>FlatRate</CalculationType>
  <ConvenienceFee>5</ConvenienceFee>
  <FlatRate>5</FlatRate>
  <MinimumAmount i:nil="true" />
  <Percent i:nil="true" />
</GetCardConvenienceFeeResponse>

POST api/Card/GetConvenienceFeesList

This operation returns convenience fees for a list of policies.

GetConvenienceFeesListCardRequest

NameDescriptionTypeAdditional information
ChargeAmounts

Charge amounts

Collection of ConvenienceFeeRequestItem

Required

PortalOneSessionKey

Session key

string

IEnumerableOfConvenienceFeeRequestItem

NameDescriptionTypeAdditional information
PolicyId

policy identifier

string

Required

ChargeAmount

Charge amount

decimal number

Required

ConvenienceFeeType

fee type

string

Required

Request Formats

 
{
  "ChargeAmounts": [
    {
      "PolicyId": "sample string 1",
      "ChargeAmount": 1.0,
      "ConvenienceFeeType": "sample string 2"
    },
    {
      "PolicyId": "sample string 1",
      "ChargeAmount": 1.0,
      "ConvenienceFeeType": "sample string 2"
    }
  ],
  "PortalOneSessionKey": "sample string 1"
}
<GetConvenienceFeesListCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>sample string 1</PortalOneSessionKey><ChargeAmounts><ConvenienceFeeRequestItem><ChargeAmount>1</ChargeAmount><ConvenienceFeeType>sample string 2</ConvenienceFeeType><PolicyId>sample string 1</PolicyId></ConvenienceFeeRequestItem><ConvenienceFeeRequestItem><ChargeAmount>1</ChargeAmount><ConvenienceFeeType>sample string 2</ConvenienceFeeType><PolicyId>sample string 1</PolicyId></ConvenienceFeeRequestItem></ChargeAmounts></GetConvenienceFeesListCardRequest>

Response Information

GetConvenienceFeesListCardResponse

NameDescriptionTypeAdditional information
FeesList

Collection of ConvenienceFeeResult
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

IEnumerableOfConvenienceFeeResult

NameDescriptionTypeAdditional information
PolicyId

Policy identifier

string
ConvenienceFee

Convenience fee amount

decimal number
CalculationType

Calculation type

string
FlatRate

Flat rate

decimal number
Percent

Percent

decimal number
MinimumAmount

Minimum amount

decimal number

Response Formats

{
  "FeesList": [
    {
      "PolicyId": "sample string 1",
      "ConvenienceFee": 2.0,
      "CalculationType": "sample string 3",
      "FlatRate": 1.0,
      "Percent": 1.0,
      "MinimumAmount": 1.0
    },
    {
      "PolicyId": "sample string 1",
      "ConvenienceFee": 2.0,
      "CalculationType": "sample string 3",
      "FlatRate": 1.0,
      "Percent": 1.0,
      "MinimumAmount": 1.0
    }
  ],
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<GetConvenienceFeesListCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>sample string 1</ResponseCode><ResponseMessage>sample string 2</ResponseMessage><FeesList><ConvenienceFeeResult><CalculationType>sample string 3</CalculationType><ConvenienceFee>2</ConvenienceFee><FlatRate>1</FlatRate><MinimumAmount>1</MinimumAmount><Percent>1</Percent><PolicyId>sample string 1</PolicyId></ConvenienceFeeResult><ConvenienceFeeResult><CalculationType>sample string 3</CalculationType><ConvenienceFee>2</ConvenienceFee><FlatRate>1</FlatRate><MinimumAmount>1</MinimumAmount><Percent>1</Percent><PolicyId>sample string 1</PolicyId></ConvenienceFeeResult></FeesList></GetConvenienceFeesListCardResponse>

POST api/Card/Update

This method updates card information.

UpdateCardRequest

NameDescriptionTypeAdditional information
Token

ProcessOne payment token

string

Required

ExpirationYear

Card expiration year

integer

Required

ExpirationMonth

Card expiration month

integer

Required

HolderZip

Card holder ZIP

string

Required

HolderAddress

Card holder address

string

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "Token": "54546eed-316c-45e4-a9ea-e279a679a4c3",
  "ExpirationYear": 2021,
  "ExpirationMonth": 1,
  "HolderZip": "12345",
  "HolderAddress": "64, Force Hill Rd, Livingston, NJ",
  "PortalOneSessionKey": "61d71610-5e31-4ac7-9cef-a9c84a0250ea"
}
<UpdateCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>61d71610-5e31-4ac7-9cef-a9c84a0250ea</PortalOneSessionKey>
  <ExpirationMonth>1</ExpirationMonth>
  <ExpirationYear>2021</ExpirationYear>
  <HolderAddress>64, Force Hill Rd, Livingston, NJ</HolderAddress>
  <HolderZip>12345</HolderZip>
  <Token>54546eed-316c-45e4-a9ea-e279a679a4c3</Token>
</UpdateCardRequest>

Response Information

UpdateCardResponse

NameDescriptionTypeAdditional information
TimeZone

Time zone

string
UpdateTime

Card update time

date
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "TimeZone": "PST",
  "UpdateTime": "2020-02-19T12:50:43",
  "ResponseCode": "Success",
  "ResponseMessage": "Successfully saved"
}
<UpdateCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage>Successfully saved</ResponseMessage>
  <TimeZone>PST</TimeZone>
  <UpdateTime>2020-02-19T12:50:43</UpdateTime>
</UpdateCardResponse>

POST api/Card/AcknowledgePayment

This method allows acknowledge successful payment

AcknowledgePaymentRequest

NameDescriptionTypeAdditional information
TransactionId

Transaction Id

string

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "TransactionId": "123",
  "PortalOneSessionKey": "e05f7611-27c4-4ce4-9eaa-174fa5afe668"
}
<AcknowledgePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>e05f7611-27c4-4ce4-9eaa-174fa5afe668</PortalOneSessionKey>
  <TransactionId>123</TransactionId>
</AcknowledgePaymentRequest>

Response Information

AcknowledgePaymentResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": null
}
<AcknowledgePaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
</AcknowledgePaymentResponse>

POST api/Card/GetApplePaySettings

This method returns current ApplePay settings

GetApplePaySettingsRequest

NameDescriptionTypeAdditional information
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "PortalOneSessionKey": "sample string 1"
}
<GetApplePaySettingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>sample string 1</PortalOneSessionKey>
</GetApplePaySettingsRequest>

Response Information

GetApplePaySettingsResponse

NameDescriptionTypeAdditional information
IsEnabled

Is ApplePay processing enabled

boolean
MerchantIdentifier

Merchant identifier as

string
CountryCode

Country code

string
CurrencyCode

Currency code

string
MerchantDisplayName

Display name shown in the ApplePay payment information

string
SupportedNetworks

Supported card networks for ApplePay

Collection of string
MerchantCapabilities

ApplePay merchant capabilities

Collection of string
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "IsEnabled": true,
  "MerchantIdentifier": "sample string 2",
  "CountryCode": "sample string 3",
  "CurrencyCode": "sample string 4",
  "MerchantDisplayName": "sample string 5",
  "SupportedNetworks": [
    "sample string 1",
    "sample string 2"
  ],
  "MerchantCapabilities": [
    "sample string 1",
    "sample string 2"
  ],
  "ResponseCode": "sample string 6",
  "ResponseMessage": "sample string 7"
}
<GetApplePaySettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>sample string 6</ResponseCode><ResponseMessage>sample string 7</ResponseMessage><CountryCode>sample string 3</CountryCode><CurrencyCode>sample string 4</CurrencyCode><IsEnabled>true</IsEnabled><MerchantCapabilities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>sample string 1</d2p1:string><d2p1:string>sample string 2</d2p1:string></MerchantCapabilities><MerchantDisplayName>sample string 5</MerchantDisplayName><MerchantIdentifier>sample string 2</MerchantIdentifier><SupportedNetworks xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>sample string 1</d2p1:string><d2p1:string>sample string 2</d2p1:string></SupportedNetworks></GetApplePaySettingsResponse>

AccessToken

Deep Link operations

POST api/AccessToken/Create

Create new AccessToken with associated data

CreateAccessTokenRequest

NameDescriptionTypeAdditional information
PortalOneAuthenticationKey

Authentication

string

Required

Type

AccessToken type

AccessTokenType
Payload

Data to store

object
ExpirationDate

Date of the token expiration

date

AccessTokenType

Possible enumeration values:

NameValueDescription
Client

1

Client token

Server

2

Server token

Request Formats

 
{
  "PortalOneAuthenticationKey": "sample string 1",
  "Type": 1,
  "Payload": {},
  "ExpirationDate": "2020-02-19T12:50:44"
}
<CreateAccessTokenRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ExpirationDate>2020-02-19T12:50:44</ExpirationDate>
  <Payload />
  <PortalOneAuthenticationKey>sample string 1</PortalOneAuthenticationKey>
  <Type>Client</Type>
</CreateAccessTokenRequest>

Response Information

CreateAccessTokenResponse

NameDescriptionTypeAdditional information
Token

AccessToken

globally unique identifier
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "Token": "5049751c-cc2d-4691-8d06-a6709a3259e5",
  "ResponseCode": "sample string 2",
  "ResponseMessage": "sample string 3"
}
<CreateAccessTokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Token>5049751c-cc2d-4691-8d06-a6709a3259e5</Token>
</CreateAccessTokenResponse>

GET api/AccessToken/Get?Token={Token}&PortalOneSessionKey={PortalOneSessionKey}

Get data by access token

URI Parameters

NameDescriptionTypeAdditional information
Token

AccessToken

globally unique identifier

Required

PortalOneSessionKey

Session key

string

None.

Response Information

GetAccessTokenResponse

NameDescriptionTypeAdditional information
Status

string
Payload

string
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "Status": "sample string 1",
  "Payload": "sample string 2",
  "ResponseCode": "sample string 3",
  "ResponseMessage": "sample string 4"
}
<GetAccessTokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 3</ResponseCode>
  <ResponseMessage>sample string 4</ResponseMessage>
  <Payload>sample string 2</Payload>
  <Status>sample string 1</Status>
</GetAccessTokenResponse>

GET api/AccessToken/Redirect?Token={Token}&PortalOneSessionKey={PortalOneSessionKey}

Redirect to url in payload

URI Parameters

NameDescriptionTypeAdditional information
Token

AccessToken

globally unique identifier

Required

PortalOneSessionKey

Session key

string

None.

Response Information

IHttpActionResult

None.

PaymentToken

POST api/PaymentToken/GetInfo

This operation provides information about a saved Credit Card or EFT payment method that corresponds to a specific token. A valid token and a valid session key must be provided in order to retrieve information.

GetTokenInfoRequest

NameDescriptionTypeAdditional information
Token

Payment token

string

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "Token": "sample string 1",
  "PortalOneSessionKey": "sample string 2"
}
<GetTokenInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>sample string 2</PortalOneSessionKey>
  <Token>sample string 1</Token>
</GetTokenInfoRequest>

Response Information

GetTokenInfoResponse

NameDescriptionTypeAdditional information
TokenType

Token type

TokenType
Eft

EFT details

TokenEftInfo
CreditCard

Credit card details

TokenCreditCardInfo
ClientReferenceData

Client reference data

ClientReferenceData
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

TokenType

Possible enumeration values:

NameValueDescription
CreditCard

0

Eft

1

TokenEftInfo

NameDescriptionTypeAdditional information
RoutingNumber

The bank routing number. Must only contain numbers.

string
LastFourDigits

Last 4 digits of account number

string
Type

EFT account type - Checking / Savings

EftAccountType
CustomerName

Customer name

string

EftAccountType

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

Checking

1

Checking

Savings

2

Savings

TokenCreditCardInfo

NameDescriptionTypeAdditional information
LastFourDigits

Last 4 digits of credit card number

string
Type

Credit card type

CreditCardType
ExpirationYear

Year of the expiration of the credit card

integer
ExpirationMonth

Month of the expiration of the credit card

integer
Holder

Card holder

Customer
BaseCardType

Base Credit Card type

CreditCardType

Response Formats

{
  "TokenType": 0,
  "Eft": {
    "RoutingNumber": "sample string 1",
    "LastFourDigits": "sample string 2",
    "Type": 0,
    "CustomerName": "sample string 3"
  },
  "CreditCard": {
    "LastFourDigits": "sample string 1",
    "Type": 0,
    "ExpirationYear": 1,
    "ExpirationMonth": 1,
    "Holder": {
      "Name": "sample string 1",
      "Zip": "sample string 2",
      "Address": "sample string 3"
    },
    "BaseCardType": 0
  },
  "ClientReferenceData": {
    "ClientReferenceData1": "sample string 1",
    "ClientReferenceData2": "sample string 2",
    "ClientReferenceData3": "sample string 3",
    "ClientReferenceData4": "sample string 4",
    "ClientReferenceData5": "sample string 5"
  },
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<GetTokenInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
  <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>
  <CreditCard>
    <BaseCardType>Undefined</BaseCardType>
    <ExpirationMonth>1</ExpirationMonth>
    <ExpirationYear>1</ExpirationYear>
    <Holder>
      <Address>sample string 3</Address>
      <Name>sample string 1</Name>
      <Zip>sample string 2</Zip>
    </Holder>
    <LastFourDigits>sample string 1</LastFourDigits>
    <Type>Undefined</Type>
  </CreditCard>
  <Eft>
    <CustomerName>sample string 3</CustomerName>
    <LastFourDigits>sample string 2</LastFourDigits>
    <RoutingNumber>sample string 1</RoutingNumber>
    <Type>Undefined</Type>
  </Eft>
  <TokenType>CreditCard</TokenType>
</GetTokenInfoResponse>

Session

GET api/Session/Create?PortalOneAuthenticationKey={PortalOneAuthenticationKey}&ProcessOneAuthenticationKey={ProcessOneAuthenticationKey}&CustomerId={CustomerId}

This operation is used to initiate the API session, and creates the PortalOneSessionKey. Once the PortalOneSessionKey is created, you can use it to access other PortalOne API operations.

URI Parameters

NameDescriptionTypeAdditional information
PortalOneAuthenticationKey

Authentication key

string

Required

ProcessOneAuthenticationKey

Unique identifier for ProcessOne Instance

string
CustomerId

Client facing customer identifier

globally unique identifier

None.

Response Information

CreateSessionResponse

NameDescriptionTypeAdditional information
PortalOneSessionKey

Session key

string
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "PortalOneSessionKey": "207f18d5-4fc1-4551-9baa-41f43c62de8a",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<CreateSessionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <PortalOneSessionKey>207f18d5-4fc1-4551-9baa-41f43c62de8a</PortalOneSessionKey>
</CreateSessionResponse>

POST api/Session/Validate

ValidateSessionRequest

NameDescriptionTypeAdditional information
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "PortalOneSessionKey": "sample string 1"
}
<ValidateSessionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>sample string 1</PortalOneSessionKey>
</ValidateSessionRequest>

Response Information

ValidateSessionResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<ValidateSessionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
</ValidateSessionResponse>

POST api/Session/OpenApplePaySession

This method is used to contact Apple Pay server to open and validate Apple Pay payment session

OpenApplePaySessionRequest

NameDescriptionTypeAdditional information
ValidationUrl

Url received from ApplePay JS

string

Required

Data type: Url

DisplayName

Name for displaying on the ApplePay payment sheet

string
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "ValidationUrl": "sample string 1",
  "DisplayName": "sample string 2",
  "PortalOneSessionKey": "sample string 3"
}
<OpenApplePaySessionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>sample string 3</PortalOneSessionKey>
  <DisplayName>sample string 2</DisplayName>
  <ValidationUrl>sample string 1</ValidationUrl>
</OpenApplePaySessionRequest>

Response Information

OpenApplePaySessionResponse

NameDescriptionTypeAdditional information
PaymentSession

Object returned from Apple Pay server which is used to open the session

string
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "PaymentSession": "sample string 1",
  "ResponseCode": "sample string 2",
  "ResponseMessage": "sample string 3"
}
<OpenApplePaySessionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <PaymentSession>sample string 1</PaymentSession>
</OpenApplePaySessionResponse>

Template

POST api/Template/GetImage

This operation returns image data.

GetImageRequest

NameDescriptionTypeAdditional information
ImageId

Image identifier

integer

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "ImageId": 1,
  "PortalOneSessionKey": "3fe70c72-1ae9-44ec-8ecc-8f2b8726ba47"
}
<GetImageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>3fe70c72-1ae9-44ec-8ecc-8f2b8726ba47</PortalOneSessionKey>
  <ImageId>1</ImageId>
</GetImageRequest>

Response Information

GetImageResponse

NameDescriptionTypeAdditional information
FileData

Image file data

FileData
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

FileData

NameDescriptionTypeAdditional information
FileDataId

File data identifier

integer
Guid

Unique identifier

globally unique identifier
Created

Date time when file data was created

date
Data

File content

Collection of byte
Name

File name

string

Byte

Response Formats

{
  "FileData": {
    "FileDataId": 1,
    "Guid": "5ee3f17e-5c05-486c-8f06-71294a7ecf9f",
    "Created": "2020-02-19T12:50:44",
    "Data": "AmyOrVZzkUO13EVsoGCKdQ==",
    "Name": "SampleImage"
  },
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetImageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <FileData>
    <Created>2020-02-19T12:50:44</Created>
    <Data>AmyOrVZzkUO13EVsoGCKdQ==</Data>
    <FileDataId>1</FileDataId>
    <Guid>5ee3f17e-5c05-486c-8f06-71294a7ecf9f</Guid>
    <Name>SampleImage</Name>
  </FileData>
</GetImageResponse>

GET api/Template/GetImageByGuid?ImageGuid={ImageGuid}&PortalOneSessionKey={PortalOneSessionKey}

This operation returns image data.

URI Parameters

NameDescriptionTypeAdditional information
ImageGuid

Image identifier

globally unique identifier

Required

PortalOneSessionKey

Session key

string

None.

Response Information

GetImageByGuidResponse

NameDescriptionTypeAdditional information
FileContent

Image file content

Collection of byte
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "FileContent": null,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetImageByGuidResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <FileContent i:nil="true" />
</GetImageByGuidResponse>

POST api/Template/GetPortalScreenFlows

This operation returns ScreenFlows for requested operation in portal.

GetScreenFlowsBatchRequest

NameDescriptionTypeAdditional information
ScreenFlowNames

ScreenFlow names

Collection of string
PortalOneSessionKey

Session key

string

String

Request Formats

 
{
  "ScreenFlowNames": [
    "makePayment"
  ],
  "PortalOneSessionKey": "b7a9142b-20ad-4c6e-b5ca-129fbf8a8348"
}
<GetScreenFlowsBatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>b7a9142b-20ad-4c6e-b5ca-129fbf8a8348</PortalOneSessionKey><ScreenFlowNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>makePayment</d2p1:string></ScreenFlowNames></GetScreenFlowsBatchRequest>

Response Information

GetScreenFlowsBatchResponse

NameDescriptionTypeAdditional information
ScreenFlows

ScreenFlows

Dictionary of string and string
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "ScreenFlows": {
    "makePayment": "{ \"componentInjectionToken\": \"PlaceholderStackComponent\", \"data\": { \"componentList\": [ { \"componentInjectionToken\": \"PciBarWidget\", \"data\": { } }, { \"componentInjectionToken\": \"AddPaymentMethodPage\", \"data\": { } }, { \"componentInjectionToken\": \"InlineAlertWidget\", \"data\": { \"componentDefinition\": { \"componentInjectionToken\": \"InlineAlertControl\", \"data\": { } } } } ] } }"
  },
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetScreenFlowsBatchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>Success</ResponseCode><ResponseMessage i:nil="true" /><ScreenFlows xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:KeyValueOfstringstring><d2p1:Key>makePayment</d2p1:Key><d2p1:Value>{ "componentInjectionToken": "PlaceholderStackComponent", "data": { "componentList": [ { "componentInjectionToken": "PciBarWidget", "data": { } }, { "componentInjectionToken": "AddPaymentMethodPage", "data": { } }, { "componentInjectionToken": "InlineAlertWidget", "data": { "componentDefinition": { "componentInjectionToken": "InlineAlertControl", "data": { } } } } ] } }</d2p1:Value></d2p1:KeyValueOfstringstring></ScreenFlows></GetScreenFlowsBatchResponse>

POST api/Template/GetPortalConfiguration

This operation returns configuration for the current portal.

GetPortalConfigurationRequest

NameDescriptionTypeAdditional information
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "PortalOneSessionKey": "sample string 1"
}
<GetPortalConfigurationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>sample string 1</PortalOneSessionKey>
</GetPortalConfigurationRequest>

Response Information

GetPortalConfigurationResponse

NameDescriptionTypeAdditional information
PortalSettings

Portal Settings

PortalSettings
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

PortalSettings

NameDescriptionTypeAdditional information
IsWalletActivated

Indicates that wallet functionality is activated

boolean
MaxPaymentAmount

Maximum allowed payment amount

decimal number
CardExpirationDateFormat

Card expiration date display format

string
ApplePayMerchantIdentifier

Merchant identifier for Apple Pay

string
DefaultPortalFeeContext

Default fee context for portal Possible values are: "PaymentWithFee" and "PaymentWithoutFee"

string
AllowedPaymentTypes

Allowed payment types for portal. Possible values are: "CreditCard", "Eft", "ApplePay"

Collection of string
ClientName

Refers to portal setting 'ClientName'.

string
TermsOfServiceUrl

Link for Terms Of Services

string
MaxAllowedPaymentsCountPerRequest

The maximum allowed number of payments that can be made within one request. Refers to Multi Pay feature

integer

Response Formats

{
  "PortalSettings": {
    "IsWalletActivated": true,
    "MaxPaymentAmount": 1.0,
    "CardExpirationDateFormat": "sample string 2",
    "ApplePayMerchantIdentifier": "sample string 3",
    "DefaultPortalFeeContext": "sample string 4",
    "AllowedPaymentTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "ClientName": "sample string 5",
    "TermsOfServiceUrl": "sample string 6",
    "MaxAllowedPaymentsCountPerRequest": 7
  },
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<GetPortalConfigurationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>sample string 1</ResponseCode><ResponseMessage>sample string 2</ResponseMessage><PortalSettings><AllowedPaymentTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d3p1:string>sample string 1</d3p1:string><d3p1:string>sample string 2</d3p1:string></AllowedPaymentTypes><ApplePayMerchantIdentifier>sample string 3</ApplePayMerchantIdentifier><CardExpirationDateFormat>sample string 2</CardExpirationDateFormat><ClientName>sample string 5</ClientName><DefaultPortalFeeContext>sample string 4</DefaultPortalFeeContext><IsWalletActivated>true</IsWalletActivated><MaxAllowedPaymentsCountPerRequest>7</MaxAllowedPaymentsCountPerRequest><MaxPaymentAmount>1</MaxPaymentAmount><TermsOfServiceUrl>sample string 6</TermsOfServiceUrl></PortalSettings></GetPortalConfigurationResponse>

GET api/Template/GetPortalStyles?PortalOneSessionKey={PortalOneSessionKey}

This operation returns rendered styles for portal.

URI Parameters

NameDescriptionTypeAdditional information
PortalOneSessionKey

Session key

string

None.

Response Information

HttpResponseMessage

NameDescriptionTypeAdditional information
Version

Version
Content

HttpContent
StatusCode

HttpStatusCode
ReasonPhrase

string
Headers

Collection of object
RequestMessage

HttpRequestMessage
IsSuccessStatusCode

boolean

Version

NameDescriptionTypeAdditional information
Major

integer
Minor

integer
Build

integer
Revision

integer
MajorRevision

integer
MinorRevision

integer

HttpContent

NameDescriptionTypeAdditional information
Headers

Collection of object

HttpContentHeaders

HttpStatusCode

Possible enumeration values:

NameValueDescription
Continue

100

SwitchingProtocols

101

OK

200

Created

201

Accepted

202

NonAuthoritativeInformation

203

NoContent

204

ResetContent

205

PartialContent

206

MultipleChoices

300

Ambiguous

300

MovedPermanently

301

Moved

301

Found

302

Redirect

302

SeeOther

303

RedirectMethod

303

NotModified

304

UseProxy

305

Unused

306

TemporaryRedirect

307

RedirectKeepVerb

307

BadRequest

400

Unauthorized

401

PaymentRequired

402

Forbidden

403

NotFound

404

MethodNotAllowed

405

NotAcceptable

406

ProxyAuthenticationRequired

407

RequestTimeout

408

Conflict

409

Gone

410

LengthRequired

411

PreconditionFailed

412

RequestEntityTooLarge

413

RequestUriTooLong

414

UnsupportedMediaType

415

RequestedRangeNotSatisfiable

416

ExpectationFailed

417

UpgradeRequired

426

InternalServerError

500

NotImplemented

501

BadGateway

502

ServiceUnavailable

503

GatewayTimeout

504

HttpVersionNotSupported

505

HttpResponseHeaders

HttpRequestMessage

NameDescriptionTypeAdditional information
Version

Version
Content

HttpContent
Method

HttpMethod
RequestUri

URI
Headers

Collection of object
Properties

Dictionary of string and object

HttpMethod

NameDescriptionTypeAdditional information
Method

string

HttpRequestHeaders

Receipt

GET api/Receipt/DownloadReceipt

This operation returns payment receipt as pdf file.

URI Parameters

NameDescriptionTypeAdditional information
ReceiptId

Payment receipt Id

string
ToPreview

Optional: Indicates that receipt file can be opened in a browser preview

boolean
ExtendedParameters

Custom payment properties

Dictionary of string and string
TransactionId

Transaction Id

string
CustomerId

Customer Id

string
PortalOneSessionKey

Session key

string

None.

Response Information

None.

POST api/Receipt/DownloadReceipts

This operation returns payment receipts as merged pdf file.

DownloadReceiptsRequest

NameDescriptionTypeAdditional information
ReceiptItems

Receipts information

Collection of ReceiptItem

Required

ToPreview

Optional: Indicates that receipt file can be opened in a browser preview

boolean
CustomerId

Customer Id

string
PortalOneSessionKey

Session key

string

ReceiptItem

NameDescriptionTypeAdditional information
ReceiptId

Payment receipt Id, optional field

string
TransactionId

Transaction Id

string

Required

ExtendedParameters

The collection of key value pairs for optional parameters

Dictionary of string and string

Request Formats

 
{
  "ReceiptItems": [
    {
      "ReceiptId": "sample string 1",
      "TransactionId": "sample string 2",
      "ExtendedParameters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    },
    {
      "ReceiptId": "sample string 1",
      "TransactionId": "sample string 2",
      "ExtendedParameters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    }
  ],
  "ToPreview": true,
  "CustomerId": "sample string 2",
  "PortalOneSessionKey": "sample string 3"
}
<DownloadReceiptsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>sample string 3</PortalOneSessionKey><CustomerId>sample string 2</CustomerId><ReceiptItems><ReceiptItem><ExtendedParameters 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></ExtendedParameters><ReceiptId>sample string 1</ReceiptId><TransactionId>sample string 2</TransactionId></ReceiptItem><ReceiptItem><ExtendedParameters 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></ExtendedParameters><ReceiptId>sample string 1</ReceiptId><TransactionId>sample string 2</TransactionId></ReceiptItem></ReceiptItems><ToPreview>true</ToPreview></DownloadReceiptsRequest>

Response Information

None.

POST api/Receipt/Email

This operation generates a payment receipt and sends it

EmailReceiptRequest

NameDescriptionTypeAdditional information
EmailAddress

Email address

string

Required

Matching regular expression pattern: ^(([\w-]+\.)+[\w-]+|([a-zA-Z]{1}|[\w-]{2,}))@((([0-1]?[0-9]{1,2}|25[0-5]|2[0-4][0-9])\.([0-1]?[0-9]{1,2}|25[0-5]|2[0-4][0-9])\.([0-1]?[0-9]{1,2}|25[0-5]|2[0-4][0-9])\.([0-1]?[0-9]{1,2}|25[0-5]|2[0-4][0-9])){1}|([a-zA-Z]+[\w-]+\.)+[a-zA-Z]{2,4})$

ReceiptId

Payment receipt Id

string
TransactionId

Transaction Id

string
CustomerId

Customer Id

string
ExtendedParameters

The collection of key value pairs for optional parameters

Dictionary of string and string
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "EmailAddress": "[email protected]",
  "ReceiptId": "3f389efc-0099-46e4-95b7-19ba8ab18659",
  "TransactionId": null,
  "CustomerId": null,
  "ExtendedParameters": {
    "AgentFee": "10"
  },
  "PortalOneSessionKey": "8fbaf249-8334-47ff-9640-9d9f705b0ea8"
}
<EmailReceiptRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>8fbaf249-8334-47ff-9640-9d9f705b0ea8</PortalOneSessionKey><CustomerId i:nil="true" /><EmailAddress>[email protected]</EmailAddress><ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:KeyValueOfstringstring><d2p1:Key>AgentFee</d2p1:Key><d2p1:Value>10</d2p1:Value></d2p1:KeyValueOfstringstring></ExtendedParameters><ReceiptId>3f389efc-0099-46e4-95b7-19ba8ab18659</ReceiptId><TransactionId i:nil="true" /></EmailReceiptRequest>

Response Information

EmailReceiptResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": null
}
<EmailReceiptResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
</EmailReceiptResponse>

POST api/Receipt/EmailReceipts

This operation generates a payment receipts and sends it

EmailReceiptsRequest

NameDescriptionTypeAdditional information
ReceiptItems

Receipts information

Collection of ReceiptItem

Required

EmailAddress

Email address

string

Required

CustomerId

Customer Id

string
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "ReceiptItems": [
    {
      "ReceiptId": "sample string 1",
      "TransactionId": "sample string 2",
      "ExtendedParameters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    },
    {
      "ReceiptId": "sample string 1",
      "TransactionId": "sample string 2",
      "ExtendedParameters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    }
  ],
  "EmailAddress": "sample string 1",
  "CustomerId": "sample string 2",
  "PortalOneSessionKey": "sample string 3"
}
<EmailReceiptsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>sample string 3</PortalOneSessionKey><CustomerId>sample string 2</CustomerId><EmailAddress>sample string 1</EmailAddress><ReceiptItems><ReceiptItem><ExtendedParameters 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></ExtendedParameters><ReceiptId>sample string 1</ReceiptId><TransactionId>sample string 2</TransactionId></ReceiptItem><ReceiptItem><ExtendedParameters 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></ExtendedParameters><ReceiptId>sample string 1</ReceiptId><TransactionId>sample string 2</TransactionId></ReceiptItem></ReceiptItems></EmailReceiptsRequest>

Response Information

EmailReceiptsResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<EmailReceiptsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
</EmailReceiptsResponse>

POST api/Receipt/TextMessage

This operation sends a text message with a payment receipt.

TextMessageReceiptRequest

NameDescriptionTypeAdditional information
PhoneNumber

Phone number

string

Required

TransactionId

ProcessOne transaction ID

string

Required

CustomerId

Client facing customer identifier

globally unique identifier

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "PhoneNumber": "sample string 1",
  "TransactionId": "sample string 2",
  "CustomerId": "eddea12d-cb65-40e3-8126-5b17d5fb3338",
  "PortalOneSessionKey": "sample string 3"
}
<TextMessageReceiptRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>sample string 3</PortalOneSessionKey>
  <CustomerId>eddea12d-cb65-40e3-8126-5b17d5fb3338</CustomerId>
  <PhoneNumber>sample string 1</PhoneNumber>
  <TransactionId>sample string 2</TransactionId>
</TextMessageReceiptRequest>

Response Information

TextMessageReceiptResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<TextMessageReceiptResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
</TextMessageReceiptResponse>

POST api/Receipt/TextMessageReceipts

This operation sends a text message with a payment receipts.

TextMessageReceiptsRequest

NameDescriptionTypeAdditional information
PhoneNumber

Phone number

string

Required

CustomerId

Customer Id

string

Required

ReceiptItems

Receipts information

Collection of ReceiptItem

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "PhoneNumber": "sample string 1",
  "CustomerId": "sample string 2",
  "ReceiptItems": [
    {
      "ReceiptId": "sample string 1",
      "TransactionId": "sample string 2",
      "ExtendedParameters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    },
    {
      "ReceiptId": "sample string 1",
      "TransactionId": "sample string 2",
      "ExtendedParameters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    }
  ],
  "PortalOneSessionKey": "sample string 3"
}
<TextMessageReceiptsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>sample string 3</PortalOneSessionKey><CustomerId>sample string 2</CustomerId><PhoneNumber>sample string 1</PhoneNumber><ReceiptItems><ReceiptItem><ExtendedParameters 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></ExtendedParameters><ReceiptId>sample string 1</ReceiptId><TransactionId>sample string 2</TransactionId></ReceiptItem><ReceiptItem><ExtendedParameters 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></ExtendedParameters><ReceiptId>sample string 1</ReceiptId><TransactionId>sample string 2</TransactionId></ReceiptItem></ReceiptItems></TextMessageReceiptsRequest>

Response Information

TextMessageReceiptsResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<TextMessageReceiptsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
</TextMessageReceiptsResponse>

Transaction

POST api/Transaction/GetTransactionsByCustomerAndClientRefData

This operation returns transactions.

GetTransactionsByCustomerAndClientRefDataRequest

NameDescriptionTypeAdditional information
CustomerId

Customer id

string

Required

ClientReferenceData

Client reference data

ClientReferenceData
StartDate

Start date

date

Required

EndDate

End date

date

Required

Limit

Limit

integer
Offset

Offset

integer
Types

Transaction types

Collection of TransactionType
TransactionStatuses

Transaction statuses

Collection of TransactionStatus
PortalOneSessionKey

Session key

string

TransactionType

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

ChargeCc

1

Charge by Credit Card

RefundCc

2

Refund payment by Credit Card

VoidCc

3

Void payment by Credit Card

CreditEft

5

Charge by credit electronic fund transfer

DebitEftNoFee

6

Charge by debit electronic fund transfer

VoidEft

7

Void EFT payment

ChargeBackDebit

9

Chargeback debit

ChargeBackCredit

10

Chargeback Credit

SaveCreditCard

11

Save CreditCard

RemoveSavedCreditCard

12

Remove saved Credit Card

RecurringChargeCc

13

Recurring Credit Card Charge

ChargeCcNoFee

14

Charge by Credit Card without fee

ReturnedEft

15

EFT Returned

AchDebitPassthrough

16

ACH Debit Pass-through

AchCreditPassthrough

17

ACH Credit Pass-through

RefundEft

18

EFT Refund

DebitSweepForEftCredit

19

EFT Debit Sweep For EFT Credit

AchReturnPassthrough

20

ACH Return Pass-through

SaveEft

21

Save EFT

DebitEft

22

EFT Debit

RecurringEft

23

Recurring EFT Payment

RemoveSavedEft

24

Remove Saved EFT

AdjustmentDebit

25

Adjustment Debit

AdjustmentCredit

26

Adjustment Credit

VoidAdjustment

27

Void Adjustment

VerifyCreditCard

28

Verify Credit Card

VerifyBankAccount

29

Verify Bank Account

CreditBankAccount

31

Credit Bank Account

VoidBankAccountCredit

32

Void Bank Account Credit

CreatePrepaidProfile

33

Create Prepaid Profile

UpdatePrepaidProfile

34

Update Prepaid Profile

LoadPrepaidAccount

35

Load Prepaid Account

ReversePrepaidAccountLoad

36

Reverse Prepaid AccountLoad

ReleaseLoadPrepaidAccount

37

Release Load Prepaid Account

DisbursePrepaidAccountEft

38

Disburse Prepaid Account Eft

DisbursePrepaidAccountCheck

39

Disburse Prepaid Account Check

ChangePrepaidAccountStatus

40

Change Prepaid Account Status

AddPrepaidCard

41

Add Prepaid Card

ChangePrepaidCardStatus

42

Change Prepaid Card Status

ReplacePrepaidCard

43

Replace Prepaid Card

ActivatePrepaidCard

44

Activate Prepaid Card

ReservePrepaidCard

45

Reserve Prepaid Card

LoadReservedPrepaidCard

46

Load Reserved Prepaid Card

LostStolenPrepaidCard

47

Lost Stolen Prepaid Card

OrderPrepaidCards

48

Order Prepaid Cards

ReturnedCreditBankAccount

49

Returned Credit Bank Account

TransactionStatus

Possible enumeration values:

NameValueDescription
Undefined

0

Transaction status is undefined

InProcess

1

Transaction has been started

Successful

2

Transaction has been processed successfully

Failed

3

Transaction failed

Voided

4

Transaction voided

Canceled

5

Transaction canceled

Reversed

6

Transaction reversed

CardReleased

7

Card released

Returned

8

Transaction returned

Request Formats

 
{
  "CustomerId": "DemoCustomerId",
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": null,
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "StartDate": "2020-02-19T12:50:46",
  "EndDate": "2020-02-19T12:50:46",
  "Limit": 50,
  "Offset": 100,
  "Types": [
    1,
    3
  ],
  "TransactionStatuses": [
    2
  ],
  "PortalOneSessionKey": "f62ad188-a4cc-4ccd-a599-b9ccd4fdbd58"
}
<GetTransactionsByCustomerAndClientRefDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>f62ad188-a4cc-4ccd-a599-b9ccd4fdbd58</PortalOneSessionKey><ClientReferenceData><ClientReferenceData1>POL-123</ClientReferenceData1><ClientReferenceData2 i:nil="true" /><ClientReferenceData3 i:nil="true" /><ClientReferenceData4 i:nil="true" /><ClientReferenceData5 i:nil="true" /></ClientReferenceData><CustomerId>DemoCustomerId</CustomerId><EndDate>2020-02-19T12:50:46.1702169-08:00</EndDate><Limit>50</Limit><Offset>100</Offset><StartDate>2020-02-19T12:50:46.1702169-08:00</StartDate><TransactionStatuses><TransactionStatus>Successful</TransactionStatus></TransactionStatuses><Types><TransactionType>ChargeCc</TransactionType><TransactionType>VoidCc</TransactionType></Types></GetTransactionsByCustomerAndClientRefDataRequest>

Response Information

GetTransactionsByCustomerAndClientRefDataResponse

NameDescriptionTypeAdditional information
Transactions

Collection of transactions

Collection of TransactionInformation
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

IEnumerableOfTransactionInformation

NameDescriptionTypeAdditional information
TransactionId

Transaction Id

string
InternalReferenceTransactionId

Internal Reference Transaction Id

string
OriginalAmount

Original amount of the transaction

decimal number
PostedAmount

Posted amount of the transaction

decimal number
TransactionType

Transaction type

TransactionType
TransactionStatus

Transaction status

TransactionStatus
PaymentDate

Payment date

date
TimeZone

Client time zone

string
CreditCardType

Credit card type

CreditCardType
LastFourDigits

Last 4 digits of the credit card or the bank account

string
RoutingNumber

Routing number

string
AccountNumber

Account number

string
BatchNumber

Batch number

integer
InstanceName

Merchant instance name

string
CustomerName

Customer name

string
ClientReferenceData

Client extra data

ClientReferenceData
ProcessOneToken

ProcessOne token

string
CreditCardExpirationMonth

Credit card expiration month

integer
CreditCardExpirationYear

Credit card expiration year

integer
BankName

Bank name

string
BankAccountType

Bank account type

EftAccountType
ReturnReasonType

Return reason type

ReturnReasonType
ReturnReasonCode

Return reason code

string
BaseCardType

Base card type

CreditCardType
AccountGroupCode

Account group code

string
CustomerId

Customer Id

string

ReturnReasonType

Possible enumeration values:

NameValueDescription
Chargeback

0

Chargeback

ChargebackCredit

1

Chargeback Credit

Eft

2

Eft

Response Formats

{
  "Transactions": [
    {
      "TransactionId": "1",
      "InternalReferenceTransactionId": null,
      "OriginalAmount": 100.0,
      "PostedAmount": 100.0,
      "TransactionType": 5,
      "TransactionStatus": 2,
      "PaymentDate": "2020-02-19T12:50:46",
      "TimeZone": "PDT",
      "CreditCardType": 0,
      "LastFourDigits": "1234",
      "RoutingNumber": "123123123",
      "AccountNumber": "123123124",
      "BatchNumber": 11,
      "InstanceName": "merchant instance name",
      "CustomerName": "John Stevens",
      "ClientReferenceData": {
        "ClientReferenceData1": "1234",
        "ClientReferenceData2": null,
        "ClientReferenceData3": "test address",
        "ClientReferenceData4": null,
        "ClientReferenceData5": null
      },
      "ProcessOneToken": null,
      "CreditCardExpirationMonth": null,
      "CreditCardExpirationYear": null,
      "BankName": null,
      "BankAccountType": 0,
      "ReturnReasonType": null,
      "ReturnReasonCode": null,
      "BaseCardType": null,
      "AccountGroupCode": null,
      "CustomerId": null
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetTransactionsByCustomerAndClientRefDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>Success</ResponseCode><ResponseMessage i:nil="true" /><Transactions><TransactionInformation><AccountGroupCode i:nil="true" /><AccountNumber>123123124</AccountNumber><BankAccountType>Undefined</BankAccountType><BankName i:nil="true" /><BaseCardType i:nil="true" /><BatchNumber>11</BatchNumber><ClientReferenceData><ClientReferenceData1>1234</ClientReferenceData1><ClientReferenceData2 i:nil="true" /><ClientReferenceData3>test address</ClientReferenceData3><ClientReferenceData4 i:nil="true" /><ClientReferenceData5 i:nil="true" /></ClientReferenceData><CreditCardExpirationMonth i:nil="true" /><CreditCardExpirationYear i:nil="true" /><CreditCardType>Undefined</CreditCardType><CustomerId i:nil="true" /><CustomerName>John Stevens</CustomerName><InstanceName>merchant instance name</InstanceName><InternalReferenceTransactionId i:nil="true" /><LastFourDigits>1234</LastFourDigits><OriginalAmount>100</OriginalAmount><PaymentDate>2020-02-19T12:50:46.2321891-08:00</PaymentDate><PostedAmount>100</PostedAmount><ProcessOneToken i:nil="true" /><ReturnReasonCode i:nil="true" /><ReturnReasonType i:nil="true" /><RoutingNumber>123123123</RoutingNumber><TimeZone>PDT</TimeZone><TransactionId>1</TransactionId><TransactionStatus>Successful</TransactionStatus><TransactionType>CreditEft</TransactionType></TransactionInformation></Transactions></GetTransactionsByCustomerAndClientRefDataResponse>

Customer

POST api/Customer/CreateAccount

This operation creates a record for a new customer entity, generates and returns an unique identifier for it. The method also creates a record in the Wallet table for the customer.

CreateAccountRequest

NameDescriptionTypeAdditional information
PortalOneAuthenticationKey

Authentication key

string
ExternalCustomerId

An unique identifier of a customer in some external system

string
CustomerName

Customer name

string

Request Formats

 
{
  "PortalOneAuthenticationKey": "2f7600ce-bcf0-4080-a8df-6fcf55505a86",
  "ExternalCustomerId": "a47a5f85-454e-4391-9a00-6c676cb61538",
  "CustomerName": "John Smith"
}
<CreateAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <CustomerName>John Smith</CustomerName>
  <ExternalCustomerId>a47a5f85-454e-4391-9a00-6c676cb61538</ExternalCustomerId>
  <PortalOneAuthenticationKey>2f7600ce-bcf0-4080-a8df-6fcf55505a86</PortalOneAuthenticationKey>
</CreateAccountRequest>

Response Information

CreateAccountResponse

NameDescriptionTypeAdditional information
CustomerId

Generated identifier for a customer

globally unique identifier
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "CustomerId": "2a3556ca-0589-475a-b470-ed6afa07a9f5",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<CreateAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <CustomerId>2a3556ca-0589-475a-b470-ed6afa07a9f5</CustomerId>
</CreateAccountResponse>

POST api/Customer/GetByExternalCustomerId

This operation returns Customer Account by ExternalCustomerId value.

GetByExternalCustomerIdRequest

NameDescriptionTypeAdditional information
PortalOneAuthenticationKey

Authentication key

string
ExternalCustomerId

An unique identifier of a customer in some external system

string

Required

Request Formats

 
{
  "PortalOneAuthenticationKey": "3c0ca15a-3205-4d63-aa1f-164c60fe6563",
  "ExternalCustomerId": "eaf8b767-dbef-4de2-af92-4e93b3f77b0e"
}
<GetByExternalCustomerIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ExternalCustomerId>eaf8b767-dbef-4de2-af92-4e93b3f77b0e</ExternalCustomerId>
  <PortalOneAuthenticationKey>3c0ca15a-3205-4d63-aa1f-164c60fe6563</PortalOneAuthenticationKey>
</GetByExternalCustomerIdRequest>

Response Information

GetByExternalCustomerIdResponse

NameDescriptionTypeAdditional information
CustomerId

An identifier for a customer generated when the customer was created

globally unique identifier
CustomerName

Customer name

string
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "CustomerId": "a0b9185c-c242-4159-8de6-997eadc35bcf",
  "CustomerName": "John Smith",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetByExternalCustomerIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <CustomerId>a0b9185c-c242-4159-8de6-997eadc35bcf</CustomerId>
  <CustomerName>John Smith</CustomerName>
</GetByExternalCustomerIdResponse>

POST api/Customer/ValidateCustomerIdForSession

Returns Validation result for customer identifier

ValidateCustomerIdForSessionRequest

NameDescriptionTypeAdditional information
CustomerId

customer identifier

string

Required

PortalOneSessionKey

Session key. Either Session key or Authentication key parameter is required

string
PortalOneAuthenticationKey

Authentication key. Either Session key or Authentication key parameter is required

string

Request Formats

 
{
  "CustomerId": "sample string 1",
  "PortalOneSessionKey": "sample string 2",
  "PortalOneAuthenticationKey": "sample string 3"
}
<ValidateCustomerIdForSessionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneAuthenticationKey>sample string 3</PortalOneAuthenticationKey>
  <PortalOneSessionKey>sample string 2</PortalOneSessionKey>
  <CustomerId>sample string 1</CustomerId>
</ValidateCustomerIdForSessionRequest>

Response Information

ValidateCustomerIdForSessionResponse

NameDescriptionTypeAdditional information
ErrorDescription

string
IsValid

boolean
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "ErrorDescription": "sample string 1",
  "IsValid": false,
  "ResponseCode": "sample string 2",
  "ResponseMessage": "sample string 3"
}
<ValidateCustomerIdForSessionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <ErrorDescription>sample string 1</ErrorDescription>
</ValidateCustomerIdForSessionResponse>

Eft

POST api/Eft/Save

This operation tokenizes all the required information about a bank account payment method. Once the bank account information has been tokenized, you no longer have to provide us any sensitive and personal information to debit or credit a bank account, just use the token that is retunred by our API.

SaveEftRequest

NameDescriptionTypeAdditional information
EftDetails

Eft details

EftDetails
BypassBankAccountValidation

Bypassing bank account validation

boolean
CallbackId

A callback id associated to save transaction

string
ClientReferenceData

Client reference data

ClientReferenceData
CustomerId

Client facing customer identifier

string
IsDefaultPaymentMethod

Is default payment method flag

boolean
PortalOneSessionKey

Session key. Either Session key or Authentication key parameter is required

string
PortalOneAuthenticationKey

Authentication key. Either Session key or Authentication key parameter is required

string

EftDetails

NameDescriptionTypeAdditional information
RoutingNumber

The bank routing number. Must only contain numbers.

string
AccountNumber

Account number. Must contain only numbers.

string
Type

EFT account type - Checking / Savings.

EftAccountType
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups.

string
CustomerName

Customer name

string

Request Formats

 
{
  "EftDetails": {
    "RoutingNumber": "121042882",
    "AccountNumber": "12345",
    "Type": 0,
    "AccountGroupCode": null,
    "CustomerName": "Janet Smith"
  },
  "BypassBankAccountValidation": false,
  "CallbackId": "dd8d0cec-60e8-490a-b880-ea61dbf7864e",
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "CustomerId": "D60039CB-DC29-4B9E-B290-C2C233155B9F",
  "IsDefaultPaymentMethod": false,
  "PortalOneSessionKey": "58d458c2-fc8a-41fd-832e-83afbdb0aea4",
  "PortalOneAuthenticationKey": null
}
<SaveEftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneAuthenticationKey i:nil="true" />
  <PortalOneSessionKey>58d458c2-fc8a-41fd-832e-83afbdb0aea4</PortalOneSessionKey>
  <CallbackId>dd8d0cec-60e8-490a-b880-ea61dbf7864e</CallbackId>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <CustomerId>D60039CB-DC29-4B9E-B290-C2C233155B9F</CustomerId>
  <IsDefaultPaymentMethod>false</IsDefaultPaymentMethod>
  <BypassBankAccountValidation>false</BypassBankAccountValidation>
  <EftDetails>
    <AccountGroupCode i:nil="true" />
    <AccountNumber>12345</AccountNumber>
    <CustomerName>Janet Smith</CustomerName>
    <RoutingNumber>121042882</RoutingNumber>
    <Type>Undefined</Type>
  </EftDetails>
</SaveEftRequest>

Response Information

SaveEftResponse

NameDescriptionTypeAdditional information
BankName

Bank name

string
VerifyBankAccountDescription

Additional response data

string
Token

ProcessOne payment token

string
TokenCreationTime

Token creation date and time in merchant time zone

date
TimeZone

Short time zone name with daylight saving time suffix

string
PaymentMethodId

Related payment method identifier

integer
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "BankName": "WELLS FARGO BANK NA",
  "VerifyBankAccountDescription": null,
  "Token": "b2054857-29eb-4a5f-8621-806f84e92758",
  "TokenCreationTime": "2020-02-19T12:50:46",
  "TimeZone": "PDT",
  "PaymentMethodId": null,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<SaveEftResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <PaymentMethodId i:nil="true" />
  <TimeZone>PDT</TimeZone>
  <Token>b2054857-29eb-4a5f-8621-806f84e92758</Token>
  <TokenCreationTime>2020-02-19T12:50:46.919649-08:00</TokenCreationTime>
  <BankName>WELLS FARGO BANK NA</BankName>
  <VerifyBankAccountDescription i:nil="true" />
</SaveEftResponse>

POST api/Eft/Credit

This operation allows to credit a given bank account, which initiates a transfer of money from the merchant to a particular customer bank account. You can either provide a bank account information or use a previously saved token.

CreditEftRequest

NameDescriptionTypeAdditional information
Token

Saved Eft token

string
EftDetails

Eft details

EftDetails
IsRecurring

Is recurring charge

boolean
CallbackId

Callback ID

string
Amount

Charge amount

decimal number
ClientReferenceData

Client reference data

ClientReferenceData
AcknowledgmentRequired

Indicates that successful payment must be acknowledged by a customer service

boolean
CustomerId

Client facing customer identifier

string
ExtendedParameters

The collection of key value pairs for optional parameters

Dictionary of string and string
AccessToken

AccessToken

globally unique identifier
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "Token": "9564aa77-93bb-4ce8-8834-55a357a0a35a",
  "EftDetails": null,
  "IsRecurring": false,
  "CallbackId": "1ba58a9c-778f-482a-b8c5-4edaa5e9a0c8",
  "Amount": 312.0,
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "AcknowledgmentRequired": null,
  "CustomerId": "D60039CB-DC29-4B9E-B290-C2C233155B9F",
  "ExtendedParameters": {
    "Parameter1": "Value",
    "Parameter2": "Value"
  },
  "AccessToken": null,
  "PortalOneSessionKey": "2c00bd91-0d5d-4fe8-b19f-4bb3cc39e4d6"
}
<CreditEftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>2c00bd91-0d5d-4fe8-b19f-4bb3cc39e4d6</PortalOneSessionKey><AccessToken i:nil="true" /><AcknowledgmentRequired i:nil="true" /><Amount>312</Amount><ClientReferenceData><ClientReferenceData1>POL-123</ClientReferenceData1><ClientReferenceData2>12345</ClientReferenceData2><ClientReferenceData3 i:nil="true" /><ClientReferenceData4 i:nil="true" /><ClientReferenceData5 i:nil="true" /></ClientReferenceData><CustomerId>D60039CB-DC29-4B9E-B290-C2C233155B9F</CustomerId><ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:KeyValueOfstringstring><d2p1:Key>Parameter1</d2p1:Key><d2p1:Value>Value</d2p1:Value></d2p1:KeyValueOfstringstring><d2p1:KeyValueOfstringstring><d2p1:Key>Parameter2</d2p1:Key><d2p1:Value>Value</d2p1:Value></d2p1:KeyValueOfstringstring></ExtendedParameters><CallbackId>1ba58a9c-778f-482a-b8c5-4edaa5e9a0c8</CallbackId><EftDetails i:nil="true" /><IsRecurring>false</IsRecurring><Token>9564aa77-93bb-4ce8-8834-55a357a0a35a</Token></CreditEftRequest>

Response Information

CreditEftResponse

NameDescriptionTypeAdditional information
BankName

Bank name

string
TransactionId

Transaction ID

string
TransactionDate

Transaction date and time

date
TimeZone

Transaction time zone

string
BatchNumber

Number of the batch

integer
ReceiptId

Receipt ID

string
AcknowledgmentDelivered

Indicates that successful payment has been acknowledged by a customer service

boolean
ClientReferenceData1

Reference number such as Policy, Quote, or Claim Number for which payment is made.

string
OriginalAmount

Original amount of the transaction

decimal number
FeeAmount

Fee amount

decimal number
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "BankName": "WELLS FARGO BANK NA",
  "TransactionId": "123",
  "TransactionDate": "2020-02-19T12:50:47",
  "TimeZone": "PDT",
  "BatchNumber": 10,
  "ReceiptId": null,
  "AcknowledgmentDelivered": null,
  "ClientReferenceData1": null,
  "OriginalAmount": 0.0,
  "FeeAmount": 0.0,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<CreditEftResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <AcknowledgmentDelivered i:nil="true" />
  <BatchNumber>10</BatchNumber>
  <ClientReferenceData1 i:nil="true" />
  <FeeAmount>0</FeeAmount>
  <OriginalAmount>0</OriginalAmount>
  <ReceiptId i:nil="true" />
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2020-02-19T12:50:47</TransactionDate>
  <TransactionId>123</TransactionId>
  <BankName>WELLS FARGO BANK NA</BankName>
</CreditEftResponse>

POST api/Eft/Debit

This operation allows debiting a given bank account, which initiates a transfer of money from a particular customer bank account to the merchant. You can either provide a bank account information or use a previously saved token.

DebitEftRequest

NameDescriptionTypeAdditional information
Save

Enables to save and tokenize eft information

boolean
ChargeFee

Should we charge with fee

boolean
ConvenienceFeeType

Customizable convenience fee type that is matched with different types of transactions

string
BypassBankAccountValidation

Bypassing bank account validation

boolean
Token

Saved Eft token

string
EftDetails

Eft details

EftDetails
IsRecurring

Is recurring charge

boolean
CallbackId

Callback ID

string
Amount

Charge amount

decimal number
ClientReferenceData

Client reference data

ClientReferenceData
AcknowledgmentRequired

Indicates that successful payment must be acknowledged by a customer service

boolean
CustomerId

Client facing customer identifier

string
ExtendedParameters

The collection of key value pairs for optional parameters

Dictionary of string and string
AccessToken

AccessToken

globally unique identifier
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "Save": false,
  "ChargeFee": true,
  "ConvenienceFeeType": "Extra",
  "BypassBankAccountValidation": false,
  "Token": "ba791c4f-c5aa-4a23-a795-f7f6c06d449f",
  "EftDetails": null,
  "IsRecurring": false,
  "CallbackId": "ab0de5f8-0ac0-42a2-9ac6-578c676dae74",
  "Amount": 312.0,
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "AcknowledgmentRequired": null,
  "CustomerId": "D60039CB-DC29-4B9E-B290-C2C233155B9F",
  "ExtendedParameters": {
    "CustomerName": "John Smith",
    "AgentFee": "10"
  },
  "AccessToken": null,
  "PortalOneSessionKey": "8995accc-af06-478f-acef-33595213f570"
}
<DebitEftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>8995accc-af06-478f-acef-33595213f570</PortalOneSessionKey><AccessToken i:nil="true" /><AcknowledgmentRequired i:nil="true" /><Amount>312</Amount><ClientReferenceData><ClientReferenceData1>POL-123</ClientReferenceData1><ClientReferenceData2>12345</ClientReferenceData2><ClientReferenceData3 i:nil="true" /><ClientReferenceData4 i:nil="true" /><ClientReferenceData5 i:nil="true" /></ClientReferenceData><CustomerId>D60039CB-DC29-4B9E-B290-C2C233155B9F</CustomerId><ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:KeyValueOfstringstring><d2p1:Key>CustomerName</d2p1:Key><d2p1:Value>John Smith</d2p1:Value></d2p1:KeyValueOfstringstring><d2p1:KeyValueOfstringstring><d2p1:Key>AgentFee</d2p1:Key><d2p1:Value>10</d2p1:Value></d2p1:KeyValueOfstringstring></ExtendedParameters><CallbackId>ab0de5f8-0ac0-42a2-9ac6-578c676dae74</CallbackId><EftDetails i:nil="true" /><IsRecurring>false</IsRecurring><Token>ba791c4f-c5aa-4a23-a795-f7f6c06d449f</Token><BypassBankAccountValidation>false</BypassBankAccountValidation><ChargeFee>true</ChargeFee><ConvenienceFeeType>Extra</ConvenienceFeeType><Save>false</Save></DebitEftRequest>

Response Information

DebitEftResponse

NameDescriptionTypeAdditional information
Token

ProcessOne payment token

string
VerifyBankAccountDescription

Additional response data

string
BankName

Bank name

string
TransactionId

Transaction ID

string
TransactionDate

Transaction date and time

date
TimeZone

Transaction time zone

string
BatchNumber

Number of the batch

integer
ReceiptId

Receipt ID

string
AcknowledgmentDelivered

Indicates that successful payment has been acknowledged by a customer service

boolean
ClientReferenceData1

Reference number such as Policy, Quote, or Claim Number for which payment is made.

string
OriginalAmount

Original amount of the transaction

decimal number
FeeAmount

Fee amount

decimal number
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "Token": null,
  "VerifyBankAccountDescription": null,
  "BankName": "WELLS FARGO BANK NA",
  "TransactionId": "123",
  "TransactionDate": "2020-02-19T12:50:47",
  "TimeZone": "PDT",
  "BatchNumber": 10,
  "ReceiptId": "8c337a38-3599-4811-a97a-6ba472cbeca9",
  "AcknowledgmentDelivered": null,
  "ClientReferenceData1": null,
  "OriginalAmount": 0.0,
  "FeeAmount": 0.0,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<DebitEftResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <AcknowledgmentDelivered i:nil="true" />
  <BatchNumber>10</BatchNumber>
  <ClientReferenceData1 i:nil="true" />
  <FeeAmount>0</FeeAmount>
  <OriginalAmount>0</OriginalAmount>
  <ReceiptId>8c337a38-3599-4811-a97a-6ba472cbeca9</ReceiptId>
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2020-02-19T12:50:47</TransactionDate>
  <TransactionId>123</TransactionId>
  <BankName>WELLS FARGO BANK NA</BankName>
  <Token i:nil="true" />
  <VerifyBankAccountDescription i:nil="true" />
</DebitEftResponse>

POST api/Eft/DebitEfts

This operation allows debiting a given bank accounts, which initiates a transfer of money from a particular customer bank account to the merchant. You can either provide a bank accounts information or use a previously saved tokens.

DebitEftsRequest

NameDescriptionTypeAdditional information
DebitEftRequests

Debit EFT requests

Collection of DebitEftRequest

Required

PortalOneSessionKey

Session key

string

DebitEftRequest

NameDescriptionTypeAdditional information
Save

Enables to save and tokenize eft information

boolean
ChargeFee

Should we charge with fee

boolean
ConvenienceFeeType

Customizable convenience fee type that is matched with different types of transactions

string
BypassBankAccountValidation

Bypassing bank account validation

boolean
Token

Saved Eft token

string
EftDetails

Eft details

EftDetails
IsRecurring

Is recurring charge

boolean
CallbackId

Callback ID

string
Amount

Charge amount

decimal number
ClientReferenceData

Client reference data

ClientReferenceData
AcknowledgmentRequired

Indicates that successful payment must be acknowledged by a customer service

boolean
CustomerId

Client facing customer identifier

string
ExtendedParameters

The collection of key value pairs for optional parameters

Dictionary of string and string
AccessToken

AccessToken

globally unique identifier
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "DebitEftRequests": [
    {
      "Save": true,
      "ChargeFee": true,
      "ConvenienceFeeType": "sample string 3",
      "BypassBankAccountValidation": true,
      "Token": "sample string 5",
      "EftDetails": {
        "RoutingNumber": "sample string 1",
        "AccountNumber": "sample string 2",
        "Type": 0,
        "AccountGroupCode": "sample string 3",
        "CustomerName": "sample string 4"
      },
      "IsRecurring": true,
      "CallbackId": "sample string 7",
      "Amount": 8.0,
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "AcknowledgmentRequired": true,
      "CustomerId": "sample string 9",
      "ExtendedParameters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "AccessToken": "2ade6e28-621a-4697-899f-10ee266af1a8",
      "PortalOneSessionKey": "sample string 10"
    },
    {
      "Save": true,
      "ChargeFee": true,
      "ConvenienceFeeType": "sample string 3",
      "BypassBankAccountValidation": true,
      "Token": "sample string 5",
      "EftDetails": {
        "RoutingNumber": "sample string 1",
        "AccountNumber": "sample string 2",
        "Type": 0,
        "AccountGroupCode": "sample string 3",
        "CustomerName": "sample string 4"
      },
      "IsRecurring": true,
      "CallbackId": "sample string 7",
      "Amount": 8.0,
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "AcknowledgmentRequired": true,
      "CustomerId": "sample string 9",
      "ExtendedParameters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "AccessToken": "2ade6e28-621a-4697-899f-10ee266af1a8",
      "PortalOneSessionKey": "sample string 10"
    }
  ],
  "PortalOneSessionKey": "sample string 1"
}
<DebitEftsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>sample string 1</PortalOneSessionKey><DebitEftRequests><DebitEftRequest><PortalOneSessionKey>sample string 10</PortalOneSessionKey><AccessToken>2ade6e28-621a-4697-899f-10ee266af1a8</AccessToken><AcknowledgmentRequired>true</AcknowledgmentRequired><Amount>8</Amount><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 9</CustomerId><ExtendedParameters 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></ExtendedParameters><CallbackId>sample string 7</CallbackId><EftDetails><AccountGroupCode>sample string 3</AccountGroupCode><AccountNumber>sample string 2</AccountNumber><CustomerName>sample string 4</CustomerName><RoutingNumber>sample string 1</RoutingNumber><Type>Undefined</Type></EftDetails><IsRecurring>true</IsRecurring><Token>sample string 5</Token><BypassBankAccountValidation>true</BypassBankAccountValidation><ChargeFee>true</ChargeFee><ConvenienceFeeType>sample string 3</ConvenienceFeeType><Save>true</Save></DebitEftRequest><DebitEftRequest><PortalOneSessionKey>sample string 10</PortalOneSessionKey><AccessToken>2ade6e28-621a-4697-899f-10ee266af1a8</AccessToken><AcknowledgmentRequired>true</AcknowledgmentRequired><Amount>8</Amount><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 9</CustomerId><ExtendedParameters 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></ExtendedParameters><CallbackId>sample string 7</CallbackId><EftDetails><AccountGroupCode>sample string 3</AccountGroupCode><AccountNumber>sample string 2</AccountNumber><CustomerName>sample string 4</CustomerName><RoutingNumber>sample string 1</RoutingNumber><Type>Undefined</Type></EftDetails><IsRecurring>true</IsRecurring><Token>sample string 5</Token><BypassBankAccountValidation>true</BypassBankAccountValidation><ChargeFee>true</ChargeFee><ConvenienceFeeType>sample string 3</ConvenienceFeeType><Save>true</Save></DebitEftRequest></DebitEftRequests></DebitEftsRequest>

Response Information

DebitEftsResponse

NameDescriptionTypeAdditional information
DebitEftResponses

Debit EFT responses

Collection of DebitEftResponse
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

DebitEftResponse

NameDescriptionTypeAdditional information
Token

ProcessOne payment token

string
VerifyBankAccountDescription

Additional response data

string
BankName

Bank name

string
TransactionId

Transaction ID

string
TransactionDate

Transaction date and time

date
TimeZone

Transaction time zone

string
BatchNumber

Number of the batch

integer
ReceiptId

Receipt ID

string
AcknowledgmentDelivered

Indicates that successful payment has been acknowledged by a customer service

boolean
ClientReferenceData1

Reference number such as Policy, Quote, or Claim Number for which payment is made.

string
OriginalAmount

Original amount of the transaction

decimal number
FeeAmount

Fee amount

decimal number
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "DebitEftResponses": [
    {
      "Token": "sample string 1",
      "VerifyBankAccountDescription": "sample string 2",
      "BankName": "sample string 3",
      "TransactionId": "sample string 4",
      "TransactionDate": "2020-02-19T12:50:47",
      "TimeZone": "sample string 5",
      "BatchNumber": 6,
      "ReceiptId": "sample string 7",
      "AcknowledgmentDelivered": true,
      "ClientReferenceData1": "sample string 8",
      "OriginalAmount": 9.0,
      "FeeAmount": 10.0,
      "ResponseCode": "sample string 11",
      "ResponseMessage": "sample string 12"
    },
    {
      "Token": "sample string 1",
      "VerifyBankAccountDescription": "sample string 2",
      "BankName": "sample string 3",
      "TransactionId": "sample string 4",
      "TransactionDate": "2020-02-19T12:50:47",
      "TimeZone": "sample string 5",
      "BatchNumber": 6,
      "ReceiptId": "sample string 7",
      "AcknowledgmentDelivered": true,
      "ClientReferenceData1": "sample string 8",
      "OriginalAmount": 9.0,
      "FeeAmount": 10.0,
      "ResponseCode": "sample string 11",
      "ResponseMessage": "sample string 12"
    }
  ],
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<DebitEftsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>sample string 1</ResponseCode><ResponseMessage>sample string 2</ResponseMessage><DebitEftResponses><DebitEftResponse><ResponseCode>sample string 11</ResponseCode><ResponseMessage>sample string 12</ResponseMessage><AcknowledgmentDelivered>true</AcknowledgmentDelivered><BatchNumber>6</BatchNumber><ClientReferenceData1>sample string 8</ClientReferenceData1><FeeAmount>10</FeeAmount><OriginalAmount>9</OriginalAmount><ReceiptId>sample string 7</ReceiptId><TimeZone>sample string 5</TimeZone><TransactionDate>2020-02-19T12:50:47.6227805-08:00</TransactionDate><TransactionId>sample string 4</TransactionId><BankName>sample string 3</BankName><Token>sample string 1</Token><VerifyBankAccountDescription>sample string 2</VerifyBankAccountDescription></DebitEftResponse><DebitEftResponse><ResponseCode>sample string 11</ResponseCode><ResponseMessage>sample string 12</ResponseMessage><AcknowledgmentDelivered>true</AcknowledgmentDelivered><BatchNumber>6</BatchNumber><ClientReferenceData1>sample string 8</ClientReferenceData1><FeeAmount>10</FeeAmount><OriginalAmount>9</OriginalAmount><ReceiptId>sample string 7</ReceiptId><TimeZone>sample string 5</TimeZone><TransactionDate>2020-02-19T12:50:47.6227805-08:00</TransactionDate><TransactionId>sample string 4</TransactionId><BankName>sample string 3</BankName><Token>sample string 1</Token><VerifyBankAccountDescription>sample string 2</VerifyBankAccountDescription></DebitEftResponse></DebitEftResponses></DebitEftsResponse>

POST api/Eft/GetConvenienceFee

This operation returns convenience fee.

GetEftConvenienceFeeRequest

NameDescriptionTypeAdditional information
ChargeAmount

Charge amount

decimal number

Required

ConvenienceFeeType

Convenience fee type

string

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "ChargeAmount": 100.0,
  "ConvenienceFeeType": "PaymentWithFee",
  "PortalOneSessionKey": "f49b68c9-482d-4c75-9cfd-156ec0d70b16"
}
<GetEftConvenienceFeeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>f49b68c9-482d-4c75-9cfd-156ec0d70b16</PortalOneSessionKey>
  <ChargeAmount>100</ChargeAmount>
  <ConvenienceFeeType>PaymentWithFee</ConvenienceFeeType>
</GetEftConvenienceFeeRequest>

Response Information

GetEftConvenienceFeeResponse

NameDescriptionTypeAdditional information
ConvenienceFee

Convenience fee amount

decimal number
CalculationType

Calculation type

string
FlatRate

Flat rate

decimal number
Percent

Percent

decimal number
MinimumAmount

Minimum amount

decimal number
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "ConvenienceFee": 5.0,
  "CalculationType": "FlatRate",
  "FlatRate": 5.0,
  "Percent": null,
  "MinimumAmount": null,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetEftConvenienceFeeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <CalculationType>FlatRate</CalculationType>
  <ConvenienceFee>5</ConvenienceFee>
  <FlatRate>5</FlatRate>
  <MinimumAmount i:nil="true" />
  <Percent i:nil="true" />
</GetEftConvenienceFeeResponse>

POST api/Eft/GetConvenienceFeesList

This operation returns convenience fees for a list of policies.

GetConvenienceFeesListEftRequest

NameDescriptionTypeAdditional information
ChargeAmounts

Charge amounts

Collection of ConvenienceFeeRequestItem

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "ChargeAmounts": [
    {
      "PolicyId": "sample string 1",
      "ChargeAmount": 1.0,
      "ConvenienceFeeType": "sample string 2"
    },
    {
      "PolicyId": "sample string 1",
      "ChargeAmount": 1.0,
      "ConvenienceFeeType": "sample string 2"
    }
  ],
  "PortalOneSessionKey": "sample string 1"
}
<GetConvenienceFeesListEftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>sample string 1</PortalOneSessionKey><ChargeAmounts><ConvenienceFeeRequestItem><ChargeAmount>1</ChargeAmount><ConvenienceFeeType>sample string 2</ConvenienceFeeType><PolicyId>sample string 1</PolicyId></ConvenienceFeeRequestItem><ConvenienceFeeRequestItem><ChargeAmount>1</ChargeAmount><ConvenienceFeeType>sample string 2</ConvenienceFeeType><PolicyId>sample string 1</PolicyId></ConvenienceFeeRequestItem></ChargeAmounts></GetConvenienceFeesListEftRequest>

Response Information

GetConvenienceFeesListEftResponse

NameDescriptionTypeAdditional information
FeesList

Collection of ConvenienceFeeResult
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "FeesList": [
    {
      "PolicyId": "sample string 1",
      "ConvenienceFee": 2.0,
      "CalculationType": "sample string 3",
      "FlatRate": 1.0,
      "Percent": 1.0,
      "MinimumAmount": 1.0
    },
    {
      "PolicyId": "sample string 1",
      "ConvenienceFee": 2.0,
      "CalculationType": "sample string 3",
      "FlatRate": 1.0,
      "Percent": 1.0,
      "MinimumAmount": 1.0
    }
  ],
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<GetConvenienceFeesListEftResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>sample string 1</ResponseCode><ResponseMessage>sample string 2</ResponseMessage><FeesList><ConvenienceFeeResult><CalculationType>sample string 3</CalculationType><ConvenienceFee>2</ConvenienceFee><FlatRate>1</FlatRate><MinimumAmount>1</MinimumAmount><Percent>1</Percent><PolicyId>sample string 1</PolicyId></ConvenienceFeeResult><ConvenienceFeeResult><CalculationType>sample string 3</CalculationType><ConvenienceFee>2</ConvenienceFee><FlatRate>1</FlatRate><MinimumAmount>1</MinimumAmount><Percent>1</Percent><PolicyId>sample string 1</PolicyId></ConvenienceFeeResult></FeesList></GetConvenienceFeesListEftResponse>

POST api/Eft/GetBankData

This operation returns bank data.

GetBankDataRequest

NameDescriptionTypeAdditional information
RoutingNumber

Routing number

string

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "RoutingNumber": "121042882",
  "PortalOneSessionKey": "de4e450c-4e7d-42b8-9c14-2cc75816b93b"
}
<GetBankDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>de4e450c-4e7d-42b8-9c14-2cc75816b93b</PortalOneSessionKey>
  <RoutingNumber>121042882</RoutingNumber>
</GetBankDataRequest>

Response Information

GetBankDataResponse

NameDescriptionTypeAdditional information
BankName

Bank name

string
BankAddress

Bank address

string
BankCity

Bank city

string
BankState

Bank state

string
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "BankName": "WELLS FARGO BANK NA",
  "BankAddress": "MAC N9301-041",
  "BankCity": "MINNEAPOLIS",
  "BankState": "MN",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetBankDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <BankAddress>MAC N9301-041</BankAddress>
  <BankCity>MINNEAPOLIS</BankCity>
  <BankName>WELLS FARGO BANK NA</BankName>
  <BankState>MN</BankState>
</GetBankDataResponse>

POST api/Eft/VerifyBankAccount

This operation verify bank account.

VerifyBankAccountRequest

NameDescriptionTypeAdditional information
EftDetails

EFT details

EftDetails
Token

Saved Eft Token

string
ClientReferenceData

Client reference data

ClientReferenceData
CustomerId

Client facing customer identifier

string
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "EftDetails": {
    "RoutingNumber": "122199983",
    "AccountNumber": "92361077941",
    "Type": 1,
    "AccountGroupCode": "Default",
    "CustomerName": "John Stevens"
  },
  "Token": null,
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "CustomerId": "D60039CB-DC29-4B9E-B290-C2C233155B9F",
  "PortalOneSessionKey": "5dccb2cf-e032-43a2-9702-43f3ed0828e4"
}
<VerifyBankAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>5dccb2cf-e032-43a2-9702-43f3ed0828e4</PortalOneSessionKey>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <CustomerId>D60039CB-DC29-4B9E-B290-C2C233155B9F</CustomerId>
  <EftDetails>
    <AccountGroupCode>Default</AccountGroupCode>
    <AccountNumber>92361077941</AccountNumber>
    <CustomerName>John Stevens</CustomerName>
    <RoutingNumber>122199983</RoutingNumber>
    <Type>Checking</Type>
  </EftDetails>
  <Token i:nil="true" />
</VerifyBankAccountRequest>

Response Information

VerifyBankAccountResponse

NameDescriptionTypeAdditional information
VerifyBankAccountDescription

Operation result description

string
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "VerifyBankAccountDescription": "Bank Account Validation is successful",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<VerifyBankAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <VerifyBankAccountDescription>Bank Account Validation is successful</VerifyBankAccountDescription>
</VerifyBankAccountResponse>

POST api/Eft/AcknowledgePayment

This method allows acknowledge successful payment

AcknowledgePaymentRequest

NameDescriptionTypeAdditional information
TransactionId

Transaction Id

string

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "TransactionId": "123",
  "PortalOneSessionKey": "3188ce9d-1607-4d1e-aae4-31e5374ccabb"
}
<AcknowledgePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>3188ce9d-1607-4d1e-aae4-31e5374ccabb</PortalOneSessionKey>
  <TransactionId>123</TransactionId>
</AcknowledgePaymentRequest>

Response Information

AcknowledgePaymentResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": null
}
<AcknowledgePaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
</AcknowledgePaymentResponse>

PaymentMethod

POST api/PaymentMethod/Get

This operation returns saved payment methods.

GetPaymentMethodRequest

NameDescriptionTypeAdditional information
CustomerId

Client facing customer identifier

string

Required

PortalOneSessionKey

Session key. Either Session key or Authentication key parameter is required

string
PortalOneAuthenticationKey

Authentication key. Either Session key or Authentication key parameter is required

string

Request Formats

 
{
  "CustomerId": "D60039CB-DC29-4B9E-B290-C2C233155B9F",
  "PortalOneSessionKey": "87673ef2-6f59-4877-8e9f-623d10793638",
  "PortalOneAuthenticationKey": null
}
<GetPaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneAuthenticationKey i:nil="true" />
  <PortalOneSessionKey>87673ef2-6f59-4877-8e9f-623d10793638</PortalOneSessionKey>
  <CustomerId>D60039CB-DC29-4B9E-B290-C2C233155B9F</CustomerId>
</GetPaymentMethodRequest>

Response Information

GetPaymentMethodResponse

NameDescriptionTypeAdditional information
PaymentMethods

Payment methods

Collection of PaymentMethod
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

IEnumerableOfPaymentMethod

NameDescriptionTypeAdditional information
PaymentMethodId

Payment method identifier

integer
CustomerId

Customer identifier

integer
PolicyHashId

Policy hash identifier

integer
PaymentMethodType

Payment method type

PaymentMethodType
ProcessOneToken

ProcessOne payment token

string
IsDefault

Is default flag

boolean
CardExpirationMonth

Card expiration month

integer
CardExpirationYear

Card expiration year

integer
CustomerName

Customer name

string
DateAdded

Date when payment method was added

date
BillingZipCode

ZIP Code

string
CreditCardType

Card type

CreditCardType
BankAccountType

Bank account type

EftAccountType
LastFour

Last for digits

string
CardHolderAddress

Card holder address

string
BankName

Bank name

string

PaymentMethodType

Possible enumeration values:

NameValueDescription
CreditCard

0

Credit card

Eft

1

Eft

Response Formats

{
  "PaymentMethods": [
    {
      "PaymentMethodId": 1,
      "CustomerId": 1,
      "PolicyHashId": 0,
      "PaymentMethodType": 0,
      "ProcessOneToken": "57b332ed-9ccc-4c72-a618-9291944369d8",
      "IsDefault": false,
      "CardExpirationMonth": 1,
      "CardExpirationYear": 2021,
      "CustomerName": "Janet Smith",
      "DateAdded": "2020-02-19T12:50:48",
      "BillingZipCode": "12345",
      "CreditCardType": 1,
      "BankAccountType": 0,
      "LastFour": "1111",
      "CardHolderAddress": "64, Force Hill Rd, Livingston, NJ",
      "BankName": null
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetPaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>Success</ResponseCode><ResponseMessage i:nil="true" /><PaymentMethods><PaymentMethod><BankAccountType>Undefined</BankAccountType><BankName i:nil="true" /><BillingZipCode>12345</BillingZipCode><CardExpirationMonth>1</CardExpirationMonth><CardExpirationYear>2021</CardExpirationYear><CardHolderAddress>64, Force Hill Rd, Livingston, NJ</CardHolderAddress><CreditCardType>Visa</CreditCardType><CustomerId>1</CustomerId><CustomerName>Janet Smith</CustomerName><DateAdded>2020-02-19T12:50:48.7790335-08:00</DateAdded><IsDefault>false</IsDefault><LastFour>1111</LastFour><PaymentMethodId>1</PaymentMethodId><PaymentMethodType>CreditCard</PaymentMethodType><PolicyHashId>0</PolicyHashId><ProcessOneToken>57b332ed-9ccc-4c72-a618-9291944369d8</ProcessOneToken></PaymentMethod></PaymentMethods></GetPaymentMethodResponse>

POST api/PaymentMethod/GetDefault

This operation returns default payment method.

GetDefaultPaymentMethodRequest

NameDescriptionTypeAdditional information
CustomerId

Client facing customer identifier

string

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "CustomerId": "D60039CB-DC29-4B9E-B290-C2C233155B9F",
  "PortalOneSessionKey": "9470a8c4-223f-4991-8e8b-b006a96e18e3"
}
<GetDefaultPaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>9470a8c4-223f-4991-8e8b-b006a96e18e3</PortalOneSessionKey>
  <CustomerId>D60039CB-DC29-4B9E-B290-C2C233155B9F</CustomerId>
</GetDefaultPaymentMethodRequest>

Response Information

GetDefaultPaymentMethodResponse

NameDescriptionTypeAdditional information
PaymentMethod

Default payment method

PaymentMethod
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

PaymentMethod

NameDescriptionTypeAdditional information
PaymentMethodId

Payment method identifier

integer
CustomerId

Customer identifier

integer
PolicyHashId

Policy hash identifier

integer
PaymentMethodType

Payment method type

PaymentMethodType
ProcessOneToken

ProcessOne payment token

string
IsDefault

Is default flag

boolean
CardExpirationMonth

Card expiration month

integer
CardExpirationYear

Card expiration year

integer
CustomerName

Customer name

string
DateAdded

Date when payment method was added

date
BillingZipCode

ZIP Code

string
CreditCardType

Card type

CreditCardType
BankAccountType

Bank account type

EftAccountType
LastFour

Last for digits

string
CardHolderAddress

Card holder address

string
BankName

Bank name

string

Response Formats

{
  "PaymentMethod": {
    "PaymentMethodId": 1,
    "CustomerId": 1,
    "PolicyHashId": 0,
    "PaymentMethodType": 0,
    "ProcessOneToken": "79cd5e08-f1c1-4a50-8787-7ef50e1696a0",
    "IsDefault": true,
    "CardExpirationMonth": 1,
    "CardExpirationYear": 2021,
    "CustomerName": "Janet Smith",
    "DateAdded": "2020-02-19T12:50:48",
    "BillingZipCode": "12345",
    "CreditCardType": 1,
    "BankAccountType": 0,
    "LastFour": "1111",
    "CardHolderAddress": "64, Force Hill Rd, Livingston, NJ",
    "BankName": null
  },
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetDefaultPaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <PaymentMethod>
    <BankAccountType>Undefined</BankAccountType>
    <BankName i:nil="true" />
    <BillingZipCode>12345</BillingZipCode>
    <CardExpirationMonth>1</CardExpirationMonth>
    <CardExpirationYear>2021</CardExpirationYear>
    <CardHolderAddress>64, Force Hill Rd, Livingston, NJ</CardHolderAddress>
    <CreditCardType>Visa</CreditCardType>
    <CustomerId>1</CustomerId>
    <CustomerName>Janet Smith</CustomerName>
    <DateAdded>2020-02-19T12:50:48</DateAdded>
    <IsDefault>true</IsDefault>
    <LastFour>1111</LastFour>
    <PaymentMethodId>1</PaymentMethodId>
    <PaymentMethodType>CreditCard</PaymentMethodType>
    <PolicyHashId>0</PolicyHashId>
    <ProcessOneToken>79cd5e08-f1c1-4a50-8787-7ef50e1696a0</ProcessOneToken>
  </PaymentMethod>
</GetDefaultPaymentMethodResponse>

POST api/PaymentMethod/SetAsDefault

This operation sets the default payment method.

SetAsDefaultPaymentMethodRequest

NameDescriptionTypeAdditional information
CustomerId

Client facing customer identifier

string

Required

ProcessOneToken

ProcessOne payment token

string

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "CustomerId": "77d115d9-7d16-49da-9fd8-2840692f35ba",
  "ProcessOneToken": "5e1e683f-079d-4eea-8921-03959531b802",
  "PortalOneSessionKey": "6f7a7aaa-c908-46b7-b368-b77fd32126b3"
}
<SetAsDefaultPaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>6f7a7aaa-c908-46b7-b368-b77fd32126b3</PortalOneSessionKey>
  <CustomerId>77d115d9-7d16-49da-9fd8-2840692f35ba</CustomerId>
  <ProcessOneToken>5e1e683f-079d-4eea-8921-03959531b802</ProcessOneToken>
</SetAsDefaultPaymentMethodRequest>

Response Information

SetAsDefaultPaymentMethodResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": null
}
<SetAsDefaultPaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
</SetAsDefaultPaymentMethodResponse>

POST api/PaymentMethod/Remove

This operation removes payment method.

RemovePaymentMethodRequest

NameDescriptionTypeAdditional information
CustomerId

Client facing customer identifier

string

Required

ProcessOneToken

ProcessOne payment token

string

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "CustomerId": "3ff22456-0139-43b0-b7b5-e4b372405fcb",
  "ProcessOneToken": "9327bcda-9155-47e1-ac52-e8ccb5b5e83d",
  "PortalOneSessionKey": "95eae32c-2e99-4f2e-a7f0-e9be97c9cf7d"
}
<RemovePaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>95eae32c-2e99-4f2e-a7f0-e9be97c9cf7d</PortalOneSessionKey>
  <CustomerId>3ff22456-0139-43b0-b7b5-e4b372405fcb</CustomerId>
  <ProcessOneToken>9327bcda-9155-47e1-ac52-e8ccb5b5e83d</ProcessOneToken>
</RemovePaymentMethodRequest>

Response Information

RemovePaymentMethodResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": null
}
<RemovePaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
</RemovePaymentMethodResponse>

AutoPay

POST api/AutoPay/Cancel

This operation is used to cancel existing AutoPay Enrollment.

CancelAutoPayRequest

NameDescriptionTypeAdditional information
AutoPayEnrollmentIds

Collection of AutoPay Enrollment Ids which should be cancelled

Collection of integer

Min length: 1

ExtendedParameters

The collection of key value pairs for optional parameters

Dictionary of string and string
PortalOneSessionKey

Session key

string

Request Formats

 
{
  "AutoPayEnrollmentIds": [
    1,
    2
  ],
  "ExtendedParameters": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "PortalOneSessionKey": "sample string 1"
}
<CancelAutoPayRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>sample string 1</PortalOneSessionKey><AutoPayEnrollmentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:int>1</d2p1:int><d2p1:int>2</d2p1:int></AutoPayEnrollmentIds><ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:KeyValueOfstringstring><d2p1:Key>sample string 1</d2p1:Key><d2p1:Value>sample string 2</d2p1:Value></d2p1:KeyValueOfstringstring><d2p1:KeyValueOfstringstring><d2p1:Key>sample string 3</d2p1:Key><d2p1:Value>sample string 4</d2p1:Value></d2p1:KeyValueOfstringstring></ExtendedParameters></CancelAutoPayRequest>

Response Information

CancelAutoPayResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<CancelAutoPayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
</CancelAutoPayResponse>

POST api/AutoPay/ChangePaymentMethod

This operation is used to change Payment Method of AutoPay Enrollments

ChangeAutoPaysPaymentMethodRequest

NameDescriptionTypeAdditional information
AutoPayEnrollmentIds

Collection of AutoPay Enrollment Ids which should be updated

Collection of integer

Min length: 1

Token

New Payment Method Token

string

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "AutoPayEnrollmentIds": [
    1,
    2
  ],
  "Token": "sample string 1",
  "PortalOneSessionKey": "sample string 2"
}
<ChangeAutoPaysPaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>sample string 2</PortalOneSessionKey><AutoPayEnrollmentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:int>1</d2p1:int><d2p1:int>2</d2p1:int></AutoPayEnrollmentIds><Token>sample string 1</Token></ChangeAutoPaysPaymentMethodRequest>

Response Information

ChangeAutoPaysPaymentMethodResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

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": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<ChangeAutoPaysPaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
</ChangeAutoPaysPaymentMethodResponse>

POST api/AutoPay/CheckPaymentMethodStatus

This operation returns the result of checking the use of the payment method for AutoPay.

CheckPaymentMethodAutoPayStatusRequest

NameDescriptionTypeAdditional information
Token

Payment Method Token

string

Required

PortalOneSessionKey

Session key

string

Request Formats

 
{
  "Token": "sample string 1",
  "PortalOneSessionKey": "sample string 2"
}
<CheckPaymentMethodAutoPayStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>sample string 2</PortalOneSessionKey>
  <Token>sample string 1</Token>
</CheckPaymentMethodAutoPayStatusRequest>

Response Information

CheckPaymentMethodAutoPayStatusResponse

NameDescriptionTypeAdditional information
AutoPayEnrollments

All related AutoPay Enrollments

Collection of PaymentMethodAutoPayEnrollment
IsAutoPayEnrolled

Is AutoPay Enrolled

boolean
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

PaymentMethodAutoPayEnrollment

NameDescriptionTypeAdditional information
AutoPayEnrollmentId

Unique identifier for AutoPay Enrollment

integer
PolicyNumberRef

Policy Number

string

Response Formats

{
  "AutoPayEnrollments": [
    {
      "AutoPayEnrollmentId": 1,
      "PolicyNumberRef": "sample string 2"
    },
    {
      "AutoPayEnrollmentId": 1,
      "PolicyNumberRef": "sample string 2"
    }
  ],
  "IsAutoPayEnrolled": true,
  "ResponseCode": "sample string 2",
  "ResponseMessage": "sample string 3"
}
<CheckPaymentMethodAutoPayStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><ResponseCode>sample string 2</ResponseCode><ResponseMessage>sample string 3</ResponseMessage><AutoPayEnrollments><PaymentMethodAutoPayEnrollment><AutoPayEnrollmentId>1</AutoPayEnrollmentId><PolicyNumberRef>sample string 2</PolicyNumberRef></PaymentMethodAutoPayEnrollment><PaymentMethodAutoPayEnrollment><AutoPayEnrollmentId>1</AutoPayEnrollmentId><PolicyNumberRef>sample string 2</PolicyNumberRef></PaymentMethodAutoPayEnrollment></AutoPayEnrollments><IsAutoPayEnrolled>true</IsAutoPayEnrolled></CheckPaymentMethodAutoPayStatusResponse>

POST api/AutoPay/Enroll

This operation is used to create a new AutoPay Enrollment.

EnrollAutoPayRequest

NameDescriptionTypeAdditional information
AmountPerInstallment

Payment amount for each installment

decimal number

Required

ChargeFee

Should we charge with fee (default - true)

boolean
CustomerId

Client facing customer identifier. Either CustomerName or CustomerId is required

globally unique identifier
CustomerName

Customer Name. Either CustomerName or CustomerId is required

string

String length: inclusive between 0 and 250

Email

Customer email address(es). Send multiple addresses as semicolon delimited values.

string

String length: inclusive between 0 and 250

NumberOfInstallments

Number of installment payments to be made

integer

Required

Range: inclusive between 1 and 300

PaymentMethodDetails

Details that will be used to define the payment method for AutoPay.

AutoPayPaymentMethodDetails

Required

PolicyRefNumber

Policy Number

string

Required

WithdrawalDay

Specifies day of month when payments should be made. Either WithdrawalDay or EffectiveDate should be specified.

integer
EffectiveDate

The date on which the first installment plan payment will be made. Must be at least plus one day from the current date. Either WithdrawalDay or EffectiveDate should be specified.

date
WithdrawalFrequency

Specifies how often payments should be made. Options: monthly, quarterly, semiannually, annually

WithdrawalFrequency

Required

SuppressPlanChangedSignalIOnEnrollment

Suppresses SignalInstallmentPlanChanged sending on Enrollment when the flag value is true.

boolean
ExtendedParameters

The collection of key value pairs for optional customer parameters

Dictionary of string and string
PortalOneSessionKey

Session key

string

AutoPayPaymentMethodDetails

NameDescriptionTypeAdditional information
Token

Saved payment method token that will be used for the remaining installment payments.

string
CardDetails

Card details that will be used for the remaining installment payments.

CardDetails
EftDetails

Eft details that will be used for the remaining installment payments.

EftDetails

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

 
{
  "AmountPerInstallment": 1.0,
  "ChargeFee": true,
  "CustomerId": "b385c698-c9c5-46e5-9a7f-cc2d38caf348",
  "CustomerName": "sample string 2",
  "Email": "sample string 3",
  "NumberOfInstallments": 1,
  "PaymentMethodDetails": {
    "Token": "sample string 1",
    "CardDetails": {
      "ExpirationYear": 1,
      "ExpirationMonth": 1,
      "Holder": {
        "Name": "sample string 1",
        "Zip": "sample string 2",
        "Address": "sample string 3"
      },
      "Number": "sample string 1",
      "ValidationValue": "sample string 2"
    },
    "EftDetails": {
      "RoutingNumber": "sample string 1",
      "AccountNumber": "sample string 2",
      "Type": 0,
      "AccountGroupCode": "sample string 3",
      "CustomerName": "sample string 4"
    }
  },
  "PolicyRefNumber": "sample string 4",
  "WithdrawalDay": 1,
  "EffectiveDate": "2020-02-19T12:50:49",
  "WithdrawalFrequency": 1,
  "SuppressPlanChangedSignalIOnEnrollment": true,
  "ExtendedParameters": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "PortalOneSessionKey": "sample string 5"
}
<EnrollAutoPayRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts"><PortalOneSessionKey>sample string 5</PortalOneSessionKey><AmountPerInstallment>1</AmountPerInstallment><ChargeFee>true</ChargeFee><CustomerId>b385c698-c9c5-46e5-9a7f-cc2d38caf348</CustomerId><CustomerName>sample string 2</CustomerName><EffectiveDate>2020-02-19T12:50:49.7165297-08:00</EffectiveDate><Email>sample string 3</Email><ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:KeyValueOfstringstring><d2p1:Key>sample string 1</d2p1:Key><d2p1:Value>sample string 2</d2p1:Value></d2p1:KeyValueOfstringstring><d2p1:KeyValueOfstringstring><d2p1:Key>sample string 3</d2p1:Key><d2p1:Value>sample string 4</d2p1:Value></d2p1:KeyValueOfstringstring></ExtendedParameters><NumberOfInstallments>1</NumberOfInstallments><PaymentMethodDetails><CardDetails><ExpirationMonth>1</ExpirationMonth><ExpirationYear>1</ExpirationYear><Holder><Address>sample string 3</Address><Name>sample string 1</Name><Zip>sample string 2</Zip></Holder><Number>sample string 1</Number><ValidationValue>sample string 2</ValidationValue></CardDetails><EftDetails><AccountGroupCode>sample string 3</AccountGroupCode><AccountNumber>sample string 2</AccountNumber><CustomerName>sample string 4</CustomerName><RoutingNumber>sample string 1</RoutingNumber><Type>Undefined</Type></EftDetails><Token>sample string 1</Token></PaymentMethodDetails><PolicyRefNumber>sample string 4</PolicyRefNumber><SuppressPlanChangedSignalIOnEnrollment>true</SuppressPlanChangedSignalIOnEnrollment><WithdrawalDay>1</WithdrawalDay><WithdrawalFrequency>Monthly</WithdrawalFrequency></EnrollAutoPayRequest>

Response Information

EnrollAutoPayResponse

NameDescriptionTypeAdditional information
AutoPayEnrollmentId

Unique identifier for AutoPay Enrollment

integer
ResponseCode

Operation response code

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string

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

Response Formats

{
  "AutoPayEnrollmentId": 1,
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<EnrollAutoPayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
  <AutoPayEnrollmentId>1</AutoPayEnrollmentId>
</EnrollAutoPayResponse>

POST api/AutoPay/SearchActiveEnrollments

This operation returns an active AutoPay Enrollments for provided policies.

SearchActiveEnrollmentsRequest

NameDescriptionTypeAdditional information
PolicyRefNumbers

Collections of Policy Numbers

Collection of s