Account

ClaimsPay account operations

POST api/Account/Create

This method is used to create a ClaimsPay account and associated claims records, company/contact records and individual records.

CreateAccountRequest

NameDescriptionTypeAdditional information
CompanyDetails

Details on the company and contact for which the ClaimsPay Account will be created. See CompanyDetails object.

CompanyDetails

None.

IndividualDetails

Details on the individual for which the ClaimsPay Account will be created.

IndividualDetails

None.

ClaimNumber

Optional field for a claim number that will be associated to the operation.

string

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

CompanyDetails

NameDescriptionTypeAdditional information
CompanyName

The name of the company entity.

string

Required

String length: inclusive between 0 and 256

TaxId

The tax ID for the company entity. As unique identifier can be used to present saved payment methods for company entity on the epay webpage.

string

String length: inclusive between 0 and 10

Address

The physical street address for the company.

string

Required

String length: inclusive between 0 and 256

City

The city for the company.

string

Required

String length: inclusive between 0 and 256

State

The state for the company.

string

Required

String length: inclusive between 0 and 100

Zip

The zip code for the company.

string

Required

Matching regular expression pattern: \d{5}

ContactDetails

Details on the company contact person to whom the payment method will be associated.

ContactDetails

Required

ContactDetails

NameDescriptionTypeAdditional information
ContactId

The contactId that is stored in the ClaimsPay system for the company contact. If this value is provided, the system will update the stored information. If the value is not provided the system will create a new account.

integer

None.

FirstName

The first name of the company contact to whom the payment method will be associated.

string

Required

String length: inclusive between 0 and 256

LastName

The last name of the company contact to whom the payment method will be associated.

string

Required

String length: inclusive between 0 and 256

Email

The email address for the company contact; will pre-populate ePay email Address if available.

string

Required

PhoneNumber

The phone number for the company contact.

string

Required

String length: inclusive between 0 and 100

WebAccess

Value that will indicate if the contact will have access to the company website. If property is not provided, default value is enable.

WebAccessType

None.

WebAccessType

Possible enumeration values:

NameValueDescription
Enabled

0

Enabled

Disabled

1

Disabled

IndividualDetails

NameDescriptionTypeAdditional information
FirstName

The first name of the Payee to whom the payment method will be associated.

string

Required

String length: inclusive between 0 and 256

LastName

The last name of the Payee to whom the payment method will be associated.

string

Required

String length: inclusive between 0 and 256

Email

The Payee’s email address; will pre-populate ePay email Address if available.

string

Required

Address

The street address for the individual payee.

string

Required

String length: inclusive between 0 and 256

City

The city for the individual payee.

string

Required

String length: inclusive between 0 and 256

State

The state for the individual payee.

string

Required

String length: inclusive between 0 and 100

Zip

The zip code for the individual payee.

string

Required

Matching regular expression pattern: \d{5}

PhoneNumber

The Payee's phone number.

string

Required

String length: inclusive between 0 and 100

