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.

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

None.

CompanyDetails

NameDescriptionTypeAdditional information
CompanyName

The name of the company entity.

string

None.

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

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 to whom the payment method will be associated.

ContactDetails

None.

CompanyType

Type of company: business or vendor

CompanyType

None.

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

None.

LastName

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

string

None.

Email

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

string

None.

PhoneNumber

The phone number for the company contact.

string

None.

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

CompanyType

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

Business

1

Business

Vendor

2

Vendor

IndividualDetails

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.

Email

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

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.

PhoneNumber

The Payee's phone number.

string

None.

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": "Enabled"
    },
    "CompanyType": "Undefined"
  },
  "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>
    <CompanyType>Undefined</CompanyType>
    <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

ClaimsPay Account Identifier

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

ClaimsPay Account Identifier

integer

None.

FirstName

The first name of the company contact.

string

None.

LastName

The last name of the company contact.

string

None.

Email

The email address for the company contact.

string

None.

Phone

The phone number for the company contact.

string

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

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

ClaimsPay Account Identifier

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

ClaimsPay Account Identifier

integer

None.

IndividualProfileDetails

Individual profile information.

IndividualProfileDetails

None.

CompanyProfileDetails

Company and contact profile information.

CompanyProfileDetails

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

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": "Enabled"
    }
  },
  "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.

IndividualProfileDetails

None.

CompanyProfileDetails

Company and contact profile information.

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": "Enabled"
    }
  },
  "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

ClaimsPay Account Identifier

integer

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

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

Stored information for the Individual ClaimsPay AccountID.

IndividualDetails

None.

CompanyInformation

Stored information for the Company ClaimsPay AccountID. The object will return an array of contactId's for the company.

CompanyInformation

None.

BankAccounts

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

Collection of BankAccountSummary

None.

HasPrepaidCardAccount

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.

CompanyInformation

NameDescriptionTypeAdditional information
CompanyName

The name of the company entity

string

None.

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

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.

CompanyType

The company type

CompanyType

None.

ContactsDetails

Array of ContactDetails associated to the company.

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 on 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",
    "CompanyType": "Undefined",
    "ContactsDetails": [
      {
        "ContactId": 1,
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Email": "sample string 3",
        "PhoneNumber": "sample string 4",
        "WebAccess": "Enabled"
      },
      {
        "ContactId": 1,
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Email": "sample string 3",
        "PhoneNumber": "sample string 4",
        "WebAccess": "Enabled"
      }
    ]
  },
  "BankAccounts": [
    {
      "Token": "sample string 1",
      "AccountType": "Checking",
      "LastFourDigits": "sample string 2",
      "BankName": "sample string 3",
      "NameOnAccount": "sample string 4"
    },
    {
      "Token": "sample string 1",
      "AccountType": "Checking",
      "LastFourDigits": "sample string 2",
      "BankName": "sample string 3",
      "NameOnAccount": "sample string 4"
    }
  ],
  "HasPrepaidCardAccount": 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>
    <CompanyType>Undefined</CompanyType>
    <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>
  <HasPrepaidCardAccount>true</HasPrepaidCardAccount>
  <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>
</GetAccountInfoResponse>

BankAccount

BankAccount operations

POST api/BankAccount/Credit

This method is used to submit BankAccount payment.

CreditBankAccountRequest

NameDescriptionTypeAdditional information
AccountId

ClaimsPay Account Identifier

integer

None.

ContactId

Company Contact identifier. Only applicable to company accounts. If sent, will be used to identify the recipient of the payment complete email.

integer

None.

Amount

Amount of payment.

decimal number

None.

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

None.

ClaimDetails

Claim details which will be sent in the payment email

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