Request Formats

 
{
  "CompanyDetails": {
    "CompanyName": "Main Street Body Shop",
    "TaxId": "1234567890",
    "Address": "123 Main St.",
    "City": "Folsom",
    "State": "CA",
    "Zip": "95630",
    "ContactDetails": {
      "ContactId": 123,
      "FirstName": "Janet",
      "LastName": "Smith",
      "Email": "test@oneincsystems.com",
      "PhoneNumber": "1234567890",
      "WebAccess": 0
    }
  },
  "IndividualDetails": {
    "FirstName": "Janet",
    "LastName": "Smith",
    "Email": "test@oneincsystems.com",
    "Address": "123 Main St.",
    "City": "Folsom",
    "State": "CA",
    "Zip": "95630",
    "PhoneNumber": "1234567890"
  },
  "ClaimNumber": "C12345",
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<CreateAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Account">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <ClaimNumber>C12345</ClaimNumber>
  <CompanyDetails>
    <Address>123 Main St.</Address>
    <City>Folsom</City>
    <CompanyName>Main Street Body Shop</CompanyName>
    <ContactDetails>
      <ContactId>123</ContactId>
      <Email>test@oneincsystems.com</Email>
      <FirstName>Janet</FirstName>
      <LastName>Smith</LastName>
      <PhoneNumber>1234567890</PhoneNumber>
      <WebAccess>Enabled</WebAccess>
    </ContactDetails>
    <State>CA</State>
    <TaxId>1234567890</TaxId>
    <Zip>95630</Zip>
  </CompanyDetails>
  <IndividualDetails>
    <Address>123 Main St.</Address>
    <City>Folsom</City>
    <Email>test@oneincsystems.com</Email>
    <FirstName>Janet</FirstName>
    <LastName>Smith</LastName>
    <PhoneNumber>1234567890</PhoneNumber>
    <State>CA</State>
    <Zip>95630</Zip>
  </IndividualDetails>
</CreateAccountRequest>

Response Information

CreateAccountResponse

NameDescriptionTypeAdditional information
AccountId

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

integer

None.

ContactId

Company Contact identifier. Only applicable to company accounts.

integer

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "AccountId": 123,
  "ContactId": 123,
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<CreateAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Account">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts"></ResponseMessage>
  <AccountId>123</AccountId>
  <ContactId>123</ContactId>
</CreateAccountResponse>

POST api/Account/CreateContact

This method is used to create a ClaimsPay contact associated with ClaimsPay account.

CreateContactRequest

NameDescriptionTypeAdditional information
AccountId

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

integer

Required

FirstName

The first name of the company contact.

string

Required

LastName

The last name of the company contact.

string

Required

Email

The email address for the company contact.

string

Required

Phone

The phone number for the company contact.

string

Required

Matching regular expression pattern: \d{10}

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

Request Formats

 
{
  "AccountId": 123,
  "FirstName": "Janet",
  "LastName": "Smith",
  "Email": "test@oneincsystems.com",
  "Phone": "1234567890",
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<CreateContactRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Account">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <AccountId>123</AccountId>
  <Email>test@oneincsystems.com</Email>
  <FirstName>Janet</FirstName>
  <LastName>Smith</LastName>
  <Phone>1234567890</Phone>
</CreateContactRequest>

Response Information

CreateContactResponse

NameDescriptionTypeAdditional information
AccountId

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

integer

None.

ContactId

Company Contact identifier. Only applicable to company accounts.

integer

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "AccountId": 123,
  "ContactId": 123,
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<CreateContactResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Account">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts"></ResponseMessage>
  <AccountId>123</AccountId>
  <ContactId>123</ContactId>
</CreateContactResponse>

POST api/Account/Update

This method is used to update a ClaimsPay account profile and Prepaid Account vendor profile.

UpdateAccountRequest

NameDescriptionTypeAdditional information
AccountId

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

integer

None.

IndividualProfileDetails

Individual profile information. See IndividualProfileDetails object.

IndividualProfileDetails

None.

CompanyProfileDetails

Company and contact profile information. See CompanyProfileDetails object.

CompanyProfileDetails

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

IndividualProfileDetails

NameDescriptionTypeAdditional information
FirstName

The first name of the Payee to whom the payment method will be associated.

string

None.

LastName

The last name of the Payee to whom the payment method will be associated.

string

None.

Phone

The Payee's phone number.

string

None.

Address

The street address for the individual payee.

string

None.

City

The city for the individual payee.

string

None.

State

The state for the individual payee.

string

None.

Zip

The zip code for the individual payee.

string

None.

CompanyProfileDetails

NameDescriptionTypeAdditional information
CompanyName

The name of the company entity.

string

None.

Address

The physical street address for the company.

string

None.

City

The city for the company.

string

None.

State

The state for the company.

string

None.

Zip

The zip code for the company.

string

None.

ContactDetails

Details on the company contact person profile.

ContactProfileDetails

None.

ContactProfileDetails

NameDescriptionTypeAdditional information
ContactId

The ContactId that is stored in the ClaimsPay system for the company contact.

integer

None.

FirstName

The first name of the company contact to whom the payment method will be associated.

string

None.

LastName

The last name of the company contact to whom the payment method will be associated.

string

None.

Phone

The phone number for the company contact.

string

None.

Email

The email address for the company contact.

string

None.

WebAccessType

Value that will indicate if the contact will have access to the company website. If property is not provided, default value is enable.

WebAccessType

None.

Request Formats

 
{
  "AccountId": 123,
  "IndividualProfileDetails": {
    "FirstName": "Janet",
    "LastName": "Smith",
    "Phone": "1234567890",
    "Address": "123 Main St.",
    "City": "Folsom",
    "State": "CA",
    "Zip": "95630"
  },
  "CompanyProfileDetails": {
    "CompanyName": "Main Street Body Shop",
    "Address": "123 Main St.",
    "City": "Folsom",
    "State": "CA",
    "Zip": "95630",
    "ContactDetails": {
      "ContactId": 123,
      "FirstName": "Janet",
      "LastName": "Smith",
      "Phone": "1234567890",
      "Email": "test@oneincsystems.com",
      "WebAccessType": 0
    }
  },
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<UpdateAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Account">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <AccountId>123</AccountId>
  <CompanyProfileDetails>
    <Address>123 Main St.</Address>
    <City>Folsom</City>
    <CompanyName>Main Street Body Shop</CompanyName>
    <ContactDetails>
      <ContactId>123</ContactId>
      <Email>test@oneincsystems.com</Email>
      <FirstName>Janet</FirstName>
      <LastName>Smith</LastName>
      <Phone>1234567890</Phone>
      <WebAccessType>Enabled</WebAccessType>
    </ContactDetails>
    <State>CA</State>
    <Zip>95630</Zip>
  </CompanyProfileDetails>
  <IndividualProfileDetails>
    <Address>123 Main St.</Address>
    <City>Folsom</City>
    <FirstName>Janet</FirstName>
    <LastName>Smith</LastName>
    <Phone>1234567890</Phone>
    <State>CA</State>
    <Zip>95630</Zip>
  </IndividualProfileDetails>
</UpdateAccountRequest>

Response Information

UpdateAccountResponse

NameDescriptionTypeAdditional information
TransactionId

Transaction identifier

integer

None.

IndividualProfileDetails

Individual profile information. See IndividualProfileDetails object.

IndividualProfileDetails

None.

CompanyProfileDetails

Company and contact profile information. See CompanyProfileDetails object.

CompanyProfileDetails

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "TransactionId": 123,
  "IndividualProfileDetails": {
    "FirstName": "Janet",
    "LastName": "Smith",
    "Phone": "1234567890",
    "Address": "123 Main St.",
    "City": "Folsom",
    "State": "CA",
    "Zip": "95630"
  },
  "CompanyProfileDetails": {
    "CompanyName": "Main Street Body Shop",
    "Address": "123 Main St.",
    "City": "Folsom",
    "State": "CA",
    "Zip": "95630",
    "ContactDetails": {
      "ContactId": 123,
      "FirstName": "Janet",
      "LastName": "Smith",
      "Phone": "1234567890",
      "Email": "test@oneincsystems.com",
      "WebAccessType": 0
    }
  },
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<UpdateAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Account">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts"></ResponseMessage>
  <CompanyProfileDetails>
    <Address>123 Main St.</Address>
    <City>Folsom</City>
    <CompanyName>Main Street Body Shop</CompanyName>
    <ContactDetails>
      <ContactId>123</ContactId>
      <Email>test@oneincsystems.com</Email>
      <FirstName>Janet</FirstName>
      <LastName>Smith</LastName>
      <Phone>1234567890</Phone>
      <WebAccessType>Enabled</WebAccessType>
    </ContactDetails>
    <State>CA</State>
    <Zip>95630</Zip>
  </CompanyProfileDetails>
  <IndividualProfileDetails>
    <Address>123 Main St.</Address>
    <City>Folsom</City>
    <FirstName>Janet</FirstName>
    <LastName>Smith</LastName>
    <Phone>1234567890</Phone>
    <State>CA</State>
    <Zip>95630</Zip>
  </IndividualProfileDetails>
  <TransactionId>123</TransactionId>
</UpdateAccountResponse>

POST api/Account/GetInfo

This method is used to get a ClaimsPay account information.

GetAccountInfoRequest

NameDescriptionTypeAdditional information
AccountId

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

integer

Required

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

Request Formats

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

Response Information

GetAccountInfoResponse

NameDescriptionTypeAdditional information
IndividualDetails

Individual Details

IndividualDetails

None.

CompanyInformation

Company Information

CompanyInformation

None.

BankAccounts

Bank Accounts

Collection of BankAccountSummary

None.

PrepaidCardAccountExists

Prepaid Card Account Exists

boolean

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

CompanyInformation

NameDescriptionTypeAdditional information
CompanyName

Company Name

string

None.

TaxId

Tax Id

string

None.

Address

Address

string

None.

City

City

string

None.

State

State

string

None.

Zip

Zip

string

None.

ContactsDetails

Contact Details

Collection of ContactDetails

None.

BankAccountSummary

NameDescriptionTypeAdditional information
Token

Bank Account payment token

string

None.

AccountType

Checking / Savings.

BankAccountType

None.

LastFourDigits

Last four digits of the bank account number.

string

None.

BankName

Name of Bank based off of Routing Number.

string

None.

NameOnAccount

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

string

None.

BankAccountType

Possible enumeration values:

NameValueDescription
Checking

0

Checking

Savings

1

Savings

Response Formats

{
  "IndividualDetails": {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "Email": "sample string 3",
    "Address": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "Zip": "sample string 7",
    "PhoneNumber": "sample string 8"
  },
  "CompanyInformation": {
    "CompanyName": "sample string 1",
    "TaxId": "sample string 2",
    "Address": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "Zip": "sample string 6",
    "ContactsDetails": [
      {
        "ContactId": 1,
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Email": "sample string 3",
        "PhoneNumber": "sample string 4",
        "WebAccess": 0
      },
      {
        "ContactId": 1,
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Email": "sample string 3",
        "PhoneNumber": "sample string 4",
        "WebAccess": 0
      }
    ]
  },
  "BankAccounts": [
    {
      "Token": "sample string 1",
      "AccountType": 0,
      "LastFourDigits": "sample string 2",
      "BankName": "sample string 3",
      "NameOnAccount": "sample string 4"
    },
    {
      "Token": "sample string 1",
      "AccountType": 0,
      "LastFourDigits": "sample string 2",
      "BankName": "sample string 3",
      "NameOnAccount": "sample string 4"
    }
  ],
  "PrepaidCardAccountExists": true,
  "ResponseCode": "sample string 2",
  "ResponseMessage": "sample string 3"
}
<GetAccountInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Account">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 2</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 3</ResponseMessage>
  <BankAccounts xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
    <d2p1:BankAccountSummary>
      <d2p1:AccountType>Checking</d2p1:AccountType>
      <d2p1:BankName>sample string 3</d2p1:BankName>
      <d2p1:LastFourDigits>sample string 2</d2p1:LastFourDigits>
      <d2p1:NameOnAccount>sample string 4</d2p1:NameOnAccount>
      <d2p1:Token>sample string 1</d2p1:Token>
    </d2p1:BankAccountSummary>
    <d2p1:BankAccountSummary>
      <d2p1:AccountType>Checking</d2p1:AccountType>
      <d2p1:BankName>sample string 3</d2p1:BankName>
      <d2p1:LastFourDigits>sample string 2</d2p1:LastFourDigits>
      <d2p1:NameOnAccount>sample string 4</d2p1:NameOnAccount>
      <d2p1:Token>sample string 1</d2p1:Token>
    </d2p1:BankAccountSummary>
  </BankAccounts>
  <CompanyInformation>
    <Address>sample string 3</Address>
    <City>sample string 4</City>
    <CompanyName>sample string 1</CompanyName>
    <ContactsDetails>
      <ContactDetails>
        <ContactId>1</ContactId>
        <Email>sample string 3</Email>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <PhoneNumber>sample string 4</PhoneNumber>
        <WebAccess>Enabled</WebAccess>
      </ContactDetails>
      <ContactDetails>
        <ContactId>1</ContactId>
        <Email>sample string 3</Email>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <PhoneNumber>sample string 4</PhoneNumber>
        <WebAccess>Enabled</WebAccess>
      </ContactDetails>
    </ContactsDetails>
    <State>sample string 5</State>
    <TaxId>sample string 2</TaxId>
    <Zip>sample string 6</Zip>
  </CompanyInformation>
  <IndividualDetails>
    <Address>sample string 4</Address>
    <City>sample string 5</City>
    <Email>sample string 3</Email>
    <FirstName>sample string 1</FirstName>
    <LastName>sample string 2</LastName>
    <PhoneNumber>sample string 8</PhoneNumber>
    <State>sample string 6</State>
    <Zip>sample string 7</Zip>
  </IndividualDetails>
  <PrepaidCardAccountExists>true</PrepaidCardAccountExists>
</GetAccountInfoResponse>

BankAccount

BankAccount operations

POST api/BankAccount/Credit

This method is used to submit BankAccount payment.

CreditBankAccountRequest

NameDescriptionTypeAdditional information
AccountId

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

integer

Required

Amount

Amount of payment.

decimal number

Required

Token

Saved bank account token.

string

None.

AccountGroupCode

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

string

None.

BankAccountDetails

Bank Account details.

BankAccountDetails

None.

ClaimNumber

Claim number that will be associated to the payment.

string

Required

ClaimDetails

Claim details

string

None.

SourceUser

Identifier/name of user in the source system for reporting purposes.

string

None.

BypassBankAccountValidation

Bypasses bank account validation during save when BankAccountDetails are sent.

boolean

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

BankAccountDetails

NameDescriptionTypeAdditional information
RoutingNumber

The bank routing number. Must only contain numbers.

string

None.

AccountNumber

The bank account number. Must only contain numbers.

string

None.

CustomerName

Customer Name for this Bank Account.

string

None.

AccountType

Checking / Savings.

BankAccountType

None.

Request Formats

 
{
  "AccountId": 123,
  "Amount": 120.0,
  "Token": null,
  "AccountGroupCode": "Default",
  "BankAccountDetails": {
    "RoutingNumber": "021000021",
    "AccountNumber": "123456789",
    "CustomerName": "Janet Smith",
    "AccountType": 0
  },
  "ClaimNumber": "C12345",
  "ClaimDetails": null,
  "SourceUser": "Janet Smith",
  "BypassBankAccountValidation": true,
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<CreditBankAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.BankAccount">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <AccountGroupCode>Default</AccountGroupCode>
  <AccountId>123</AccountId>
  <Amount>120</Amount>
  <BankAccountDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
    <d2p1:AccountNumber>123456789</d2p1:AccountNumber>
    <d2p1:AccountType>Checking</d2p1:AccountType>
    <d2p1:CustomerName>Janet Smith</d2p1:CustomerName>
    <d2p1:RoutingNumber>021000021</d2p1:RoutingNumber>
  </BankAccountDetails>
  <BypassBankAccountValidation>true</BypassBankAccountValidation>
  <ClaimDetails i:nil="true" />
  <ClaimNumber>C12345</ClaimNumber>
  <SourceUser>Janet Smith</SourceUser>
  <Token i:nil="true" />
</CreditBankAccountRequest>

Response Information

CreditBankAccountResponse

NameDescriptionTypeAdditional information
TransactionId

Transaction identifier.

string

None.

TransactionDate

Transaction date and time.

date

None.

TimeZone

Transaction time zone.

string

None.

BatchNumber

Number of the batch.

integer

None.

BankAccountSummary

Bank account summary information.

BankAccountSummary

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "TransactionId": "123",
  "TransactionDate": "2019-02-19T15:32:08.6730266",
  "TimeZone": "Pacific",
  "BatchNumber": 5,
  "BankAccountSummary": {
    "Token": null,
    "AccountType": 0,
    "LastFourDigits": null,
    "BankName": "Test Bank",
    "NameOnAccount": null
  },
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<CreditBankAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.BankAccount">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts"></ResponseMessage>
  <BankAccountSummary xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
    <d2p1:AccountType>Checking</d2p1:AccountType>
    <d2p1:BankName>Test Bank</d2p1:BankName>
    <d2p1:LastFourDigits i:nil="true" />
    <d2p1:NameOnAccount i:nil="true" />
    <d2p1:Token i:nil="true" />
  </BankAccountSummary>
  <BatchNumber>5</BatchNumber>
  <TimeZone>Pacific</TimeZone>
  <TransactionDate>2019-02-19T15:32:08.6730266-08:00</TransactionDate>
  <TransactionId>123</TransactionId>
</CreditBankAccountResponse>

POST api/BankAccount/VoidCredit

This method is used to void EFT payment.

VoidCreditRequest

NameDescriptionTypeAdditional information
TransactionId

Transaction identifier.

string

Required

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

Request Formats

 
{
  "TransactionId": "123",
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<VoidCreditRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.BankAccount">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <TransactionId>123</TransactionId>
</VoidCreditRequest>

Response Information

VoidCreditResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<VoidCreditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.BankAccount">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts"></ResponseMessage>
</VoidCreditResponse>

POST api/BankAccount/Verify

This method is used to verify BankAccount.

VerifyBankAccountRequest

NameDescriptionTypeAdditional information
AccountId

Account Id

integer

Required

BankAccountDetails

Bank Account Details

BankAccountDetails

None.

Token

Saved bank account token.

string

None.

SourceUser

Source User

string

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

Request Formats

 
{
  "AccountId": 1,
  "BankAccountDetails": {
    "RoutingNumber": "sample string 1",
    "AccountNumber": "sample string 2",
    "CustomerName": "sample string 3",
    "AccountType": 0
  },
  "Token": "sample string 2",
  "SourceUser": "sample string 3",
  "ClaimsPayAuthenticationKey": "sample string 4"
}
<VerifyBankAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.BankAccount">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 4</ClaimsPayAuthenticationKey>
  <AccountId>1</AccountId>
  <BankAccountDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
    <d2p1:AccountNumber>sample string 2</d2p1:AccountNumber>
    <d2p1:AccountType>Checking</d2p1:AccountType>
    <d2p1:CustomerName>sample string 3</d2p1:CustomerName>
    <d2p1:RoutingNumber>sample string 1</d2p1:RoutingNumber>
  </BankAccountDetails>
  <SourceUser>sample string 3</SourceUser>
  <Token>sample string 2</Token>
</VerifyBankAccountRequest>

Response Information

VerifyBankAccountResponse

NameDescriptionTypeAdditional information
ServerReferenceData

ServerReferenceData

ServerReferenceData

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

ServerReferenceData

NameDescriptionTypeAdditional information
ServerReferenceData1

ServerReferenceData1

string

None.

Response Formats

{
  "ServerReferenceData": {
    "ServerReferenceData1": "sample string 1"
  },
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<VerifyBankAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.BankAccount">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 1</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 2</ResponseMessage>
  <ServerReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
    <d2p1:ServerReferenceData1>sample string 1</d2p1:ServerReferenceData1>
  </ServerReferenceData>
</VerifyBankAccountResponse>

Session

GET api/Session/Create?ClaimsPayAuthenticationKey={ClaimsPayAuthenticationKey}

This method is used to create a temorary session and get a unique SessionId.

URI Parameters

NameDescriptionTypeAdditional information
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

None.

Response Information

CreateSessionResponse

NameDescriptionTypeAdditional information
SessionId

Temporary identifier in a GUID format.

string

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "SessionId": "c0e516a9-a6f1-4ece-9d6d-75583fca58ae",
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<CreateSessionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Session">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts"></ResponseMessage>
  <SessionId>c0e516a9-a6f1-4ece-9d6d-75583fca58ae</SessionId>
</CreateSessionResponse>

EpayRequest

POST api/EpayRequest/Create

This method is used to create an ePay request.

CreateEpayRequest

NameDescriptionTypeAdditional information
AccountId

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

integer

None.

ContactId

Company Contact identifier. Only applicable to company accounts.

integer

None.

ClaimNumber

Optional field for a claim number that will be associated to the operation.

string

None.

EpayEmailAddress

The email address for the EPay request. If it is not populated, the email will be sent to the Email Address stored for the AccountId or ContactId.

string

None.

EpayRequestType

Type of ePay delivery method that was used for the request

EpayRequestType

None.

EpayPhoneNumber

Phone number to which the ePay SMS was sent

string

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

EpayRequestType

Possible enumeration values:

NameValueDescription
Email

0

Email

TextMessage

1

Text Message (SMS)

Request Formats

 
{
  "AccountId": 123,
  "ContactId": 123,
  "ClaimNumber": "C12345",
  "EpayEmailAddress": "test@oneincsystems.com",
  "EpayRequestType": 0,
  "EpayPhoneNumber": null,
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<CreateEpayRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.EpayRequest">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <AccountId>123</AccountId>
  <ClaimNumber>C12345</ClaimNumber>
  <ContactId>123</ContactId>
  <EpayEmailAddress>test@oneincsystems.com</EpayEmailAddress>
  <EpayPhoneNumber i:nil="true" />
  <EpayRequestType>Email</EpayRequestType>
</CreateEpayRequest>

Response Information

CreateEpayResponse

NameDescriptionTypeAdditional information
EpayRequestId

Unique identifier for the ePay request.

integer

None.

EpayRequestDate

Date the epay request was created.

date

None.

EpayEmailAddress

Email address to which the epay email was sent.

string

None.

EpayRequestType

Type of ePay delivery method that was used for the request

EpayRequestType

None.

EpayPhoneNumber

Phone number to which the ePay SMS was sent

string

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "EpayRequestId": 12,
  "EpayRequestDate": "2019-02-19T15:32:08.8917844",
  "EpayEmailAddress": "test@oneincsystems.com",
  "EpayRequestType": 0,
  "EpayPhoneNumber": null,
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<CreateEpayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.EpayRequest">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts"></ResponseMessage>
  <EpayEmailAddress>test@oneincsystems.com</EpayEmailAddress>
  <EpayPhoneNumber i:nil="true" />
  <EpayRequestDate>2019-02-19T15:32:08.8917844-08:00</EpayRequestDate>
  <EpayRequestId>12</EpayRequestId>
  <EpayRequestType>Email</EpayRequestType>
</CreateEpayResponse>

POST api/EpayRequest/GetStatus

This method is used to get status of an ePay request.

GetStatusByEpayRequest

NameDescriptionTypeAdditional information
EpayRequestId

Unique identifier for the ePay request.

integer

Required

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

Request Formats

 
{
  "EpayRequestId": 12,
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<GetStatusByEpayRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.EpayRequest">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <EpayRequestId>12</EpayRequestId>
</GetStatusByEpayRequest>

Response Information

GetStatusByEpayResponse

NameDescriptionTypeAdditional information
AccountId

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

integer

None.

ContactId

Company Contact identifier. Only applicable to company accounts.

integer

None.

ClaimNumber

Claim number associated to the ePay request.

string

None.

EpayEmailAddress

Email address to which the ePay email was sent.

string

None.

EpayRequestStatus

Status of the ePay request.

ClaimsEpayRequestStatus

None.

EpayRequestDate

Date the ePay request was initiated.

date

None.

BankAccountSummary

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

BankAccountSummary

None.

EpayRequestType

Type of ePay delivery method that was used for the request

EpayRequestType

None.

EpayPhoneNumber

Phone number to which the ePay SMS was sent

string

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

ClaimsEpayRequestStatus

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

Initiated

1

Initiated

Canceled

2

Canceled

Expired

3

Expired

Complete

4

Complete

Response Formats

{
  "AccountId": 123,
  "ContactId": 123,
  "ClaimNumber": "C12345",
  "EpayEmailAddress": "test@oneincsystems.com",
  "EpayRequestStatus": 4,
  "EpayRequestDate": "2019-02-19T15:32:08.9542798",
  "BankAccountSummary": {
    "Token": "ff2dd868-c14b-4647-b3f3-cf6d9abd0717",
    "AccountType": 0,
    "LastFourDigits": "1234",
    "BankName": "Test Bank",
    "NameOnAccount": "Janet Smith"
  },
  "EpayRequestType": 0,
  "EpayPhoneNumber": null,
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<GetStatusByEpayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.EpayRequest">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts"></ResponseMessage>
  <AccountId>123</AccountId>
  <BankAccountSummary xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
    <d2p1:AccountType>Checking</d2p1:AccountType>
    <d2p1:BankName>Test Bank</d2p1:BankName>
    <d2p1:LastFourDigits>1234</d2p1:LastFourDigits>
    <d2p1:NameOnAccount>Janet Smith</d2p1:NameOnAccount>
    <d2p1:Token>ff2dd868-c14b-4647-b3f3-cf6d9abd0717</d2p1:Token>
  </BankAccountSummary>
  <ClaimNumber>C12345</ClaimNumber>
  <ContactId>123</ContactId>
  <EpayEmailAddress>test@oneincsystems.com</EpayEmailAddress>
  <EpayPhoneNumber i:nil="true" />
  <EpayRequestDate>2019-02-19T15:32:08.9542798-08:00</EpayRequestDate>
  <EpayRequestStatus>Complete</EpayRequestStatus>
  <EpayRequestType>Email</EpayRequestType>
</GetStatusByEpayResponse>

POST api/EpayRequest/Cancel

This method is used to cancel an ePay request.

CancelEpayRequest

NameDescriptionTypeAdditional information
EpayRequestId

Unique identifier for the ePay request.

integer

Required

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

Request Formats

 
{
  "EpayRequestId": 12,
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<CancelEpayRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.EpayRequest">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <EpayRequestId>12</EpayRequestId>
</CancelEpayRequest>

Response Information

CancelEpayResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<CancelEpayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.EpayRequest">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts"></ResponseMessage>
</CancelEpayResponse>

POST api/EpayRequest/Resend

This method is used to resend an ePay request.

ResendEpayRequest

NameDescriptionTypeAdditional information
EpayRequestId

Unique identifier for the ePay request.

integer

Required

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

Request Formats

 
{
  "EpayRequestId": 0,
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<ResendEpayRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.EpayRequest">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <EpayRequestId>0</EpayRequestId>
</ResendEpayRequest>

Response Information

ResendEpayResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<ResendEpayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.EpayRequest">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts"></ResponseMessage>
</ResendEpayResponse>

POST api/EpayRequest/BatchImport

This method is used to import a batch of accounts with sending ePay request to each of them

BatchAccountImportRequest

NameDescriptionTypeAdditional information
Accounts

List of new accounts to add

Collection of ClaimsPayAccount

Required

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

ListOfClaimsPayAccount

NameDescriptionTypeAdditional information
CompanyDetails

Details on the company and contact for which the ClaimsPay Account will be created. See CompanyDetails object.

CompanyDetails

None.

IndividualDetails

Details on the individual for which the ClaimsPay Account will be created.

IndividualDetails

None.

ClaimNumber

Optional field for a claim number that will be associated to the operation.

string

None.

ExternalAccountId

External account identifier

string

None.

Request Formats

 
{
  "Accounts": [
    {
      "CompanyDetails": {
        "CompanyName": "sample string 1",
        "TaxId": "sample string 2",
        "Address": "sample string 3",
        "City": "sample string 4",
        "State": "sample string 5",
        "Zip": "sample string 6",
        "ContactDetails": {
          "ContactId": 1,
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Email": "sample string 3",
          "PhoneNumber": "sample string 4",
          "WebAccess": 0
        }
      },
      "IndividualDetails": {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Email": "sample string 3",
        "Address": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "Zip": "sample string 7",
        "PhoneNumber": "sample string 8"
      },
      "ClaimNumber": "sample string 1",
      "ExternalAccountId": "sample string 2"
    },
    {
      "CompanyDetails": {
        "CompanyName": "sample string 1",
        "TaxId": "sample string 2",
        "Address": "sample string 3",
        "City": "sample string 4",
        "State": "sample string 5",
        "Zip": "sample string 6",
        "ContactDetails": {
          "ContactId": 1,
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Email": "sample string 3",
          "PhoneNumber": "sample string 4",
          "WebAccess": 0
        }
      },
      "IndividualDetails": {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Email": "sample string 3",
        "Address": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "Zip": "sample string 7",
        "PhoneNumber": "sample string 8"
      },
      "ClaimNumber": "sample string 1",
      "ExternalAccountId": "sample string 2"
    }
  ],
  "ClaimsPayAuthenticationKey": "sample string 1"
}
<BatchAccountImportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.EpayRequest">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 1</ClaimsPayAuthenticationKey>
  <Accounts>
    <ClaimsPayAccount>
      <ClaimNumber>sample string 1</ClaimNumber>
      <CompanyDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Account">
        <d4p1:Address>sample string 3</d4p1:Address>
        <d4p1:City>sample string 4</d4p1:City>
        <d4p1:CompanyName>sample string 1</d4p1:CompanyName>
        <d4p1:ContactDetails>
          <d4p1:ContactId>1</d4p1:ContactId>
          <d4p1:Email>sample string 3</d4p1:Email>
          <d4p1:FirstName>sample string 1</d4p1:FirstName>
          <d4p1:LastName>sample string 2</d4p1:LastName>
          <d4p1:PhoneNumber>sample string 4</d4p1:PhoneNumber>
          <d4p1:WebAccess>Enabled</d4p1:WebAccess>
        </d4p1:ContactDetails>
        <d4p1:State>sample string 5</d4p1:State>
        <d4p1:TaxId>sample string 2</d4p1:TaxId>
        <d4p1:Zip>sample string 6</d4p1:Zip>
      </CompanyDetails>
      <ExternalAccountId>sample string 2</ExternalAccountId>
      <IndividualDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Account">
        <d4p1:Address>sample string 4</d4p1:Address>
        <d4p1:City>sample string 5</d4p1:City>
        <d4p1:Email>sample string 3</d4p1:Email>
        <d4p1:FirstName>sample string 1</d4p1:FirstName>
        <d4p1:LastName>sample string 2</d4p1:LastName>
        <d4p1:PhoneNumber>sample string 8</d4p1:PhoneNumber>
        <d4p1:State>sample string 6</d4p1:State>
        <d4p1:Zip>sample string 7</d4p1:Zip>
      </IndividualDetails>
    </ClaimsPayAccount>
    <ClaimsPayAccount>
      <ClaimNumber>sample string 1</ClaimNumber>
      <CompanyDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Account">
        <d4p1:Address>sample string 3</d4p1:Address>
        <d4p1:City>sample string 4</d4p1:City>
        <d4p1:CompanyName>sample string 1</d4p1:CompanyName>
        <d4p1:ContactDetails>
          <d4p1:ContactId>1</d4p1:ContactId>
          <d4p1:Email>sample string 3</d4p1:Email>
          <d4p1:FirstName>sample string 1</d4p1:FirstName>
          <d4p1:LastName>sample string 2</d4p1:LastName>
          <d4p1:PhoneNumber>sample string 4</d4p1:PhoneNumber>
          <d4p1:WebAccess>Enabled</d4p1:WebAccess>
        </d4p1:ContactDetails>
        <d4p1:State>sample string 5</d4p1:State>
        <d4p1:TaxId>sample string 2</d4p1:TaxId>
        <d4p1:Zip>sample string 6</d4p1:Zip>
      </CompanyDetails>
      <ExternalAccountId>sample string 2</ExternalAccountId>
      <IndividualDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Account">
        <d4p1:Address>sample string 4</d4p1:Address>
        <d4p1:City>sample string 5</d4p1:City>
        <d4p1:Email>sample string 3</d4p1:Email>
        <d4p1:FirstName>sample string 1</d4p1:FirstName>
        <d4p1:LastName>sample string 2</d4p1:LastName>
        <d4p1:PhoneNumber>sample string 8</d4p1:PhoneNumber>
        <d4p1:State>sample string 6</d4p1:State>
        <d4p1:Zip>sample string 7</d4p1:Zip>
      </IndividualDetails>
    </ClaimsPayAccount>
  </Accounts>
</BatchAccountImportRequest>

Response Information

BatchAccountImportResponse

NameDescriptionTypeAdditional information
BatchAccountProcessingResponses

List of each account creation responses

Collection of ClaimsPayAccountResponse

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

ListOfClaimsPayAccountResponse

NameDescriptionTypeAdditional information
ExternalAccountId

External account identifier

string

None.

AccountId

Account identifier

integer

None.

ContactId

Contact identifier

integer

None.

EpayRequestId

Epay identifier

integer

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "BatchAccountProcessingResponses": [
    {
      "ExternalAccountId": "sample string 1",
      "AccountId": 2,
      "ContactId": 3,
      "EpayRequestId": 4,
      "ResponseCode": "sample string 5",
      "ResponseMessage": "sample string 6"
    },
    {
      "ExternalAccountId": "sample string 1",
      "AccountId": 2,
      "ContactId": 3,
      "EpayRequestId": 4,
      "ResponseCode": "sample string 5",
      "ResponseMessage": "sample string 6"
    }
  ],
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<BatchAccountImportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.EpayRequest">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 1</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 2</ResponseMessage>
  <BatchAccountProcessingResponses>
    <ClaimsPayAccountResponse>
      <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 5</ResponseCode>
      <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 6</ResponseMessage>
      <AccountId>2</AccountId>
      <ContactId>3</ContactId>
      <EpayRequestId>4</EpayRequestId>
      <ExternalAccountId>sample string 1</ExternalAccountId>
    </ClaimsPayAccountResponse>
    <ClaimsPayAccountResponse>
      <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 5</ResponseCode>
      <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 6</ResponseMessage>
      <AccountId>2</AccountId>
      <ContactId>3</ContactId>
      <EpayRequestId>4</EpayRequestId>
      <ExternalAccountId>sample string 1</ExternalAccountId>
    </ClaimsPayAccountResponse>
  </BatchAccountProcessingResponses>
</BatchAccountImportResponse>

PaymentMethod

POST api/PaymentMethod/Remove

This method is used to remove a saved payment method that is associated to a ClaimsPay AccountID.

RemovePaymentMethodRequest

NameDescriptionTypeAdditional information
Token

Saved bank account token.

string

Required

AccountId

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

integer

Required

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

Request Formats

 
{
  "Token": "5b64c5d5-41c8-46ca-bf2e-a81e0f05f241",
  "AccountId": 123,
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<RemovePaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.PaymentMethod">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <AccountId>123</AccountId>
  <Token>5b64c5d5-41c8-46ca-bf2e-a81e0f05f241</Token>
</RemovePaymentMethodRequest>

Response Information

RemovePaymentMethodResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<RemovePaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.PaymentMethod">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts"></ResponseMessage>
</RemovePaymentMethodResponse>

POST api/PaymentMethod/Save

This method is used to save a payment method under an associated ClaimsPay AccountID.

SavePaymentMethodRequest

NameDescriptionTypeAdditional information
AccountId

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

integer

Required

ClaimNumber

Optional field for a claim number that will be associated to the operation.

string

None.

BankAccountDetails

Bank Account details.

BankAccountDetails

Required

BypassBankAccountValidation

Bypasses bank account validation.

boolean

None.

SourceUser

Identifier/name of user in the source system for reporting purposes.

string

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

Request Formats

 
{
  "AccountId": 123,
  "ClaimNumber": "C12345",
  "BankAccountDetails": {
    "RoutingNumber": "021000021",
    "AccountNumber": "123456789",
    "CustomerName": "Janet Smith",
    "AccountType": 0
  },
  "BypassBankAccountValidation": true,
  "SourceUser": "Janet Smith",
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<SavePaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.PaymentMethod">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <AccountId>123</AccountId>
  <BankAccountDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
    <d2p1:AccountNumber>123456789</d2p1:AccountNumber>
    <d2p1:AccountType>Checking</d2p1:AccountType>
    <d2p1:CustomerName>Janet Smith</d2p1:CustomerName>
    <d2p1:RoutingNumber>021000021</d2p1:RoutingNumber>
  </BankAccountDetails>
  <BypassBankAccountValidation>true</BypassBankAccountValidation>
  <ClaimNumber>C12345</ClaimNumber>
  <SourceUser>Janet Smith</SourceUser>
</SavePaymentMethodRequest>

Response Information

SavePaymentMethodResponse

NameDescriptionTypeAdditional information
TimeZone

Transaction time zone.

string

None.

TokenCreationTime

Token creation date and time in merchant time zone.

date

None.

BankAccountSummary

Bank account summary information.

BankAccountSummary

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "TimeZone": "Pacific",
  "TokenCreationTime": "2019-02-19T15:32:09.2667883",
  "BankAccountSummary": {
    "Token": "43e9710a-ca0b-43c9-a9ad-51d58ee17526",
    "AccountType": 0,
    "LastFourDigits": "1234",
    "BankName": "Test Bank",
    "NameOnAccount": "Janet Smith"
  },
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<SavePaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.PaymentMethod">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts"></ResponseMessage>
  <BankAccountSummary xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
    <d2p1:AccountType>Checking</d2p1:AccountType>
    <d2p1:BankName>Test Bank</d2p1:BankName>
    <d2p1:LastFourDigits>1234</d2p1:LastFourDigits>
    <d2p1:NameOnAccount>Janet Smith</d2p1:NameOnAccount>
    <d2p1:Token>43e9710a-ca0b-43c9-a9ad-51d58ee17526</d2p1:Token>
  </BankAccountSummary>
  <TimeZone>Pacific</TimeZone>
  <TokenCreationTime>2019-02-19T15:32:09.2667883-08:00</TokenCreationTime>
</SavePaymentMethodResponse>

POST api/PaymentMethod/GetInfo

This method is used to get information on the payment methods that are associated to a ClaimsPay AccountID.

GetPaymentMethodInfoRequest

NameDescriptionTypeAdditional information
AccountId

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

integer

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

Required

Request Formats

 
{
  "AccountId": 123,
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<GetPaymentMethodInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.PaymentMethod">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <AccountId>123</AccountId>
</GetPaymentMethodInfoRequest>

Response Information

GetPaymentMethodInfoResponse

NameDescriptionTypeAdditional information
BankAccounts

Array of bank accounts that are associated to the AccountId. The array will return a object (token and supporting information that can be used to process an EFT Credit payments) for each bank account.

Collection of BankAccountSummary

None.

IsPrepaidCardAccount

Bool which will indicate if a prepaid card account exists for the AccountId.

boolean

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "BankAccounts": [
    {
      "Token": "6bf263d3-9b1c-4c85-8553-8ed3b03748b7",
      "AccountType": 0,
      "LastFourDigits": "1234",
      "BankName": "Test Bank",
      "NameOnAccount": "Janet Smith"
    }
  ],
  "IsPrepaidCardAccount": false,
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<GetPaymentMethodInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.PaymentMethod">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts"></ResponseMessage>
  <BankAccounts xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
    <d2p1:BankAccountSummary>
      <d2p1:AccountType>Checking</d2p1:AccountType>
      <d2p1:BankName>Test Bank</d2p1:BankName>
      <d2p1:LastFourDigits>1234</d2p1:LastFourDigits>
      <d2p1:NameOnAccount>Janet Smith</d2p1:NameOnAccount>
      <d2p1:Token>6bf263d3-9b1c-4c85-8553-8ed3b03748b7</d2p1:Token>
    </d2p1:BankAccountSummary>
  </BankAccounts>
  <IsPrepaidCardAccount>false</IsPrepaidCardAccount>
</GetPaymentMethodInfoResponse>

Test Data

You can use the following EFT data for testing purposes.

Account Number Routing Number Account Type
123456789 121042882 Checking

Use the following bank account number and amount combination to simulate different API response codes.

Test Data for Credit and Debit transaction types.
Account Number Amount Response Code Description
1234567890 $0.00 Success Test: Successfully saved
1234567890 $1.00 Success Test: Transaction approved
1234567890 $2.00 ACHTransactionFailed Test: Not able to process bank account payment
1234567890 $3.00 GatewayInternalError Test: System is down
1234567890 $4.00 NoProcessorResponse Test: No response from Processor
Test Data for Void and Refund transaction types. You can only void or refund an already existing transaction.
Account Number Amount Response Code Description
1234567890 $11.00 ACHTransactionFailed Test: Not able to process bank account payment
1234567890 $12.00 GatewayInternalError Test: System is down
1234567890 $13.00 NoProcessorResponse No response from Processor

You can use the following EFT data to simulate Bank Account Validation response codes.

For testing, any valid routing number shall be used. The results will depend on bank account number.
Account Number Response Code Description
1234567890 Success Test: Charge approved
2234567890 InvalidAccountNumber Test: Invalid Account Number
3234567890 InvalidRoutingNumber Test: Invalid Routing Number
4234567890 GatewayInternalError Test: System is down

Response Code Definitions

Response Code Description
Success Indicates a successful transaction.
InvalidAuthenticationKey Invalid Authentication Key. This key will be assigned to you by One Inc.
MerchantDisabled Your Merchant account is disabled.
IncorrectTransactionId Indicates that the transactionID that you are sending for a refund or void is not a valid transaction or cannot be found.
GatewayInternalError This generic error can happen for different reasons. The error description will contain more detailed information as to the core of the problem.
InvalidRoutingNumber You have sent in an invalid Routing Number.
InvalidAccountNumber You have sent in an invalid Account Number.
BlockedBankAccount This bank account has been blocked due to past failed payments.
InvalidEFTAmount Amount must be greater than $0.
EFTCustomerNameMissing When processing an EFT, you must supply the customer name or you will receive this error.
ACHTransactionFailed Returned when an error returns for processing EFTDebit transactions.
BatchHasBeenClosed This error message is returned when you attempt to void a transaction when the batch has already been closed.
UnableToRefundTransaction Transaction has already been refunded.
NoProcessorResponse An attempt to authorize a card through the card network has timed out. You should try again.
OperationNotSupportedByMerchant This error may occur when trying to execute operation which is currently disabled for merchant.