None.

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,
  "ContactId": null,
  "Amount": 120.0,
  "Token": null,
  "AccountGroupCode": "Default",
  "BankAccountDetails": {
    "RoutingNumber": "021000021",
    "AccountNumber": "123456789",
    "CustomerName": "Janet Smith",
    "AccountType": "Checking"
  },
  "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>
  <ContactId i:nil="true" />
  <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-10-21T13:28:05.1595198",
  "TimeZone": "Pacific",
  "BatchNumber": 5,
  "BankAccountSummary": {
    "Token": null,
    "AccountType": "Checking",
    "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-10-21T13:28:05.1595198-07: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

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

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
BatchNumber

Number of the batch.

integer

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "BatchNumber": 0,
  "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>
  <BatchNumber>0</BatchNumber>
</VoidCreditResponse>

POST api/BankAccount/Verify

This method is used to verify BankAccount.

VerifyBankAccountRequest

NameDescriptionTypeAdditional information
AccountId

ClaimsPay Account Identifier

integer

None.

BankAccountDetails

Bank Account details.

BankAccountDetails

None.

Token

Previously saved Payment Token

string

None.

SourceUser

User identifier/name for reporting purposes

string

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

Request Formats

 
{
  "AccountId": 1,
  "BankAccountDetails": {
    "RoutingNumber": "sample string 1",
    "AccountNumber": "sample string 2",
    "CustomerName": "sample string 3",
    "AccountType": "Checking"
  },
  "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

Additional response data

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>

ApprovalRequest

POST api/ApprovalRequest/Create

This method is used to create new approval request. The approval request will send a communication to each of the approval request parties and direct them to a portal where they will complete their approval request actions per their role.

CreateApprovalRequestRequest

NameDescriptionTypeAdditional information
ClaimNumber

Claim number for which the approval process will be completed.

string

None.

TotalAmount

The total payment amount that will be paid out as part of the current approval request.

decimal number

None.

ProcessType

Specifies the process that the system will follow for the approval request. Allowable values: 1.MultiPartyPayment. System will create an approval request involving multiple parties. Once all claim parties have completed the required actions based upon the role, a payment will be processed. 2.SinglePartyPayment. System will create an approval request for a single party. Once the party completes the required action, the system will process a payment. 3.SinglePartySave. System will create an approval request for a single party to capture a payment method option.

string

None.

ClaimDetails

Claim detail information that will be displayed as sent to the claim party in the website and emails.

Collection of String

None.

AccountGroupCode

This field is used to route money from different accounts based on a predefined groups. If payments are processed with the approval request, the system will use the provided AccountGroupCode.

string

None.

ApprovalRequestParties

Array of ApprovalRequestParty objects for each of the parties that have an interest in the claim. The approval request can have 2-10 parties. At least one party must be a payment recipient. Each party must have a unique AccountId.

Collection of ApprovalRequestParty

None.

ExtendedParameters

The collection of key value pairs for optional parameters.

Dictionary of string and string
ApprovalRequestExtendedParameters

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

String

ApprovalRequestParty

NameDescriptionTypeAdditional information
AccountId

ClaimsPay Account Identifier.

integer

None.

ContactId

Company Contact identifier. Only applicable to company accounts.

integer

None.

ApprovalRole

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

ApprovalRequestPartyRole

None.

LinkDeliveryType

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

MessageDeliveryType

None.

PhoneNumber

Property to support future functionality.

string

None.

EmailAddress

The email address for the party to which the Multi-Payee Approval emails will be sent. If DeliveryType is Email and it is not populated, the email will be sent to the email address stored for the AccountId or ContactId.

string

None.

PaymentAmount

The amount of the payment that the approval party will receive. If role is ApprovalOnly, send 0.00.

decimal number

None.

DisplayOtherPartiesInfo

Information to be displayed to the current party about the other approval request parties that are part of the request.

Collection of DisplayOtherPartyInfo

None.

PaymentMethodType

The type of payment method that will be used to process the payment for an approval party with the role of PaymentOnlyActionBypass.

PaymentMethodType

None.

Token

Token for the bank account that will receive the payment for an approval party with the role of PaymentOnlyActionBypass if PaymentMethodType is ECheck.

string

None.

Address

Address to which a check will be sent if the claim party selects the payment method of check. If the object is not sent and the portal settings allow for check as a payment option, the system will display the address stored for the AccountId or ContactId. Note: the stored primary address will not be updated.

MailingAddress

None.

ExtendedParameters

The collection of key value pairs for optional parameters.

Dictionary of string and string
ApprovalRequestPartyExtendedParameters

None.

ApprovalRequestPartyRole

Possible enumeration values:

NameValueDescription
ApprovalOnly

1

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

PaymentOnly

2

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

ApprovalAndPayment

3

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

PaymentOnlyActionBypass

4

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

MessageDeliveryType

Possible enumeration values:

NameValueDescription
Email

1

The Approval Process link will be sent via email.

DisplayOtherPartyInfo

NameDescriptionTypeAdditional information
Name

Name that will be displayed to the user in the approval portal Claim Information.

string

None.

Role

Role that will be displayed to the user in the approval portal Claim Information.

ApprovalRequestPartyRole

None.

Amount

Payment Amount that will be displayed to the user in the approval portal Claim Information.

decimal number

None.

PaymentMethodType

Possible enumeration values:

NameValueDescription
BankAccount

1

Bank account payment method.

Check

2

Mail check payment method. Note: to be fulfilled by carrier.

VirtualCard

3

Virtual card payment method.

MailingAddress

NameDescriptionTypeAdditional information
Address

The street address.

string

None.

City

The city.

string

None.

State

The state.

string

None.

Zip

The zip code.

string

None.

ApprovalRequestPartyExtendedParameters

Key Description
VendorServiceDate The date that the vendor provided services to the claimant. (Applicable to Vendor Payments)
VendorRefNumber The vendor internal number for the payment request, i.e. invoice, work order number, PO number. Up to 15 characters. (Applicable to Vendor Payments)

ApprovalRequestExtendedParameters

Key Description
ClaimantName Name of the claimant for whom the vendor is getting a payment. Up to 50 characters. (Applicable to Vendor Payments)

Request Formats

 
{
  "ClaimNumber": "C12345",
  "TotalAmount": 211.0,
  "ProcessType": "MultiPartyPayment",
  "ClaimDetails": [
    "Claim detail 1",
    "Claim detail 2"
  ],
  "AccountGroupCode": "Default",
  "ApprovalRequestParties": [
    {
      "AccountId": 123,
      "ContactId": 123,
      "ApprovalRole": "PaymentOnlyActionBypass",
      "LinkDeliveryType": "Email",
      "PhoneNumber": "1234567890",
      "EmailAddress": "test@oneincsystems.com",
      "PaymentAmount": 23.0,
      "DisplayOtherPartiesInfo": [
        {
          "Name": "James Smith",
          "Role": "PaymentOnly",
          "Amount": 3.0
        },
        {
          "Name": "Michael Brown",
          "Role": "ApprovalOnly",
          "Amount": null
        }
      ],
      "PaymentMethodType": "Check",
      "Token": null,
      "Address": {
        "Address": "123 Main St.",
        "City": "Folsom",
        "State": "CA",
        "Zip": "95630"
      },
      "ExtendedParameters": {
        "SomeKey1": "SomeValue1",
        "SomeKey2": "SomeValue2"
      }
    },
    {
      "AccountId": 456,
      "ContactId": null,
      "ApprovalRole": "ApprovalOnly",
      "LinkDeliveryType": "Email",
      "PhoneNumber": null,
      "EmailAddress": "test@oneincsystems.com",
      "PaymentAmount": 0.0,
      "DisplayOtherPartiesInfo": [
        {
          "Name": "James Smith",
          "Role": "PaymentOnly",
          "Amount": 3.0
        },
        {
          "Name": "Michael Brown",
          "Role": "ApprovalOnly",
          "Amount": null
        }
      ],
      "PaymentMethodType": null,
      "Token": null,
      "Address": null,
      "ExtendedParameters": null
    },
    {
      "AccountId": 789,
      "ContactId": null,
      "ApprovalRole": "PaymentOnly",
      "LinkDeliveryType": "Email",
      "PhoneNumber": "1234567890",
      "EmailAddress": "test@oneincsystems.com",
      "PaymentAmount": 38.0,
      "DisplayOtherPartiesInfo": null,
      "PaymentMethodType": null,
      "Token": null,
      "Address": null,
      "ExtendedParameters": null
    },
    {
      "AccountId": 987,
      "ContactId": null,
      "ApprovalRole": "ApprovalAndPayment",
      "LinkDeliveryType": "Email",
      "PhoneNumber": null,
      "EmailAddress": "test@oneincsystems.com",
      "PaymentAmount": 150.0,
      "DisplayOtherPartiesInfo": [
        {
          "Name": "James Smith",
          "Role": "PaymentOnly",
          "Amount": 3.0
        },
        {
          "Name": "Michael Brown",
          "Role": "ApprovalOnly",
          "Amount": null
        }
      ],
      "PaymentMethodType": null,
      "Token": null,
      "Address": null,
      "ExtendedParameters": null
    }
  ],
  "ExtendedParameters": {
    "SomeKey1": "SomeValue1",
    "SomeKey2": "SomeValue2"
  },
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<CreateApprovalRequestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.ApprovalRequest">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <AccountGroupCode>Default</AccountGroupCode>
  <ApprovalRequestParties>
    <ApprovalRequestParty>
      <AccountId>123</AccountId>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
        <d4p1:Address>123 Main St.</d4p1:Address>
        <d4p1:City>Folsom</d4p1:City>
        <d4p1:State>CA</d4p1:State>
        <d4p1:Zip>95630</d4p1:Zip>
      </Address>
      <ApprovalRole>PaymentOnlyActionBypass</ApprovalRole>
      <ContactId>123</ContactId>
      <DisplayOtherPartiesInfo>
        <DisplayOtherPartyInfo>
          <Amount>3</Amount>
          <Name>James Smith</Name>
          <Role>PaymentOnly</Role>
        </DisplayOtherPartyInfo>
        <DisplayOtherPartyInfo>
          <Amount i:nil="true" />
          <Name>Michael Brown</Name>
          <Role>ApprovalOnly</Role>
        </DisplayOtherPartyInfo>
      </DisplayOtherPartiesInfo>
      <EmailAddress>test@oneincsystems.com</EmailAddress>
      <ExtendedParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>SomeKey1</d4p1:Key>
          <d4p1:Value>SomeValue1</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>SomeKey2</d4p1:Key>
          <d4p1:Value>SomeValue2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </ExtendedParameters>
      <LinkDeliveryType>Email</LinkDeliveryType>
      <PaymentAmount>23</PaymentAmount>
      <PaymentMethodType>Check</PaymentMethodType>
      <PhoneNumber>1234567890</PhoneNumber>
      <Token i:nil="true" />
    </ApprovalRequestParty>
    <ApprovalRequestParty>
      <AccountId>456</AccountId>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts" i:nil="true" />
      <ApprovalRole>ApprovalOnly</ApprovalRole>
      <ContactId i:nil="true" />
      <DisplayOtherPartiesInfo>
        <DisplayOtherPartyInfo>
          <Amount>3</Amount>
          <Name>James Smith</Name>
          <Role>PaymentOnly</Role>
        </DisplayOtherPartyInfo>
        <DisplayOtherPartyInfo>
          <Amount i:nil="true" />
          <Name>Michael Brown</Name>
          <Role>ApprovalOnly</Role>
        </DisplayOtherPartyInfo>
      </DisplayOtherPartiesInfo>
      <EmailAddress>test@oneincsystems.com</EmailAddress>
      <ExtendedParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <LinkDeliveryType>Email</LinkDeliveryType>
      <PaymentAmount>0</PaymentAmount>
      <PaymentMethodType i:nil="true" />
      <PhoneNumber i:nil="true" />
      <Token i:nil="true" />
    </ApprovalRequestParty>
    <ApprovalRequestParty>
      <AccountId>789</AccountId>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts" i:nil="true" />
      <ApprovalRole>PaymentOnly</ApprovalRole>
      <ContactId i:nil="true" />
      <DisplayOtherPartiesInfo i:nil="true" />
      <EmailAddress>test@oneincsystems.com</EmailAddress>
      <ExtendedParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <LinkDeliveryType>Email</LinkDeliveryType>
      <PaymentAmount>38</PaymentAmount>
      <PaymentMethodType i:nil="true" />
      <PhoneNumber>1234567890</PhoneNumber>
      <Token i:nil="true" />
    </ApprovalRequestParty>
    <ApprovalRequestParty>
      <AccountId>987</AccountId>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts" i:nil="true" />
      <ApprovalRole>ApprovalAndPayment</ApprovalRole>
      <ContactId i:nil="true" />
      <DisplayOtherPartiesInfo>
        <DisplayOtherPartyInfo>
          <Amount>3</Amount>
          <Name>James Smith</Name>
          <Role>PaymentOnly</Role>
        </DisplayOtherPartyInfo>
        <DisplayOtherPartyInfo>
          <Amount i:nil="true" />
          <Name>Michael Brown</Name>
          <Role>ApprovalOnly</Role>
        </DisplayOtherPartyInfo>
      </DisplayOtherPartiesInfo>
      <EmailAddress>test@oneincsystems.com</EmailAddress>
      <ExtendedParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <LinkDeliveryType>Email</LinkDeliveryType>
      <PaymentAmount>150</PaymentAmount>
      <PaymentMethodType i:nil="true" />
      <PhoneNumber i:nil="true" />
      <Token i:nil="true" />
    </ApprovalRequestParty>
  </ApprovalRequestParties>
  <ClaimDetails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Claim detail 1</d2p1:string>
    <d2p1:string>Claim detail 2</d2p1:string>
  </ClaimDetails>
  <ClaimNumber>C12345</ClaimNumber>
  <ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>SomeKey1</d2p1:Key>
      <d2p1:Value>SomeValue1</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>SomeKey2</d2p1:Key>
      <d2p1:Value>SomeValue2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ExtendedParameters>
  <ProcessType>MultiPartyPayment</ProcessType>
  <TotalAmount>211</TotalAmount>
</CreateApprovalRequestRequest>

Response Information

CreateApprovalRequestResponse

NameDescriptionTypeAdditional information
ApprovalRequestId

Unique identifier for the approval request.

integer

None.

CreationDate

Date the approval request was created.

date

None.

ExpirationDate

Date the approval request will expire.

date

None.

TimeZone

Approval request time zone.

string

None.

ProcessType

The process type for the approval request.

string

None.

AccountGroupCode

The account group code of created approval request.

string

None.

Status

The status of the approval request process.

ApprovalRequestStatus

None.

ApprovalRequestParties

The array of the claim party information object which includes identifying information on each claim party.

Collection of ApprovalRequestPartySummary

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

ApprovalRequestStatus

Possible enumeration values:

NameValueDescription
Initiated

1

The approval process has been initiated.

Completed

2

The approval process has been completed (all approval parties completed their actions and if ProcessPayment = true, payments were processed).

Rejected

3

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

Cancelled

4

The approval request has been canceled.

Expired

5

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

ApprovalRequestPartySummary

NameDescriptionTypeAdditional information
ApprovalRequestPartyId

ClaimsPay Approval Request Party Identifier.

integer

None.

AccountId

ClaimsPay Account Identifier.

integer

None.

ContactId

Company Contact identifier. Only applicable to company accounts.

integer

None.

EmailAddress

The email address to which the approval email was sent.

string

None.

PhoneNumber

Property to support future functionality.

string

None.

Status

Status of the approval action for the claim party.

ApprovalRequestPartyStatus

None.

ApprovalRequestPartyStatus

Possible enumeration values:

NameValueDescription
Initiated

1

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

FailedWelcomeCommunication

2

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

WebsiteAccessBlocked

3

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

Rejected

4

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

WaitingForOtherParties

5

The claim party completed the actions required for their role.

Completed

6

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

Response Formats

{
  "ApprovalRequestId": 12,
  "CreationDate": "2019-10-21T05:02:05.3113516",
  "ExpirationDate": "2019-10-22T17:02:05.3113516",
  "TimeZone": "Pacific",
  "ProcessType": "MultiPartyPayment",
  "AccountGroupCode": null,
  "Status": "Initiated",
  "ApprovalRequestParties": [
    {
      "ApprovalRequestPartyId": 1,
      "AccountId": 123,
      "ContactId": 12,
      "EmailAddress": "test@oneincsystems.com",
      "PhoneNumber": "1234567890",
      "Status": "Initiated"
    },
    {
      "ApprovalRequestPartyId": 2,
      "AccountId": 456,
      "ContactId": 34,
      "EmailAddress": "test@oneincsystems.com",
      "PhoneNumber": "1234567890",
      "Status": "Initiated"
    },
    {
      "ApprovalRequestPartyId": 3,
      "AccountId": 789,
      "ContactId": 56,
      "EmailAddress": "test@oneincsystems.com",
      "PhoneNumber": "1234567890",
      "Status": "Initiated"
    },
    {
      "ApprovalRequestPartyId": 4,
      "AccountId": 987,
      "ContactId": 78,
      "EmailAddress": "test@oneincsystems.com",
      "PhoneNumber": "1234567890",
      "Status": "Initiated"
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<CreateApprovalRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.ApprovalRequest">
  <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>
  <AccountGroupCode i:nil="true" />
  <ApprovalRequestId>12</ApprovalRequestId>
  <ApprovalRequestParties>
    <ApprovalRequestPartySummary>
      <AccountId>123</AccountId>
      <ApprovalRequestPartyId>1</ApprovalRequestPartyId>
      <ContactId>12</ContactId>
      <EmailAddress>test@oneincsystems.com</EmailAddress>
      <PhoneNumber>1234567890</PhoneNumber>
      <Status>Initiated</Status>
    </ApprovalRequestPartySummary>
    <ApprovalRequestPartySummary>
      <AccountId>456</AccountId>
      <ApprovalRequestPartyId>2</ApprovalRequestPartyId>
      <ContactId>34</ContactId>
      <EmailAddress>test@oneincsystems.com</EmailAddress>
      <PhoneNumber>1234567890</PhoneNumber>
      <Status>Initiated</Status>
    </ApprovalRequestPartySummary>
    <ApprovalRequestPartySummary>
      <AccountId>789</AccountId>
      <ApprovalRequestPartyId>3</ApprovalRequestPartyId>
      <ContactId>56</ContactId>
      <EmailAddress>test@oneincsystems.com</EmailAddress>
      <PhoneNumber>1234567890</PhoneNumber>
      <Status>Initiated</Status>
    </ApprovalRequestPartySummary>
    <ApprovalRequestPartySummary>
      <AccountId>987</AccountId>
      <ApprovalRequestPartyId>4</ApprovalRequestPartyId>
      <ContactId>78</ContactId>
      <EmailAddress>test@oneincsystems.com</EmailAddress>
      <PhoneNumber>1234567890</PhoneNumber>
      <Status>Initiated</Status>
    </ApprovalRequestPartySummary>
  </ApprovalRequestParties>
  <CreationDate>2019-10-21T05:02:05.3113516-07:00</CreationDate>
  <ExpirationDate>2019-10-22T17:02:05.3113516-07:00</ExpirationDate>
  <ProcessType>MultiPartyPayment</ProcessType>
  <Status>Initiated</Status>
  <TimeZone>Pacific</TimeZone>
</CreateApprovalRequestResponse>

POST api/ApprovalRequest/GetById

This method is used to get approval request by id.

GetApprovalRequestByIdRequest

NameDescriptionTypeAdditional information
ApprovalRequestId

Unique identifier for the Approval request.

integer

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

Request Formats

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

Response Information

GetApprovalRequestByIdResponse

NameDescriptionTypeAdditional information
ApprovalRequestId

Unique identifier for the approval request.

integer

None.

ClaimNumber

Claim number associated to the approval request.

string

None.

Status

The status of the approval request.

ApprovalRequestStatus

None.

CreationDate

Date the approval request was initiated.

date

None.

ExpirationDate

The expiration date of the approval request.

date

None.

TimeZone

Approval request time zone.

string

None.

ProcessType

The process type for the approval request.

string

None.

AccountGroupCode

The account group code of the approval request.

string

None.

ApprovalRequestPartiesInfo

Information on each of the approval request party.

Collection of ApprovalRequestPartyInfo

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

ApprovalRequestPartyInfo

NameDescriptionTypeAdditional information
ApprovalRequestPartyId

Claims pay approval request party identifier.

integer

None.

AccountId

Claims pay account identifier.

integer

None.

ContactId

Company contact identifier. Only applicable to company accounts.

integer

None.

EmailAddress

The email address to which the approval email was sent.

string

None.

PhoneNumber

Property to support future functionality.

string

None.

FullName

First and Last name of the approval request party.

string

None.

CompanyName

Company name if the ClaimsPayAccountType is Company.

string

None.

Status

The status of the approval request party.

ApprovalRequestPartyStatus

None.

DisputeComment

Applicable to ApprovalRequestPartyStatus is Rejected. The optional text entered by the approval request party when they disputed the claim payment.

string

None.

PaymentSummary

Payment method information and if payment has been processed, payment transaction information.

PaymentSummary

None.

PaymentSummary

NameDescriptionTypeAdditional information
MailingAddress

Selected mailing address for E-Check.

MailingAddress

None.

BankAccountSummary

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

BankAccountSummary

None.

PaymentMethodType

Selected payment method type.

PaymentMethodType

None.

TransactionSummary

Payment processing information.

TransactionSummary

None.

TransactionSummary

NameDescriptionTypeAdditional information
TransactionId

Transaction identifier for the payment.

string

None.

TransactionDate

The date when transaction was executed.

date

None.

BatchNumber

Number of the batch.

integer

None.

PaymentProcessingStatus

The status of the claim party payment.

PaymentProcessingStatus

None.

PaymentResponseMessage

Information from the payment transaction.

string

None.

PaymentProcessingStatus

Possible enumeration values:

NameValueDescription
Successful

1

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

Failed

2

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

Skipped

3

Applies to paymentMethodType of check only. Check is not processed by One Inc.

Response Formats

{
  "ApprovalRequestId": 12,
  "ClaimNumber": "C12345",
  "Status": "Initiated",
  "CreationDate": "2019-10-21T05:02:05.3113516",
  "ExpirationDate": "2019-10-22T17:02:05.3113516",
  "TimeZone": "Pacific",
  "ProcessType": "MultiPartyPayment",
  "AccountGroupCode": "Default",
  "ApprovalRequestPartiesInfo": [
    {
      "ApprovalRequestPartyId": 0,
      "AccountId": 123,
      "ContactId": 12,
      "EmailAddress": "test@oneincsystems.com",
      "PhoneNumber": "1234567890",
      "FullName": null,
      "CompanyName": null,
      "Status": "Completed",
      "DisputeComment": null,
      "PaymentSummary": {
        "MailingAddress": null,
        "BankAccountSummary": null,
        "PaymentMethodType": "VirtualCard",
        "TransactionSummary": {
          "TransactionId": "12345",
          "TransactionDate": "2019-10-21T13:28:05.4876441",
          "BatchNumber": 1,
          "PaymentProcessingStatus": "Successful",
          "PaymentResponseMessage": ""
        }
      }
    },
    {
      "ApprovalRequestPartyId": 0,
      "AccountId": 456,
      "ContactId": 34,
      "EmailAddress": "test@oneincsystems.com",
      "PhoneNumber": "1234567890",
      "FullName": null,
      "CompanyName": null,
      "Status": "Completed",
      "DisputeComment": null,
      "PaymentSummary": {
        "MailingAddress": null,
        "BankAccountSummary": {
          "Token": "69943eee-3f84-47ed-8e8c-6340d2d463e9",
          "AccountType": "Checking",
          "LastFourDigits": "1234",
          "BankName": "Test Bank",
          "NameOnAccount": "Janet Smith"
        },
        "PaymentMethodType": "BankAccount",
        "TransactionSummary": {
          "TransactionId": "12345",
          "TransactionDate": "2019-10-21T13:28:05.4876441",
          "BatchNumber": 1,
          "PaymentProcessingStatus": "Successful",
          "PaymentResponseMessage": ""
        }
      }
    },
    {
      "ApprovalRequestPartyId": 0,
      "AccountId": 789,
      "ContactId": 78,
      "EmailAddress": "test@oneincsystems.com",
      "PhoneNumber": "1234567890",
      "FullName": null,
      "CompanyName": null,
      "Status": "Completed",
      "DisputeComment": null,
      "PaymentSummary": {
        "MailingAddress": {
          "Address": "123 Main St.",
          "City": "Folsom",
          "State": "CA",
          "Zip": "95630"
        },
        "BankAccountSummary": null,
        "PaymentMethodType": "Check",
        "TransactionSummary": null
      }
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<GetApprovalRequestByIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.ApprovalRequest">
  <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>
  <AccountGroupCode>Default</AccountGroupCode>
  <ApprovalRequestId>12</ApprovalRequestId>
  <ApprovalRequestPartiesInfo>
    <ApprovalRequestPartyInfo>
      <AccountId>123</AccountId>
      <ApprovalRequestPartyId>0</ApprovalRequestPartyId>
      <CompanyName i:nil="true" />
      <ContactId>12</ContactId>
      <DisputeComment i:nil="true" />
      <EmailAddress>test@oneincsystems.com</EmailAddress>
      <FullName i:nil="true" />
      <PaymentSummary xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
        <d4p1:BankAccountSummary i:nil="true" />
        <d4p1:MailingAddress i:nil="true" />
        <d4p1:PaymentMethodType>VirtualCard</d4p1:PaymentMethodType>
        <d4p1:TransactionSummary>
          <d4p1:BatchNumber>1</d4p1:BatchNumber>
          <d4p1:PaymentProcessingStatus>Successful</d4p1:PaymentProcessingStatus>
          <d4p1:PaymentResponseMessage></d4p1:PaymentResponseMessage>
          <d4p1:TransactionDate>2019-10-21T13:28:05.4876441-07:00</d4p1:TransactionDate>
          <d4p1:TransactionId>12345</d4p1:TransactionId>
        </d4p1:TransactionSummary>
      </PaymentSummary>
      <PhoneNumber>1234567890</PhoneNumber>
      <Status>Completed</Status>
    </ApprovalRequestPartyInfo>
    <ApprovalRequestPartyInfo>
      <AccountId>456</AccountId>
      <ApprovalRequestPartyId>0</ApprovalRequestPartyId>
      <CompanyName i:nil="true" />
      <ContactId>34</ContactId>
      <DisputeComment i:nil="true" />
      <EmailAddress>test@oneincsystems.com</EmailAddress>
      <FullName i:nil="true" />
      <PaymentSummary xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
        <d4p1:BankAccountSummary>
          <d4p1:AccountType>Checking</d4p1:AccountType>
          <d4p1:BankName>Test Bank</d4p1:BankName>
          <d4p1:LastFourDigits>1234</d4p1:LastFourDigits>
          <d4p1:NameOnAccount>Janet Smith</d4p1:NameOnAccount>
          <d4p1:Token>69943eee-3f84-47ed-8e8c-6340d2d463e9</d4p1:Token>
        </d4p1:BankAccountSummary>
        <d4p1:MailingAddress i:nil="true" />
        <d4p1:PaymentMethodType>BankAccount</d4p1:PaymentMethodType>
        <d4p1:TransactionSummary>
          <d4p1:BatchNumber>1</d4p1:BatchNumber>
          <d4p1:PaymentProcessingStatus>Successful</d4p1:PaymentProcessingStatus>
          <d4p1:PaymentResponseMessage></d4p1:PaymentResponseMessage>
          <d4p1:TransactionDate>2019-10-21T13:28:05.4876441-07:00</d4p1:TransactionDate>
          <d4p1:TransactionId>12345</d4p1:TransactionId>
        </d4p1:TransactionSummary>
      </PaymentSummary>
      <PhoneNumber>1234567890</PhoneNumber>
      <Status>Completed</Status>
    </ApprovalRequestPartyInfo>
    <ApprovalRequestPartyInfo>
      <AccountId>789</AccountId>
      <ApprovalRequestPartyId>0</ApprovalRequestPartyId>
      <CompanyName i:nil="true" />
      <ContactId>78</ContactId>
      <DisputeComment i:nil="true" />
      <EmailAddress>test@oneincsystems.com</EmailAddress>
      <FullName i:nil="true" />
      <PaymentSummary xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
        <d4p1:BankAccountSummary i:nil="true" />
        <d4p1:MailingAddress>
          <d4p1:Address>123 Main St.</d4p1:Address>
          <d4p1:City>Folsom</d4p1:City>
          <d4p1:State>CA</d4p1:State>
          <d4p1:Zip>95630</d4p1:Zip>
        </d4p1:MailingAddress>
        <d4p1:PaymentMethodType>Check</d4p1:PaymentMethodType>
        <d4p1:TransactionSummary i:nil="true" />
      </PaymentSummary>
      <PhoneNumber>1234567890</PhoneNumber>
      <Status>Completed</Status>
    </ApprovalRequestPartyInfo>
  </ApprovalRequestPartiesInfo>
  <ClaimNumber>C12345</ClaimNumber>
  <CreationDate>2019-10-21T05:02:05.3113516-07:00</CreationDate>
  <ExpirationDate>2019-10-22T17:02:05.3113516-07:00</ExpirationDate>
  <ProcessType>MultiPartyPayment</ProcessType>
  <Status>Initiated</Status>
  <TimeZone>Pacific</TimeZone>
</GetApprovalRequestByIdResponse>

POST api/ApprovalRequest/GetByStatus

This method is used to get approval requests by status.

GetApprovalRequestsByStatusRequest

NameDescriptionTypeAdditional information
AuthenticationKeys

Authentication keys to define the search query.

Collection of String

None.

Statuses

Approval Request statuses.

Collection of ApprovalRequestStatus

None.

StartDate

Search start date. If not provided start date would be -180 days from provided end date or -180 days from the current date if end date is empty.

date

None.

EndDate

Search end date. If not provided end date would be +180 days from provided start date or the current date if start date is empty.

date

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

Request Formats

 
{
  "AuthenticationKeys": [
    "Authentication Key"
  ],
  "Statuses": [
    "Initiated",
    "Expired",
    "Cancelled"
  ],
  "StartDate": "2019-10-18T13:28:05.7063898",
  "EndDate": "2019-10-21T13:28:05.7063898",
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<GetApprovalRequestsByStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.ApprovalRequest">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <AuthenticationKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Authentication Key</d2p1:string>
  </AuthenticationKeys>
  <EndDate>2019-10-21T13:28:05.7063898-07:00</EndDate>
  <StartDate>2019-10-18T13:28:05.7063898-07:00</StartDate>
  <Statuses>
    <ApprovalRequestStatus>Initiated</ApprovalRequestStatus>
    <ApprovalRequestStatus>Expired</ApprovalRequestStatus>
    <ApprovalRequestStatus>Cancelled</ApprovalRequestStatus>
  </Statuses>
</GetApprovalRequestsByStatusRequest>

Response Information

GetApprovalRequestsByStatusResponse

NameDescriptionTypeAdditional information
ApprovalRequests

The result of get by status query.

Collection of ApprovalRequestSummary

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

ApprovalRequestSummary

NameDescriptionTypeAdditional information
ApprovalRequestId

Unique identifier for the approval request.

integer

None.

ClaimNumber

Claim number associated to the approval request.

string

None.

Status

The status of the approval request.

ApprovalRequestStatus

None.

CreationDate

Date the approval request was initiated.

date

None.

ExpirationDate

Date the approval request will expire.

date

None.

TimeZone

Approval request time zone.

string

None.

ProcessType

The process type for the approval request.

string

None.

AccountGroupCode

The account group code of the approval request.

string

None.

ApprovalRequestPartyInfos

Information about each Approval request party

Collection of ApprovalRequestPartyInfo

None.

Response Formats

{
  "ApprovalRequests": [
    {
      "ApprovalRequestId": 12,
      "ClaimNumber": "C12345",
      "Status": "Initiated",
      "CreationDate": "2019-10-21T05:02:05.3113516",
      "ExpirationDate": "2019-10-22T17:02:05.3113516",
      "TimeZone": "Pacific",
      "ProcessType": "MultiPartyPayment",
      "AccountGroupCode": "Default",
      "ApprovalRequestPartyInfos": [
        {
          "ApprovalRequestPartyId": 0,
          "AccountId": 123,
          "ContactId": 12,
          "EmailAddress": "test@oneincsystems.com",
          "PhoneNumber": "1234567890",
          "FullName": null,
          "CompanyName": null,
          "Status": "Completed",
          "DisputeComment": null,
          "PaymentSummary": {
            "MailingAddress": null,
            "BankAccountSummary": null,
            "PaymentMethodType": "VirtualCard",
            "TransactionSummary": {
              "TransactionId": "12345",
              "TransactionDate": "2019-10-21T13:28:05.7063898",
              "BatchNumber": 1,
              "PaymentProcessingStatus": "Successful",
              "PaymentResponseMessage": ""
            }
          }
        },
        {
          "ApprovalRequestPartyId": 0,
          "AccountId": 456,
          "ContactId": 34,
          "EmailAddress": "test@oneincsystems.com",
          "PhoneNumber": "1234567890",
          "FullName": null,
          "CompanyName": null,
          "Status": "Completed",
          "DisputeComment": null,
          "PaymentSummary": {
            "MailingAddress": null,
            "BankAccountSummary": {
              "Token": "57eaa401-06f4-4131-bdd6-2206f83bc1c0",
              "AccountType": "Checking",
              "LastFourDigits": "1234",
              "BankName": "Test Bank",
              "NameOnAccount": "Janet Smith"
            },
            "PaymentMethodType": "BankAccount",
            "TransactionSummary": {
              "TransactionId": "12345",
              "TransactionDate": "2019-10-21T13:28:05.7063898",
              "BatchNumber": 1,
              "PaymentProcessingStatus": "Successful",
              "PaymentResponseMessage": ""
            }
          }
        },
        {
          "ApprovalRequestPartyId": 0,
          "AccountId": 789,
          "ContactId": 78,
          "EmailAddress": "test@oneincsystems.com",
          "PhoneNumber": "1234567890",
          "FullName": null,
          "CompanyName": null,
          "Status": "Completed",
          "DisputeComment": null,
          "PaymentSummary": {
            "MailingAddress": {
              "Address": "123 Main St.",
              "City": "Folsom",
              "State": "CA",
              "Zip": "95630"
            },
            "BankAccountSummary": null,
            "PaymentMethodType": "Check",
            "TransactionSummary": null
          }
        }
      ]
    },
    {
      "ApprovalRequestId": 12,
      "ClaimNumber": "C12345",
      "Status": "Completed",
      "CreationDate": "2019-10-21T05:02:05.3113516",
      "ExpirationDate": "2019-10-22T17:02:05.3113516",
      "TimeZone": "Pacific",
      "ProcessType": "MultiPartyPayment",
      "AccountGroupCode": "Default",
      "ApprovalRequestPartyInfos": [
        {
          "ApprovalRequestPartyId": 0,
          "AccountId": 123,
          "ContactId": 12,
          "EmailAddress": "test@oneincsystems.com",
          "PhoneNumber": "1234567890",
          "FullName": null,
          "CompanyName": null,
          "Status": "Completed",
          "DisputeComment": null,
          "PaymentSummary": {
            "MailingAddress": null,
            "BankAccountSummary": null,
            "PaymentMethodType": "VirtualCard",
            "TransactionSummary": {
              "TransactionId": "12345",
              "TransactionDate": "2019-10-21T13:28:05.7063898",
              "BatchNumber": 1,
              "PaymentProcessingStatus": "Successful",
              "PaymentResponseMessage": ""
            }
          }
        },
        {
          "ApprovalRequestPartyId": 0,
          "AccountId": 456,
          "ContactId": 34,
          "EmailAddress": "test@oneincsystems.com",
          "PhoneNumber": "1234567890",
          "FullName": null,
          "CompanyName": null,
          "Status": "Completed",
          "DisputeComment": null,
          "PaymentSummary": {
            "MailingAddress": null,
            "BankAccountSummary": {
              "Token": "98983bc5-9e98-4eab-bbf8-6fe441c954d6",
              "AccountType": "Checking",
              "LastFourDigits": "1234",
              "BankName": "Test Bank",
              "NameOnAccount": "Janet Smith"
            },
            "PaymentMethodType": "BankAccount",
            "TransactionSummary": {
              "TransactionId": "12345",
              "TransactionDate": "2019-10-21T13:28:05.7063898",
              "BatchNumber": 1,
              "PaymentProcessingStatus": "Successful",
              "PaymentResponseMessage": ""
            }
          }
        },
        {
          "ApprovalRequestPartyId": 0,
          "AccountId": 789,
          "ContactId": 78,
          "EmailAddress": "test@oneincsystems.com",
          "PhoneNumber": "1234567890",
          "FullName": null,
          "CompanyName": null,
          "Status": "Completed",
          "DisputeComment": null,
          "PaymentSummary": {
            "MailingAddress": {
              "Address": "123 Main St.",
              "City": "Folsom",
              "State": "CA",
              "Zip": "95630"
            },
            "BankAccountSummary": null,
            "PaymentMethodType": "Check",
            "TransactionSummary": null
          }
        }
      ]
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<GetApprovalRequestsByStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.ApprovalRequest">
  <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>
  <ApprovalRequests>
    <ApprovalRequestSummary>
      <AccountGroupCode>Default</AccountGroupCode>
      <ApprovalRequestId>12</ApprovalRequestId>
      <ApprovalRequestPartyInfos>
        <ApprovalRequestPartyInfo>
          <AccountId>123</AccountId>
          <ApprovalRequestPartyId>0</ApprovalRequestPartyId>
          <CompanyName i:nil="true" />
          <ContactId>12</ContactId>
          <DisputeComment i:nil="true" />
          <EmailAddress>test@oneincsystems.com</EmailAddress>
          <FullName i:nil="true" />
          <PaymentSummary xmlns:d6p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
            <d6p1:BankAccountSummary i:nil="true" />
            <d6p1:MailingAddress i:nil="true" />
            <d6p1:PaymentMethodType>VirtualCard</d6p1:PaymentMethodType>
            <d6p1:TransactionSummary>
              <d6p1:BatchNumber>1</d6p1:BatchNumber>
              <d6p1:PaymentProcessingStatus>Successful</d6p1:PaymentProcessingStatus>
              <d6p1:PaymentResponseMessage></d6p1:PaymentResponseMessage>
              <d6p1:TransactionDate>2019-10-21T13:28:05.7063898-07:00</d6p1:TransactionDate>
              <d6p1:TransactionId>12345</d6p1:TransactionId>
            </d6p1:TransactionSummary>
          </PaymentSummary>
          <PhoneNumber>1234567890</PhoneNumber>
          <Status>Completed</Status>
        </ApprovalRequestPartyInfo>
        <ApprovalRequestPartyInfo>
          <AccountId>456</AccountId>
          <ApprovalRequestPartyId>0</ApprovalRequestPartyId>
          <CompanyName i:nil="true" />
          <ContactId>34</ContactId>
          <DisputeComment i:nil="true" />
          <EmailAddress>test@oneincsystems.com</EmailAddress>
          <FullName i:nil="true" />
          <PaymentSummary xmlns:d6p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
            <d6p1:BankAccountSummary>
              <d6p1:AccountType>Checking</d6p1:AccountType>
              <d6p1:BankName>Test Bank</d6p1:BankName>
              <d6p1:LastFourDigits>1234</d6p1:LastFourDigits>
              <d6p1:NameOnAccount>Janet Smith</d6p1:NameOnAccount>
              <d6p1:Token>57eaa401-06f4-4131-bdd6-2206f83bc1c0</d6p1:Token>
            </d6p1:BankAccountSummary>
            <d6p1:MailingAddress i:nil="true" />
            <d6p1:PaymentMethodType>BankAccount</d6p1:PaymentMethodType>
            <d6p1:TransactionSummary>
              <d6p1:BatchNumber>1</d6p1:BatchNumber>
              <d6p1:PaymentProcessingStatus>Successful</d6p1:PaymentProcessingStatus>
              <d6p1:PaymentResponseMessage></d6p1:PaymentResponseMessage>
              <d6p1:TransactionDate>2019-10-21T13:28:05.7063898-07:00</d6p1:TransactionDate>
              <d6p1:TransactionId>12345</d6p1:TransactionId>
            </d6p1:TransactionSummary>
          </PaymentSummary>
          <PhoneNumber>1234567890</PhoneNumber>
          <Status>Completed</Status>
        </ApprovalRequestPartyInfo>
        <ApprovalRequestPartyInfo>
          <AccountId>789</AccountId>
          <ApprovalRequestPartyId>0</ApprovalRequestPartyId>
          <CompanyName i:nil="true" />
          <ContactId>78</ContactId>
          <DisputeComment i:nil="true" />
          <EmailAddress>test@oneincsystems.com</EmailAddress>
          <FullName i:nil="true" />
          <PaymentSummary xmlns:d6p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
            <d6p1:BankAccountSummary i:nil="true" />
            <d6p1:MailingAddress>
              <d6p1:Address>123 Main St.</d6p1:Address>
              <d6p1:City>Folsom</d6p1:City>
              <d6p1:State>CA</d6p1:State>
              <d6p1:Zip>95630</d6p1:Zip>
            </d6p1:MailingAddress>
            <d6p1:PaymentMethodType>Check</d6p1:PaymentMethodType>
            <d6p1:TransactionSummary i:nil="true" />
          </PaymentSummary>
          <PhoneNumber>1234567890</PhoneNumber>
          <Status>Completed</Status>
        </ApprovalRequestPartyInfo>
      </ApprovalRequestPartyInfos>
      <ClaimNumber>C12345</ClaimNumber>
      <CreationDate>2019-10-21T05:02:05.3113516-07:00</CreationDate>
      <ExpirationDate>2019-10-22T17:02:05.3113516-07:00</ExpirationDate>
      <ProcessType>MultiPartyPayment</ProcessType>
      <Status>Initiated</Status>
      <TimeZone>Pacific</TimeZone>
    </ApprovalRequestSummary>
    <ApprovalRequestSummary>
      <AccountGroupCode>Default</AccountGroupCode>
      <ApprovalRequestId>12</ApprovalRequestId>
      <ApprovalRequestPartyInfos>
        <ApprovalRequestPartyInfo>
          <AccountId>123</AccountId>
          <ApprovalRequestPartyId>0</ApprovalRequestPartyId>
          <CompanyName i:nil="true" />
          <ContactId>12</ContactId>
          <DisputeComment i:nil="true" />
          <EmailAddress>test@oneincsystems.com</EmailAddress>
          <FullName i:nil="true" />
          <PaymentSummary xmlns:d6p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
            <d6p1:BankAccountSummary i:nil="true" />
            <d6p1:MailingAddress i:nil="true" />
            <d6p1:PaymentMethodType>VirtualCard</d6p1:PaymentMethodType>
            <d6p1:TransactionSummary>
              <d6p1:BatchNumber>1</d6p1:BatchNumber>
              <d6p1:PaymentProcessingStatus>Successful</d6p1:PaymentProcessingStatus>
              <d6p1:PaymentResponseMessage></d6p1:PaymentResponseMessage>
              <d6p1:TransactionDate>2019-10-21T13:28:05.7063898-07:00</d6p1:TransactionDate>
              <d6p1:TransactionId>12345</d6p1:TransactionId>
            </d6p1:TransactionSummary>
          </PaymentSummary>
          <PhoneNumber>1234567890</PhoneNumber>
          <Status>Completed</Status>
        </ApprovalRequestPartyInfo>
        <ApprovalRequestPartyInfo>
          <AccountId>456</AccountId>
          <ApprovalRequestPartyId>0</ApprovalRequestPartyId>
          <CompanyName i:nil="true" />
          <ContactId>34</ContactId>
          <DisputeComment i:nil="true" />
          <EmailAddress>test@oneincsystems.com</EmailAddress>
          <FullName i:nil="true" />
          <PaymentSummary xmlns:d6p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
            <d6p1:BankAccountSummary>
              <d6p1:AccountType>Checking</d6p1:AccountType>
              <d6p1:BankName>Test Bank</d6p1:BankName>
              <d6p1:LastFourDigits>1234</d6p1:LastFourDigits>
              <d6p1:NameOnAccount>Janet Smith</d6p1:NameOnAccount>
              <d6p1:Token>98983bc5-9e98-4eab-bbf8-6fe441c954d6</d6p1:Token>
            </d6p1:BankAccountSummary>
            <d6p1:MailingAddress i:nil="true" />
            <d6p1:PaymentMethodType>BankAccount</d6p1:PaymentMethodType>
            <d6p1:TransactionSummary>
              <d6p1:BatchNumber>1</d6p1:BatchNumber>
              <d6p1:PaymentProcessingStatus>Successful</d6p1:PaymentProcessingStatus>
              <d6p1:PaymentResponseMessage></d6p1:PaymentResponseMessage>
              <d6p1:TransactionDate>2019-10-21T13:28:05.7063898-07:00</d6p1:TransactionDate>
              <d6p1:TransactionId>12345</d6p1:TransactionId>
            </d6p1:TransactionSummary>
          </PaymentSummary>
          <PhoneNumber>1234567890</PhoneNumber>
          <Status>Completed</Status>
        </ApprovalRequestPartyInfo>
        <ApprovalRequestPartyInfo>
          <AccountId>789</AccountId>
          <ApprovalRequestPartyId>0</ApprovalRequestPartyId>
          <CompanyName i:nil="true" />
          <ContactId>78</ContactId>
          <DisputeComment i:nil="true" />
          <EmailAddress>test@oneincsystems.com</EmailAddress>
          <FullName i:nil="true" />
          <PaymentSummary xmlns:d6p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
            <d6p1:BankAccountSummary i:nil="true" />
            <d6p1:MailingAddress>
              <d6p1:Address>123 Main St.</d6p1:Address>
              <d6p1:City>Folsom</d6p1:City>
              <d6p1:State>CA</d6p1:State>
              <d6p1:Zip>95630</d6p1:Zip>
            </d6p1:MailingAddress>
            <d6p1:PaymentMethodType>Check</d6p1:PaymentMethodType>
            <d6p1:TransactionSummary i:nil="true" />
          </PaymentSummary>
          <PhoneNumber>1234567890</PhoneNumber>
          <Status>Completed</Status>
        </ApprovalRequestPartyInfo>
      </ApprovalRequestPartyInfos>
      <ClaimNumber>C12345</ClaimNumber>
      <CreationDate>2019-10-21T05:02:05.3113516-07:00</CreationDate>
      <ExpirationDate>2019-10-22T17:02:05.3113516-07:00</ExpirationDate>
      <ProcessType>MultiPartyPayment</ProcessType>
      <Status>Completed</Status>
      <TimeZone>Pacific</TimeZone>
    </ApprovalRequestSummary>
  </ApprovalRequests>
</GetApprovalRequestsByStatusResponse>

POST api/ApprovalRequest/Cancel

This method is used to cancel approval request.

CancelApprovalRequestRequest

NameDescriptionTypeAdditional information
ApprovalRequestId

Unique identifier for the Approval request.

integer

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

Request Formats

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

Response Information

CancelApprovalRequestResponse

NameDescriptionTypeAdditional information
ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<CancelApprovalRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.ApprovalRequest">
  <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>
</CancelApprovalRequestResponse>

POST api/ApprovalRequest/Resend

This method is used to resend invitation message to one or more approval request parties.

ResendApprovalRequestRequest

NameDescriptionTypeAdditional information
ApprovalRequestId

Unique identifier for the Approval request.

integer

None.

ResendParties

Information for each claim party to which the initiation information will be resent.

Collection of ResendApprovalRequestPartyInfo

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

ResendApprovalRequestPartyInfo

NameDescriptionTypeAdditional information
AccountId

ClaimsPay Account Identifier

integer

None.

ContactId

Company Contact identifier. Only applicable to company accounts

integer

None.

LinkDeliveryType

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

MessageDeliveryType

None.

PhoneNumber

Property to support future functionality.

string

None.

EmailAddress

The email address for the party to which the Multi-Payee Approval emails will be sent. If DeliveryType is Email and it is not populated, the email will be sent to the email address stored for the AccountId or ContactId.

string

None.

Request Formats

 
{
  "ApprovalRequestId": 12,
  "ResendParties": [
    {
      "AccountId": 123,
      "ContactId": 123,
      "LinkDeliveryType": "Email",
      "PhoneNumber": "1234567890",
      "EmailAddress": "test@oneincsystems.com"
    }
  ],
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<ResendApprovalRequestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.ApprovalRequest">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <ApprovalRequestId>12</ApprovalRequestId>
  <ResendParties>
    <ResendApprovalRequestPartyInfo>
      <AccountId>123</AccountId>
      <ContactId>123</ContactId>
      <EmailAddress>test@oneincsystems.com</EmailAddress>
      <LinkDeliveryType>Email</LinkDeliveryType>
      <PhoneNumber>1234567890</PhoneNumber>
    </ResendApprovalRequestPartyInfo>
  </ResendParties>
</ResendApprovalRequestRequest>

Response Information

ResendApprovalRequestResponse

NameDescriptionTypeAdditional information
ApprovalRequestId

Unique identifier for the Approval request.

integer

None.

PartiesSummary

The array of the approval party information object for each of the approval parties which were included in request.

Collection of ResendApprovalRequestPartySummary

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

ResendApprovalRequestPartySummary

NameDescriptionTypeAdditional information
ApprovalRequestPartyId

ClaimsPay Approval Request Party Identifier.

integer

None.

AccountId

ClaimsPay Account Identifier.

integer

None.

ContactId

Company Contact identifier. Only applicable to company accounts.

integer

None.

EmailAddress

The email address to which the approval email will be sent.

string

None.

PhoneNumber

Property to support future functionality.

string

None.

ResendStatus

Resend operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "ApprovalRequestId": 12,
  "PartiesSummary": [
    {
      "ApprovalRequestPartyId": 1234,
      "AccountId": 123,
      "ContactId": 123,
      "EmailAddress": "test@oneincsystems.com",
      "PhoneNumber": "1234567890",
      "ResendStatus": "Success",
      "ResponseMessage": ""
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<ResendApprovalRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.ApprovalRequest">
  <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>
  <ApprovalRequestId>12</ApprovalRequestId>
  <PartiesSummary>
    <ResendApprovalRequestPartySummary>
      <AccountId>123</AccountId>
      <ApprovalRequestPartyId>1234</ApprovalRequestPartyId>
      <ContactId>123</ContactId>
      <EmailAddress>test@oneincsystems.com</EmailAddress>
      <PhoneNumber>1234567890</PhoneNumber>
      <ResendStatus>Success</ResendStatus>
      <ResponseMessage></ResponseMessage>
    </ResendApprovalRequestPartySummary>
  </PartiesSummary>
</ResendApprovalRequestResponse>

PrepaidCardAccount

POST api/PrepaidCardAccount/Load

This method is used to make a payment to a virtual or physical prepaid card account.

LoadPrepaidCardAccountRequest

NameDescriptionTypeAdditional information
AccountId

ClaimsPay Account Identifier

integer

None.

ContactId

Company Contact identifier. Only applicable to company accounts. If sent, will be used to identify the recipient of the payment complete email.

integer

None.

Amount

Amount of payment.

decimal number

None.

ClaimNumber

The claim number that is associated to the claim payment.

string

None.

ClaimDetails

Claim details which will be sent in the payment email

string

None.

PrepaidCardReferenceNumber

If making a Prepaid Card payment to a physical card (by handing the card to the payee or mailing the card to the payee), provide the Prepaid Card Reference Number that is associated to that card

string

None.

ActivateCard

Flag which indicates if the physical card will be activated. If the card is being handed to the payee, the card can be activated. If the card is being mailed to the payee, the card should not be activated.

boolean

None.

SourceUser

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

string

None.

AccountGroupCode

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

string

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

Request Formats

 
{
  "AccountId": 123,
  "ContactId": null,
  "Amount": 120.0,
  "ClaimNumber": "C12345",
  "ClaimDetails": null,
  "PrepaidCardReferenceNumber": "12345",
  "ActivateCard": true,
  "SourceUser": "Janet Smith",
  "AccountGroupCode": "Default",
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
<LoadPrepaidCardAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.PrepaidCardAccount">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <AccountGroupCode>Default</AccountGroupCode>
  <AccountId>123</AccountId>
  <ActivateCard>true</ActivateCard>
  <Amount>120</Amount>
  <ClaimDetails i:nil="true" />
  <ClaimNumber>C12345</ClaimNumber>
  <ContactId i:nil="true" />
  <PrepaidCardReferenceNumber>12345</PrepaidCardReferenceNumber>
  <SourceUser>Janet Smith</SourceUser>
</LoadPrepaidCardAccountRequest>

Response Information

LoadPrepaidCardAccountResponse

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.

PrepaidAccountBalance

If paymentMethod was PrepaidCard, the prepaid account balance after payment was completed.

decimal number

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "TransactionId": "12345",
  "TransactionDate": "2019-10-21T05:02:03.2332551",
  "TimeZone": "Pacific",
  "BatchNumber": 123,
  "PrepaidAccountBalance": 200.0,
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<LoadPrepaidCardAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.PrepaidCardAccount">
  <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>
  <BatchNumber>123</BatchNumber>
  <PrepaidAccountBalance>200</PrepaidAccountBalance>
  <TimeZone>Pacific</TimeZone>
  <TransactionDate>2019-10-21T05:02:03.2332551-07:00</TransactionDate>
  <TransactionId>12345</TransactionId>
</LoadPrepaidCardAccountResponse>

POST api/PrepaidCardAccount/ReverseLoad

This method is used to reverse a payment in full that was previously made to a prepaid card account.

ReverseLoadPrepaidCardAccountRequest

NameDescriptionTypeAdditional information
AccountId

ClaimsPay Account Identifier

integer

None.

TransactionId

Transaction identifier of load that is to be reversed.

string

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

Request Formats

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

Response Information

ReverseLoadPrepaidCardAccountResponse

NameDescriptionTypeAdditional information
TransactionId

Transaction identifier of the reverse load operation.

string

None.

TransactionDate

Transaction date and time.

date

None.

TimeZone

Transaction time zone.

string

None.

BatchNumber

Number of the batch.

integer

None.

PrepaidAccountBalance

Balance of the prepaid account after the reverse load has been completed.

decimal number

None.

OriginalPrepaidAccountBalance

Original balance of the prepaid account prior to the reverse load request.

decimal number

None.

ResponseCode

Operation response code.

string

None.

ResponseMessage

Response message.

string

None.

Response Formats

{
  "TransactionId": "12345",
  "TransactionDate": "2019-10-21T05:02:03.2332551",
  "TimeZone": "Pacific",
  "BatchNumber": 123,
  "PrepaidAccountBalance": 200.0,
  "OriginalPrepaidAccountBalance": 300.0,
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<ReverseLoadPrepaidCardAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.PrepaidCardAccount">
  <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>
  <BatchNumber>123</BatchNumber>
  <OriginalPrepaidAccountBalance>300</OriginalPrepaidAccountBalance>
  <PrepaidAccountBalance>200</PrepaidAccountBalance>
  <TimeZone>Pacific</TimeZone>
  <TransactionDate>2019-10-21T05:02:03.2332551-07:00</TransactionDate>
  <TransactionId>12345</TransactionId>
</ReverseLoadPrepaidCardAccountResponse>

Session

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

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

URI Parameters

NameDescriptionTypeAdditional information
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

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": "b6a3a82d-87c9-44fe-ab6d-40bc187288b9",
  "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>b6a3a82d-87c9-44fe-ab6d-40bc187288b9</SessionId>
</CreateSessionResponse>

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

None.

AccountId

ClaimsPay Account Identifier

integer

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

Request Formats

 
{
  "Token": "40712fbc-6734-4eaa-80a3-a14db9071f2a",
  "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>40712fbc-6734-4eaa-80a3-a14db9071f2a</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

ClaimsPay Account Identifier

integer

None.

ClaimNumber

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

string

None.

BankAccountDetails

Bank Account details.

BankAccountDetails

None.

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

None.

Request Formats

 
{
  "AccountId": 123,
  "ClaimNumber": "C12345",
  "BankAccountDetails": {
    "RoutingNumber": "021000021",
    "AccountNumber": "123456789",
    "CustomerName": "Janet Smith",
    "AccountType": "Checking"
  },
  "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-10-21T13:28:06.2532583",
  "BankAccountSummary": {
    "Token": "ecc0f500-0c4b-4a9c-9f5e-988451ba299f",
    "AccountType": "Checking",
    "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>ecc0f500-0c4b-4a9c-9f5e-988451ba299f</d2p1:Token>
  </BankAccountSummary>
  <TimeZone>Pacific</TimeZone>
  <TokenCreationTime>2019-10-21T13:28:06.2532583-07: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

ClaimsPay Account Identifier

integer

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

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.

HasPrepaidCardAccount

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": "99dd84e8-d74c-45b1-ae6b-a46bd45272d0",
      "AccountType": "Checking",
      "LastFourDigits": "1234",
      "BankName": "Test Bank",
      "NameOnAccount": "Janet Smith"
    }
  ],
  "HasPrepaidCardAccount": 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>99dd84e8-d74c-45b1-ae6b-a46bd45272d0</d2p1:Token>
    </d2p1:BankAccountSummary>
  </BankAccounts>
  <HasPrepaidCardAccount>false</HasPrepaidCardAccount>
</GetPaymentMethodInfoResponse>

EpayRequest

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

POST api/EpayRequest/Create

CreateEpayRequest

NameDescriptionTypeAdditional information
AccountId

ClaimsPay Account Identifier

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.

ExtendedParameters

Extended Parameters

Dictionary of string and string

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

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": "Email",
  "EpayPhoneNumber": null,
  "ExtendedParameters": 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>
  <ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
</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-10-21T13:28:06.3938811",
  "EpayEmailAddress": "test@oneincsystems.com",
  "EpayRequestType": "Email",
  "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-10-21T13:28:06.3938811-07:00</EpayRequestDate>
  <EpayRequestId>12</EpayRequestId>
  <EpayRequestType>Email</EpayRequestType>
</CreateEpayResponse>

POST api/EpayRequest/GetStatus

GetStatusByEpayRequest

NameDescriptionTypeAdditional information
EpayRequestId

Unique identifier for the ePay request.

integer

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

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

ClaimsPay Account Identifier

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
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": "Complete",
  "EpayRequestDate": "2019-10-21T13:28:06.475237",
  "BankAccountSummary": {
    "Token": "f1ad7925-f1d9-41ed-bf02-334316359953",
    "AccountType": "Checking",
    "LastFourDigits": "1234",
    "BankName": "Test Bank",
    "NameOnAccount": "Janet Smith"
  },
  "EpayRequestType": "Email",
  "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>f1ad7925-f1d9-41ed-bf02-334316359953</d2p1:Token>
  </BankAccountSummary>
  <ClaimNumber>C12345</ClaimNumber>
  <ContactId>123</ContactId>
  <EpayEmailAddress>test@oneincsystems.com</EpayEmailAddress>
  <EpayPhoneNumber i:nil="true" />
  <EpayRequestDate>2019-10-21T13:28:06.475237-07:00</EpayRequestDate>
  <EpayRequestStatus>Complete</EpayRequestStatus>
  <EpayRequestType>Email</EpayRequestType>
</GetStatusByEpayResponse>

POST api/EpayRequest/Cancel

CancelEpayRequest

NameDescriptionTypeAdditional information
EpayRequestId

Unique identifier for the ePay request.

integer

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

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

ResendEpayRequest

NameDescriptionTypeAdditional information
EpayRequestId

Unique identifier for the ePay request.

integer

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

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

BatchAccountImportRequest

NameDescriptionTypeAdditional information
Accounts

List of new accounts to add

Collection of ClaimsPayAccount

None.

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string

None.

ListOfClaimsPayAccount

NameDescriptionTypeAdditional information
CompanyDetails

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

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": "Enabled"
        },
        "CompanyType": "Undefined"
      },
      "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": "Enabled"
        },
        "CompanyType": "Undefined"
      },
      "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:CompanyType>Undefined</d4p1:CompanyType>
        <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:CompanyType>Undefined</d4p1:CompanyType>
        <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

ClaimsPay 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>


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 Test: No response from Processor

Use the following bank account number to simulate specific API response codes regardless of amount.

Transaction Type Account Number Response Code Description
SaveEft 1234567891 Success Test: Successfully saved
Credit or Debit 1234567892 Success Test: Bank account transaction is successfully approved
Credit or Debit 1234567893 ACHTransactionFailed Test: Not able to process bank account payment
Credit or Debit 1234567894 GatewayInternalError Test: System is down
Credit or Debit 1234567895 NoProcessorResponse Test: No response from Processor
Credit or Debit for subsequent Void or refund 1234567896 Success Test: Bank account transaction is successfully approved
Credit or Debit for subsequent Void or refund 1234567897 Success Test: Bank account transaction is successfully approved
Credit or Debit for subsequent Void or refund 1234567898 Success Test: Bank account transaction is successfully approved
Void or Refund 1234567896 ACHTransactionFailed Test: Not able to process bank account payment
Credit or Debit for subsequent Void or refund 1234567897 GatewayInternalError Test: System is down
Credit or Debit for subsequent Void or refund 1234567898 NoProcessorResponse Test: 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 Applicable Methods
Success Indicates a successful transaction. All
InvalidAuthenticationKey Invalid Authentication Key. This key will be assigned to you by One, Inc. All
InternalServerError This generic error can happen for different reasons. The error description will contain more detailed information as to the core of the problem. All
InvalidRequest This error occurs when request contains invalid or insufficient information. The error description will contain more detailed information as to the core of the problem. All
MerchantDisabled Your Merchant account is disabled. BankAccount Credit | BankAccount Verify | PaymentMethod Save | PaymentMethod Remove | PaymentMethod GetInfo
NoProcessorResponse An attempt to authorize a card through the card network has timed out. You should try again. BankAccount Credit | BankAccount VoidCredit | BankAccount Verify | PaymentMethod Save | PaymentMethod Remove
BlockedBankAccount This bank account has been blocked due to past failed payments. BankAccount Credit | PaymentMethod Save
InvalidRoutingNumber You have sent in an invalid Routing Number. BankAccount Credit | PaymentMethod Save
InvalidAccountNumber You have sent in an invalid Account Number. BankAccount Credit | PaymentMethod Save
InvalidEFTAmount Amount must be greater than $0. BankAccount Credit
OverMaximumPayment Payment Amount has exceeded maximum allowed. BankAccount Credit
EFTCustomerNameMissing When processing an EFT, you must supply the customer name or you will receive this error. BankAccount Credit | PaymentMethod Save
DuplicateTransaction A duplicate payment has been entered into the system with the same Amount, Last 4, PolicyNumber (ClientRefData1) in the configured specified amount of time. Default is 2 min but this can be changed. Please contact support team to change this amount. BankAccount Credit
ACHTransactionFailed Returned when an error returns for processing Bank Account Credit transactions. BankAccount Credit
GatewayInternalError This generic error can happen for different reasons. The error description will contain more detailed information as to the core of the problem. BankAccount Credit | BankAccount VoidCredit | BankAccount Verify | PaymentMethod Save | PaymentMethod Remove
OperationNotSupportedByMerchant This error may occur when trying to execute operation which is currently disabled for merchant. BankAccount Verify | PaymentMethod Save
IncorrectTransactionId Indicates that the transactionID that you are sending for a refund or void is not a valid transaction or cannot be found. BankAccount VoidCredit
BatchHasBeenClosed This error message is returned when you attempt to void a transaction when the batch has already been closed. BankAccount VoidCredit