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.

MethodEndpoint
Create https://stgportalone.processonepayments.com/ClaimsPay/api/Account/Create

CreateAccountRequest

NameDescriptionTypeRequired*Additional information
CompanyDetails

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

CompanyDetails No
IndividualDetails

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

IndividualDetails No
ClaimNumber

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

string No
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

CompanyDetails

NameDescriptionTypeRequired*Additional information
CompanyName

The name of the company entity.

string No
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 No
Address

The physical street address for the company.

string No
Address2

Secondary Address information.

string No
City

The city for the company.

string No
State

The state for the company.

string No
Zip

The zip code for the company.

string No
ContactDetails

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

ContactDetails No
CompanyType

Type of company: business or vendor.

CompanyType No

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

ContactDetails

NameDescriptionTypeRequired*Additional 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 No
FirstName

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

string No
LastName

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

string No
Email

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

string No
PhoneNumber

The phone number for the company contact.

string No
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 No
CompanyContactInformation

Additional company or contact information which if present will be used for mailing address.

string No
ExternalCompanyContactId

A unique external identifier for company contact.

string No

Optional. If not provided during initial creation of Account, an ID will be system-generated. This field can be used as externalCustomerId to manage customer notification preferences.

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

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

NameDescriptionTypeRequired*Additional information
FirstName

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

string No
LastName

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

string No
Email

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

string No
Address

The street address for the individual payee.

string No
Address2

Secondary Address information.

string No
City

The city for the individual payee.

string No
State

The state for the individual payee.

string No
Zip

The zip code for the individual payee.

string No
PhoneNumber

The Payee's phone number.

string No
ExternalIndividualId

A unique external identifier for individual contact.

string No

Optional. If not provided during initial creation of Account, an ID will be system-generated. This field can be used as externalCustomerId to manage customer notification preferences.

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

Request Formats

 
                                
                                 {
  "CompanyDetails": {
    "CompanyName": "Main Street Body Shop",
    "TaxId": "1234567890",
    "Address": "123 Main St.",
    "Address2": "Office 5",
    "City": "Folsom",
    "State": "CA",
    "Zip": "95630",
    "ContactDetails": {
      "ContactId": 123,
      "FirstName": "Janet",
      "LastName": "Smith",
      "Email": "[email protected]",
      "PhoneNumber": "555-0100",
      "WebAccess": "Enabled",
      "CompanyContactInformation": "Addmissions office",
      "ExternalCompanyContactId": null
    },
    "CompanyType": "Undefined"
  },
  "IndividualDetails": {
    "FirstName": "Janet",
    "LastName": "Smith",
    "Email": "[email protected]",
    "Address": "123 Main St.",
    "Address2": "Office 5",
    "City": "Folsom",
    "State": "CA",
    "Zip": "95630",
    "PhoneNumber": "555-0100",
    "ExternalIndividualId": null
  },
  "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>
    <Address2>Office 5</Address2>
    <City>Folsom</City>
    <CompanyName>Main Street Body Shop</CompanyName>
    <CompanyType>Undefined</CompanyType>
    <ContactDetails>
      <CompanyContactInformation>Addmissions office</CompanyContactInformation>
      <ContactId>123</ContactId>
      <Email>[email protected]</Email>
      <ExternalCompanyContactId i:nil="true" />
      <FirstName>Janet</FirstName>
      <LastName>Smith</LastName>
      <PhoneNumber>555-0100</PhoneNumber>
      <WebAccess>Enabled</WebAccess>
    </ContactDetails>
    <State>CA</State>
    <TaxId>1234567890</TaxId>
    <Zip>95630</Zip>
  </CompanyDetails>
  <IndividualDetails>
    <Address>123 Main St.</Address>
    <Address2>Office 5</Address2>
    <City>Folsom</City>
    <Email>[email protected]</Email>
    <ExternalIndividualId i:nil="true" />
    <FirstName>Janet</FirstName>
    <LastName>Smith</LastName>
    <PhoneNumber>555-0100</PhoneNumber>
    <State>CA</State>
    <Zip>95630</Zip>
  </IndividualDetails>
</CreateAccountRequest>

Response Information

CreateAccountResponse

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer No
ContactId

Company Contact identifier. Only applicable to company accounts.

integer No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

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.

MethodEndpoint
CreateContact https://stgportalone.processonepayments.com/ClaimsPay/api/Account/CreateContact

CreateContactRequest

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer Yes
FirstName

The first name of the company contact.

string No
LastName

The last name of the company contact.

string No
Email

The email address for the company contact.

string No
Phone

The phone number for the company contact.

string No
CompanyContactInformation

Additional company or contact information which if present will be used for mailing address.

string No
ExternalCompanyContactId

The unique identifier for company contact. Use this field as ExternalCustomerId for creating customer account in PortalOne API

string No
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

Request Formats

 
                                
                                 {
  "AccountId": 123,
  "FirstName": "Janet",
  "LastName": "Smith",
  "Email": "[email protected]",
  "Phone": "555-0100",
  "CompanyContactInformation": null,
  "ExternalCompanyContactId": null,
  "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>
  <CompanyContactInformation i:nil="true" />
  <Email>[email protected]</Email>
  <ExternalCompanyContactId i:nil="true" />
  <FirstName>Janet</FirstName>
  <LastName>Smith</LastName>
  <Phone>555-0100</Phone>
</CreateContactRequest>

Response Information

CreateContactResponse

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer No
ContactId

Company Contact identifier. Only applicable to company accounts.

integer No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

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/SendWebsiteEmail

This method is used to initiate a new email send, if a payee had not registered to the website or no longer has or never received the email with the website link.

MethodEndpoint
SendWebsiteEmail https://stgportalone.processonepayments.com/ClaimsPay/api/Account/SendWebsiteEmail

SendWebsiteEmailRequest

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer No
ContactId

Company Contact identifier. Only applicable to company accounts.

integer No
EmailAddress

Email address to which the website email will be sent. This email address will be updated in the ClaimsPay system for the Contact or Individual.

string Yes
IsUsernameRecovery

Setting to indicate if the email is being sent to allow the user to reset their website profile credentials. If yes, the user will be re-authenticated and directed to update their username and password. For a user that does not have a web profile, the value should be no.

boolean No
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

Request Formats

 
                                
                                 {
  "AccountId": 123,
  "ContactId": 123,
  "EmailAddress": "[email protected]",
  "IsUsernameRecovery": false,
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
                                
                                 <SendWebsiteEmailRequest 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>
  <ContactId>123</ContactId>
  <EmailAddress>[email protected]</EmailAddress>
  <IsUsernameRecovery>false</IsUsernameRecovery>
</SendWebsiteEmailRequest>

Response Information

SendWebsiteEmailResponse

NameDescriptionTypeRequired*Additional information
EmailUpdateSuccess

Indicates if the email address was updated successfully.

boolean No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

Response Formats

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

POST api/Account/Update

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

MethodEndpoint
Update https://stgportalone.processonepayments.com/ClaimsPay/api/Account/Update

UpdateAccountRequest

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer No
IndividualProfileDetails

Individual profile information.

IndividualProfileDetails No
CompanyProfileDetails

Company and contact profile information.

CompanyProfileDetails No
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

IndividualProfileDetails

NameDescriptionTypeRequired*Additional information
FirstName

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

string No
LastName

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

string No
Phone

The Payee's phone number.

string No
Address

The street address for the individual payee.

string No
Address2

Secondary Address information.

string No
City

The city for the individual payee.

string No
State

The state for the individual payee.

string No
Zip

The zip code for the individual payee.

string No
ExternalIndividualId

The unique identifier for individual contact. Use this field as ExternalCustomerId for creating customer account in PortalOne API

string No

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

CompanyProfileDetails

NameDescriptionTypeRequired*Additional information
CompanyName

The name of the company entity.

string No
Address

The physical street address for the company.

string No
Address2

Secondary Address information.

string No
City

The city for the company.

string No
State

The state for the company.

string No
Zip

The zip code for the company.

string No
ContactDetails

Details on the company contact person profile.

ContactProfileDetails No

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

ContactProfileDetails

NameDescriptionTypeRequired*Additional information
ContactId

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

integer No
FirstName

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

string No
LastName

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

string No
Phone

The phone number for the company contact.

string No
Email

The email address for the company contact.

string No
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 No
CompanyContactInformation

Additional company or contact information which if present will be used for mailing address.

string No
ExternalCompanyContactId

The unique identifier for company contact. Use this field as ExternalCustomerId for creating customer account in PortalOne API

string No

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

Request Formats

 
                                
                                 {
  "AccountId": 123,
  "IndividualProfileDetails": {
    "FirstName": "Janet",
    "LastName": "Smith",
    "Phone": "555-0100",
    "Address": "123 Main St.",
    "Address2": "Office 5",
    "City": "Folsom",
    "State": "CA",
    "Zip": "95630",
    "ExternalIndividualId": null
  },
  "CompanyProfileDetails": {
    "CompanyName": "Main Street Body Shop",
    "Address": "123 Main St.",
    "Address2": "Office 5",
    "City": "Folsom",
    "State": "CA",
    "Zip": "95630",
    "ContactDetails": {
      "ContactId": 123,
      "FirstName": "Janet",
      "LastName": "Smith",
      "Phone": "555-0100",
      "Email": "[email protected]",
      "WebAccessType": "Enabled",
      "CompanyContactInformation": null,
      "ExternalCompanyContactId": null
    }
  },
  "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>
    <Address2>Office 5</Address2>
    <City>Folsom</City>
    <CompanyName>Main Street Body Shop</CompanyName>
    <ContactDetails>
      <CompanyContactInformation i:nil="true" />
      <ContactId>123</ContactId>
      <Email>[email protected]</Email>
      <ExternalCompanyContactId i:nil="true" />
      <FirstName>Janet</FirstName>
      <LastName>Smith</LastName>
      <Phone>555-0100</Phone>
      <WebAccessType>Enabled</WebAccessType>
    </ContactDetails>
    <State>CA</State>
    <Zip>95630</Zip>
  </CompanyProfileDetails>
  <IndividualProfileDetails>
    <Address>123 Main St.</Address>
    <Address2>Office 5</Address2>
    <City>Folsom</City>
    <ExternalIndividualId i:nil="true" />
    <FirstName>Janet</FirstName>
    <LastName>Smith</LastName>
    <Phone>555-0100</Phone>
    <State>CA</State>
    <Zip>95630</Zip>
  </IndividualProfileDetails>
</UpdateAccountRequest>

Response Information

UpdateAccountResponse

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction identifier.

integer No
IndividualProfileDetails

Individual profile information.

IndividualProfileDetails No
CompanyProfileDetails

Company and contact profile information.

CompanyProfileDetails No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

Response Formats

{
  "TransactionId": 123,
  "IndividualProfileDetails": {
    "FirstName": "Janet",
    "LastName": "Smith",
    "Phone": "555-0100",
    "Address": "123 Main St.",
    "Address2": "Office 5",
    "City": "Folsom",
    "State": "CA",
    "Zip": "95630",
    "ExternalIndividualId": null
  },
  "CompanyProfileDetails": {
    "CompanyName": "Main Street Body Shop",
    "Address": "123 Main St.",
    "Address2": "Office 5",
    "City": "Folsom",
    "State": "CA",
    "Zip": "95630",
    "ContactDetails": {
      "ContactId": 123,
      "FirstName": "Janet",
      "LastName": "Smith",
      "Phone": "555-0100",
      "Email": "[email protected]",
      "WebAccessType": "Enabled",
      "CompanyContactInformation": null,
      "ExternalCompanyContactId": null
    }
  },
  "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>
    <Address2>Office 5</Address2>
    <City>Folsom</City>
    <CompanyName>Main Street Body Shop</CompanyName>
    <ContactDetails>
      <CompanyContactInformation i:nil="true" />
      <ContactId>123</ContactId>
      <Email>[email protected]</Email>
      <ExternalCompanyContactId i:nil="true" />
      <FirstName>Janet</FirstName>
      <LastName>Smith</LastName>
      <Phone>555-0100</Phone>
      <WebAccessType>Enabled</WebAccessType>
    </ContactDetails>
    <State>CA</State>
    <Zip>95630</Zip>
  </CompanyProfileDetails>
  <IndividualProfileDetails>
    <Address>123 Main St.</Address>
    <Address2>Office 5</Address2>
    <City>Folsom</City>
    <ExternalIndividualId i:nil="true" />
    <FirstName>Janet</FirstName>
    <LastName>Smith</LastName>
    <Phone>555-0100</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.

MethodEndpoint
GetInfo https://stgportalone.processonepayments.com/ClaimsPay/api/Account/GetInfo

GetAccountInfoRequest

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer Yes
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

Request Formats

 
                                
                                 {
  "AccountId": 123,
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
                                
                                 <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">Authentication Key</ClaimsPayAuthenticationKey>
  <AccountId>123</AccountId>
</GetAccountInfoRequest>

Response Information

GetAccountInfoResponse

NameDescriptionTypeRequired*Additional information
IndividualDetails

Stored information for the Individual ClaimsPay AccountID.

IndividualDetails No
CompanyInformation

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

CompanyInformation No
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 No
Cards

Array of cards that are associated to the AccountId. The array will return an object (token and supporting information that can be used to process a Push to Card payment) for each card.

Collection of CardSummary No
HasPrepaidCardAccount

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

boolean No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

CompanyInformation

NameDescriptionTypeRequired*Additional information
CompanyName

The name of the company entity.

string No
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 No
Address

The physical street address for the company.

string No
Address2

Secondary Address information.

string No
City

The city for the company.

string No
State

The state for the company.

string No
Zip

The zip code for the company.

string No
CompanyType

The company type.

CompanyType No
ContactsDetails

Array of ContactDetails associated to the company.

Collection of ContactDetails No

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

BankAccountSummary

NameDescriptionTypeRequired*Additional information
Token

Bank Account payment token.

string No
AccountType

Checking / Savings.

BankAccountType No
LastFourDigits

Last four digits of the bank account number.

string No
BankName

Name of Bank based on Routing Number.

string No
NameOnAccount

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

string No

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

BankAccountType

Possible enumeration values:

NameValueDescription
Checking

0

Checking.

Savings

1

Savings.

CardSummary

NameDescriptionTypeRequired*Additional information
Token

Card payment token.

string No
LastFourDigits

Last four digits of the card number.

string No
CardType

Card type.

CardType No
ExpirationYear

Year of the expiration of the card.

string No
ExpirationMonth

Month of the expiration of the card.

string No
Holder

Card holder.

Customer No

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

CardType

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined.

Visa

1

Visa.

MasterCard

2

MasterCard.

AmericanExpress

3

American Express.

Discover

4

Discover.

PinlessDebitGeneric

5

PINless Debit.

Star

6

Star.

Nyce

7

Nyce.

Pulse

8

Pulse.

Other

99

Other.

Customer

NameDescriptionTypeRequired*Additional information
Name

Customer name.

string Yes
Zip

Customer zip code.

string No
Address

Customer address.

string No
City

Customer city.

string No
State

Customer state.

string No
Phone

Customer phone.

string No

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

Response Formats

{
  "IndividualDetails": {
    "FirstName": "Janet",
    "LastName": "Smith",
    "Email": "[email protected]",
    "Address": "123 Main St.",
    "Address2": "Office 5",
    "City": "Folsom",
    "State": "CA",
    "Zip": "95630",
    "PhoneNumber": "555-0100",
    "ExternalIndividualId": null
  },
  "CompanyInformation": {
    "CompanyName": "Main Street Body Shop",
    "TaxId": "1234567890",
    "Address": "123 Main St.",
    "Address2": null,
    "City": "Folsom",
    "State": "CA",
    "Zip": "95630",
    "CompanyType": "Business",
    "ContactsDetails": [
      {
        "ContactId": 123,
        "FirstName": "Janet",
        "LastName": "Smith",
        "Email": "[email protected]",
        "PhoneNumber": "555-0100",
        "WebAccess": "Enabled",
        "CompanyContactInformation": "Addmissions office",
        "ExternalCompanyContactId": null
      }
    ]
  },
  "BankAccounts": [
    {
      "Token": "9576cc6d-61e0-48ea-ae0c-9627d9cdd558",
      "AccountType": "Checking",
      "LastFourDigits": "1234",
      "BankName": "Test Bank",
      "NameOnAccount": "Janet Smith"
    }
  ],
  "Cards": [
    {
      "Token": "498d3d81-25d7-4bab-9c5e-0ba363942f58",
      "LastFourDigits": "1234",
      "CardType": "Visa",
      "ExpirationYear": "2023",
      "ExpirationMonth": "1",
      "Holder": {
        "Name": "Janet Smith",
        "Zip": "95630",
        "Address": "123 Main St.",
        "City": "Folsom",
        "State": "CA",
        "Phone": "555-0100"
      }
    }
  ],
  "HasPrepaidCardAccount": true,
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<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">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>9576cc6d-61e0-48ea-ae0c-9627d9cdd558</d2p1:Token>
    </d2p1:BankAccountSummary>
  </BankAccounts>
  <Cards xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
    <d2p1:CardSummary>
      <d2p1:CardType>Visa</d2p1:CardType>
      <d2p1:ExpirationMonth>1</d2p1:ExpirationMonth>
      <d2p1:ExpirationYear>2023</d2p1:ExpirationYear>
      <d2p1:Holder>
        <d2p1:Address>123 Main St.</d2p1:Address>
        <d2p1:City>Folsom</d2p1:City>
        <d2p1:Name>Janet Smith</d2p1:Name>
        <d2p1:Phone>555-0100</d2p1:Phone>
        <d2p1:State>CA</d2p1:State>
        <d2p1:Zip>95630</d2p1:Zip>
      </d2p1:Holder>
      <d2p1:LastFourDigits>1234</d2p1:LastFourDigits>
      <d2p1:Token>498d3d81-25d7-4bab-9c5e-0ba363942f58</d2p1:Token>
    </d2p1:CardSummary>
  </Cards>
  <CompanyInformation>
    <Address>123 Main St.</Address>
    <Address2 i:nil="true" />
    <City>Folsom</City>
    <CompanyName>Main Street Body Shop</CompanyName>
    <CompanyType>Business</CompanyType>
    <ContactsDetails>
      <ContactDetails>
        <CompanyContactInformation>Addmissions office</CompanyContactInformation>
        <ContactId>123</ContactId>
        <Email>[email protected]</Email>
        <ExternalCompanyContactId i:nil="true" />
        <FirstName>Janet</FirstName>
        <LastName>Smith</LastName>
        <PhoneNumber>555-0100</PhoneNumber>
        <WebAccess>Enabled</WebAccess>
      </ContactDetails>
    </ContactsDetails>
    <State>CA</State>
    <TaxId>1234567890</TaxId>
    <Zip>95630</Zip>
  </CompanyInformation>
  <HasPrepaidCardAccount>true</HasPrepaidCardAccount>
  <IndividualDetails>
    <Address>123 Main St.</Address>
    <Address2>Office 5</Address2>
    <City>Folsom</City>
    <Email>[email protected]</Email>
    <ExternalIndividualId i:nil="true" />
    <FirstName>Janet</FirstName>
    <LastName>Smith</LastName>
    <PhoneNumber>555-0100</PhoneNumber>
    <State>CA</State>
    <Zip>95630</Zip>
  </IndividualDetails>
</GetAccountInfoResponse>

BankAccount

BankAccount operations

POST api/BankAccount/Credit

This method is used to submit BankAccount payment.

MethodEndpoint
Credit https://stgportalone.processonepayments.com/ClaimsPay/api/BankAccount/Credit

CreditBankAccountRequest

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer Yes
ContactId

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

integer No
Amount

Amount of payment.

decimal number Yes
Token

Saved bank account token.

string No
AccountGroupCode

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

string No
BankAccountDetails

Bank Account details.

BankAccountDetails No
ClaimNumber

Claim number that will be associated to the payment.

string Yes
ClaimDetails

Claim details which will be sent in the payment email.

string No
SourceUser

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

string No
BypassBankAccountValidation

Bypasses bank account validation during save when BankAccountDetails are sent.

boolean No
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

BankAccountDetails

NameDescriptionTypeRequired*Additional information
RoutingNumber

The bank routing number. Must only contain numbers.

string No
AccountNumber

The bank account number. Must only contain numbers.

string No
CustomerName

Customer Name for this Bank Account.

string No
AccountType

Checking / Savings.

BankAccountType No

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

Request Formats

 
                                
                                 {
  "AccountId": 123,
  "ContactId": 123,
  "Amount": 120.0,
  "Token": "9576cc6d-61e0-48ea-ae0c-9627d9cdd558",
  "AccountGroupCode": "Default",
  "BankAccountDetails": {
    "RoutingNumber": "021000021",
    "AccountNumber": "123456789",
    "CustomerName": "Janet Smith",
    "AccountType": "Checking"
  },
  "ClaimNumber": "C12345",
  "ClaimDetails": "Claim details",
  "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>Claim details</ClaimDetails>
  <ClaimNumber>C12345</ClaimNumber>
  <ContactId>123</ContactId>
  <SourceUser>Janet Smith</SourceUser>
  <Token>9576cc6d-61e0-48ea-ae0c-9627d9cdd558</Token>
</CreditBankAccountRequest>

Response Information

CreditBankAccountResponse

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction identifier.

string No
TransactionDate

Transaction date and time.

date No
TimeZone

Transaction time zone.

string No
BatchNumber

Number of the batch.

integer No
BankAccountSummary

Bank account summary information.

BankAccountSummary No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

Response Formats

{
  "TransactionId": "123",
  "TransactionDate": "2020-10-27T04:59:49",
  "TimeZone": "Pacific",
  "BatchNumber": 5,
  "BankAccountSummary": {
    "Token": "9576cc6d-61e0-48ea-ae0c-9627d9cdd558",
    "AccountType": "Checking",
    "LastFourDigits": "1234",
    "BankName": "Test Bank",
    "NameOnAccount": "Janet Smith"
  },
  "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>1234</d2p1:LastFourDigits>
    <d2p1:NameOnAccount>Janet Smith</d2p1:NameOnAccount>
    <d2p1:Token>9576cc6d-61e0-48ea-ae0c-9627d9cdd558</d2p1:Token>
  </BankAccountSummary>
  <BatchNumber>5</BatchNumber>
  <TimeZone>Pacific</TimeZone>
  <TransactionDate>2020-10-27T04:59:49</TransactionDate>
  <TransactionId>123</TransactionId>
</CreditBankAccountResponse>

POST api/BankAccount/VoidCredit

This method is used to void EFT payment.

MethodEndpoint
VoidCredit https://stgportalone.processonepayments.com/ClaimsPay/api/BankAccount/VoidCredit

VoidCreditRequest

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction identifier.

string Yes
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

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

NameDescriptionTypeRequired*Additional information
BatchNumber

Number of the batch.

integer No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

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.

MethodEndpoint
Verify https://stgportalone.processonepayments.com/ClaimsPay/api/BankAccount/Verify

VerifyBankAccountRequest

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer Yes
BankAccountDetails

Bank Account details.

BankAccountDetails No
Token

Previously saved Payment Token.

string No
SourceUser

User identifier/name for reporting purposes.

string No
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

Request Formats

 
                                
                                 {
  "AccountId": 123,
  "BankAccountDetails": {
    "RoutingNumber": "021000021",
    "AccountNumber": "123456789",
    "CustomerName": "Janet Smith",
    "AccountType": "Checking"
  },
  "Token": "9576cc6d-61e0-48ea-ae0c-9627d9cdd558",
  "SourceUser": "Janet Smith",
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
                                
                                 <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">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>
  <SourceUser>Janet Smith</SourceUser>
  <Token>9576cc6d-61e0-48ea-ae0c-9627d9cdd558</Token>
</VerifyBankAccountRequest>

Response Information

VerifyBankAccountResponse

NameDescriptionTypeRequired*Additional information
ServerReferenceData

Additional response data.

ServerReferenceData No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

ServerReferenceData

NameDescriptionTypeRequired*Additional information
ServerReferenceData1

ServerReferenceData1.

string No

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

Response Formats

{
  "ServerReferenceData": {
    "ServerReferenceData1": "Server reference data"
  },
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<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">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts"></ResponseMessage>
  <ServerReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
    <d2p1:ServerReferenceData1>Server reference data</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.

MethodEndpoint
Create https://stgportalone.processonepayments.com/ClaimsPay/api/ApprovalRequest/Create

CreateApprovalRequestRequest

NameDescriptionTypeRequired*Additional information
ClaimNumber

Claim number for which the approval process will be completed.

string No
TotalAmount

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

decimal number No
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. 4. IssueCheckPayment. System will create an approval request to issue a check made out to one to four parties. Parties will not be required to complete any action.

string
Process Type Values
Yes
IsAuthorityHold

Indicates if the approval request was created with an Authority Hold which requires the approval request to be released prior to initiating the payment process to the approval request parties.

boolean No
ClaimDetails

Claim detail information that will be displayed to the claim party in the website and emails or that will be printed on the check Stub for checks fulfilled by One Inc. Printed information will be limited to 19 lines with up to 111 characters each line. If a string is sent that is greater than 111 characters, the values will be parsed into multiple lines by splitting the lines at spaces. If the data sent results in over 19 rows after parsing, the system will only print the first 19 rows.

Collection of string No
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. For payments made via check, the AccountGroupCode will indicate to the system which bank account and routing number should be used to issue the check.

string No
ApprovalRequestParties

Array of ApprovalRequestParty objects for each of the parties that have an interest in the claim. The number of parties allowable are based upon the ProcessType: SinglePartyPayment and SinglePartySave, can have 1 party. MultiPartyPayment can have 2-10 parties. IssueCheckPayment can have 1-4 parties. At least one party must be a payment recipient. Each party must have a unique AccountId.

Collection of ApprovalRequestParty Yes
ComposeCheckProperties

Information that will be used to define how the check will be made when the approval request results in a check payment.

ComposeCheckProperties No

Required if IssueCheckPayment.

ExtendedParameters

The collection of key value pairs for optional parameters.

Dictionary of string and string
ApprovalRequestExtendedParameters
No
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

Process Type Values

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

ApprovalRequestParty

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer Yes
ContactId

Company Contact identifier. Only applicable to company accounts.

integer No
ExternalIndividualId

A unique external identifier for individual contact that was used as externalCustomerId to manage customer notification preferences.

string No
ExternalCompanyContactId

A unique external identifier for company contact that was used as externalCustomerId to manage customer notification preferences.

string No
ApprovalRole

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

ApprovalRequestPartyRole Yes
LinkDeliveryType

The delivery method to receive the link to the ClaimsPay approval portal. This can be by email or text message.

MessageDeliveryType No
PhoneNumber

The Phone Number for the party to which the Approval Request text message will be sent. If DeliveryType is Text and it is not populated, the text will be sent to the Phone Number associated to the AccountId by default (unless modified by the Adjustor in the Adjustor Modal)

string No
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 by default (unless modified by the Adjustor in the Adjustor Modal).

string No
PaymentAmount

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

decimal number No
DisplayOtherPartiesInfo

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

Collection of DisplayOtherPartyInfo No
PaymentMethodType

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

PaymentMethodType No
Token

Token for the bank account or card that will receive the payment for an approval party with the role of PaymentOnlyActionBypass if PaymentMethodType is Bank Account or Card.

string No
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 No
PartyCheckProperties

Properties which will be used to compose a check if the payment method is check fulfilled by One Inc. When the ProcessType is IssueCheckPayment the information should be provided for the party with the role of MailToCheckParty.

PartyCheckProperties No
ExtendedParameters

The collection of key value pairs for optional parameters.

Dictionary of string and string
ApprovalRequestPartyExtendedParameters
No
BypassVendorNetwork

When true, the system will bypass the Vendor's Payment Method and Delivery Method from the Vendor Network. The VendorPay Welcome Email (i.e. Instant Payment) will be sent to the email provided or associated with the vendor.

boolean No

If no email is available system will display message that an email is required.

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

ApprovalRequestPartyRole

Possible enumeration values:

NameValueDescription
ApprovalOnly

1

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

PaymentOnly

2

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

ApprovalAndPayment

3

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

PaymentOnlyActionBypass

4

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

MailToCheckParty

5

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

NamedCheckParty

6

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

MessageDeliveryType

Possible enumeration values:

NameValueDescription
Email

1

The Approval Process link will be sent via email.

Text

2

The Approval Process link will be sent via text message.

DisplayOtherPartyInfo

NameDescriptionTypeRequired*Additional information
Name

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

string Yes
Role

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

ApprovalRequestPartyRole No
Amount

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

decimal number No

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

PaymentMethodType

Possible enumeration values:

NameValueDescription
BankAccount

1

Bank account payment method.

Check

2

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

VirtualCard

3

Virtual card payment method.

PushToCard

4

Push to card payment method.

MailingAddress

NameDescriptionTypeRequired*Additional information
CompanyContactInformation

Address field for additional company or contact information such as department or title. This applies to company accounts only.

string No
Attention

For payment method of check, the Attention line to provide additional identifying information for the recipient. For a company, the contact name will be used.

string No
Address

Address to which the check will be mailed.

string Yes
Address2

Address Line 2 to which the check will be mailed.

string No
City

The city to which the check will be mailed.

string Yes
State

The state to which the check will be mailed.

string Yes
Zip

The zip code to which the check will be mailed.

string Yes

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

PartyCheckProperties

NameDescriptionTypeRequired*Additional information
Memo

Check memo line text.

string No
MailDeliveryType

Defines the mailing method that will be used for the check. If absent, default value will be Standard.

MailDeliveryType No
CustomPayToName

Name of Person or company that is the recipient of the check that is different that the name on an AccountID. System will use 'CustomPayToName' as the first name or only name on a check when provided.

string No

optional, Max 240 characters

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

MailDeliveryType

Possible enumeration values:

NameValueDescription
Standard

1

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

NextDay

2

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

ApprovalRequestPartyExtendedParameters

Parameter Description Type Additional Information
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.
DocumentUrl URL for the support documentation for the claim payment. String. Up to 250 characters. The document will be displayed to the party via the web. If the party is sent a check fulfilled by One Inc, the pdf will be sent with the mailed check; the pdf should be limited to four (4) pages in length. If the pdf exceeds the allowable length, the mailing of the check will fail. For the ProcessType of IssueCheck the DocumentUrl should be sent for the MailToCheckParty.
ValidationRules JSON with validation rules String. Up to 5000 characters. Example: [{"Name":"Phone(without formatting)","Type":2,"MinLength":9,"MaxLength":11,"ExpectedValue":"123456789"}]. Type: 0 - Undefined, 1 - Numeric, 2 - Alphanumeric, 3 - Date
ContactOptions JSON with contact options String. Up to 5000 characters. Example: [{"ContactOptionMethod":"phone","ContactOptionValue":"1234567890"}]

ComposeCheckProperties

NameDescriptionTypeRequired*Additional information
PayToAccountId

AccountId of person or company that is named on the check.

integer No

Required for IssueCheckPayment.

AdditionalPayToParties

AccountId of additional persons or companies that will be listed as additional recipients on the check. Each name must be preceded with either AND or OR.

Collection of AdditionalPayToParty No

Max number of additional pay to parties is 3.

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

AdditionalPayToParty

NameDescriptionTypeRequired*Additional information
Separator

Merge operator for additional persons or companies.

Separator No

Allowable values: AND, OR

AccountId

AccountId of additional persons or companies.

integer No

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

Separator

Possible enumeration values:

NameValueDescription
And

1

Separator value of "And".

Or

2

Separator value of "Or".

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": "claim-321",
  "TotalAmount": 1.0,
  "ProcessType": "SinglePartyPayment",
  "IsAuthorityHold": false,
  "ClaimDetails": [
    "Claim detail",
    "Single Party Payment",
    "$1.0"
  ],
  "AccountGroupCode": "Default",
  "ApprovalRequestParties": [
    {
      "AccountId": 9,
      "ContactId": 6,
      "ExternalIndividualId": null,
      "ExternalCompanyContactId": null,
      "ApprovalRole": "PaymentOnly",
      "LinkDeliveryType": "Email",
      "PhoneNumber": "9163520995",
      "EmailAddress": "[email protected]",
      "PaymentAmount": 1.0,
      "DisplayOtherPartiesInfo": null,
      "PaymentMethodType": null,
      "Token": null,
      "Address": {
        "CompanyContactInformation": null,
        "Attention": "Corporate Trust Dept.",
        "Address": "123 Main St.",
        "Address2": null,
        "City": "Folsom",
        "State": "CA",
        "Zip": "95630"
      },
      "PartyCheckProperties": null,
      "ExtendedParameters": null,
      "BypassVendorNetwork": null
    }
  ],
  "ComposeCheckProperties": null,
  "ExtendedParameters": null,
  "ClaimsPayAuthenticationKey": "85A30B5B - D895 - 4185 - BD28 - 5644CB46F934"
}
                                
                                 <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">85A30B5B - D895 - 4185 - BD28 - 5644CB46F934</ClaimsPayAuthenticationKey>
  <AccountGroupCode>Default</AccountGroupCode>
  <ApprovalRequestParties>
    <ApprovalRequestParty>
      <AccountId>9</AccountId>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
        <d4p1:Address>123 Main St.</d4p1:Address>
        <d4p1:Address2 i:nil="true" />
        <d4p1:Attention>Corporate Trust Dept.</d4p1:Attention>
        <d4p1:City>Folsom</d4p1:City>
        <d4p1:CompanyContactInformation i:nil="true" />
        <d4p1:State>CA</d4p1:State>
        <d4p1:Zip>95630</d4p1:Zip>
      </Address>
      <ApprovalRole>PaymentOnly</ApprovalRole>
      <BypassVendorNetwork i:nil="true" />
      <ContactId>6</ContactId>
      <DisplayOtherPartiesInfo i:nil="true" />
      <EmailAddress>[email protected]</EmailAddress>
      <ExtendedParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <ExternalCompanyContactId i:nil="true" />
      <ExternalIndividualId i:nil="true" />
      <LinkDeliveryType>Email</LinkDeliveryType>
      <PartyCheckProperties i:nil="true" />
      <PaymentAmount>1</PaymentAmount>
      <PaymentMethodType i:nil="true" />
      <PhoneNumber>9163520995</PhoneNumber>
      <Token i:nil="true" />
    </ApprovalRequestParty>
  </ApprovalRequestParties>
  <ClaimDetails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Claim detail</d2p1:string>
    <d2p1:string>Single Party Payment</d2p1:string>
    <d2p1:string>$1.0</d2p1:string>
  </ClaimDetails>
  <ClaimNumber>claim-321</ClaimNumber>
  <ComposeCheckProperties i:nil="true" />
  <ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <IsAuthorityHold>false</IsAuthorityHold>
  <ProcessType>SinglePartyPayment</ProcessType>
  <TotalAmount>1</TotalAmount>
</CreateApprovalRequestRequest>
 
                                
                                 {
  "ClaimNumber": "C12345",
  "TotalAmount": 84002.00,
  "ProcessType": "MultiPartyPayment",
  "IsAuthorityHold": false,
  "ClaimDetails": [
    "Claim detail1",
    "Claim detail2"
  ],
  "AccountGroupCode": "Default",
  "ApprovalRequestParties": [
    {
      "AccountId": 8,
      "ContactId": 5,
      "ExternalIndividualId": null,
      "ExternalCompanyContactId": null,
      "ApprovalRole": "PaymentOnly",
      "LinkDeliveryType": "Email",
      "PhoneNumber": "11234543210",
      "EmailAddress": "[email protected]",
      "PaymentAmount": 80001.00,
      "DisplayOtherPartiesInfo": null,
      "PaymentMethodType": null,
      "Token": null,
      "Address": null,
      "PartyCheckProperties": null,
      "ExtendedParameters": null,
      "BypassVendorNetwork": null
    },
    {
      "AccountId": 7,
      "ContactId": 4,
      "ExternalIndividualId": null,
      "ExternalCompanyContactId": null,
      "ApprovalRole": "ApprovalAndPayment",
      "LinkDeliveryType": "Email",
      "PhoneNumber": "11234543210",
      "EmailAddress": "[email protected]",
      "PaymentAmount": 4001.00,
      "DisplayOtherPartiesInfo": [
        {
          "Name": "Janeth Smith",
          "Role": "PaymentOnly",
          "Amount": 3.0
        },
        {
          "Name": "Michael Brown",
          "Role": "ApprovalOnly",
          "Amount": null
        }
      ],
      "PaymentMethodType": null,
      "Token": null,
      "Address": null,
      "PartyCheckProperties": null,
      "ExtendedParameters": null,
      "BypassVendorNetwork": null
    }
  ],
  "ComposeCheckProperties": null,
  "ExtendedParameters": null,
  "ClaimsPayAuthenticationKey": "1C3E8A1F-7E02-4195-8AD6-26EBA384F7B2"
}
                                
                                 <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">1C3E8A1F-7E02-4195-8AD6-26EBA384F7B2</ClaimsPayAuthenticationKey>
  <AccountGroupCode>Default</AccountGroupCode>
  <ApprovalRequestParties>
    <ApprovalRequestParty>
      <AccountId>8</AccountId>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts" i:nil="true" />
      <ApprovalRole>PaymentOnly</ApprovalRole>
      <BypassVendorNetwork i:nil="true" />
      <ContactId>5</ContactId>
      <DisplayOtherPartiesInfo i:nil="true" />
      <EmailAddress>[email protected]</EmailAddress>
      <ExtendedParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <ExternalCompanyContactId i:nil="true" />
      <ExternalIndividualId i:nil="true" />
      <LinkDeliveryType>Email</LinkDeliveryType>
      <PartyCheckProperties i:nil="true" />
      <PaymentAmount>80001.00</PaymentAmount>
      <PaymentMethodType i:nil="true" />
      <PhoneNumber>11234543210</PhoneNumber>
      <Token i:nil="true" />
    </ApprovalRequestParty>
    <ApprovalRequestParty>
      <AccountId>7</AccountId>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts" i:nil="true" />
      <ApprovalRole>ApprovalAndPayment</ApprovalRole>
      <BypassVendorNetwork i:nil="true" />
      <ContactId>4</ContactId>
      <DisplayOtherPartiesInfo>
        <DisplayOtherPartyInfo>
          <Amount>3.0</Amount>
          <Name>Janeth Smith</Name>
          <Role>PaymentOnly</Role>
        </DisplayOtherPartyInfo>
        <DisplayOtherPartyInfo>
          <Amount i:nil="true" />
          <Name>Michael Brown</Name>
          <Role>ApprovalOnly</Role>
        </DisplayOtherPartyInfo>
      </DisplayOtherPartiesInfo>
      <EmailAddress>[email protected]</EmailAddress>
      <ExtendedParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <ExternalCompanyContactId i:nil="true" />
      <ExternalIndividualId i:nil="true" />
      <LinkDeliveryType>Email</LinkDeliveryType>
      <PartyCheckProperties i:nil="true" />
      <PaymentAmount>4001.00</PaymentAmount>
      <PaymentMethodType i:nil="true" />
      <PhoneNumber>11234543210</PhoneNumber>
      <Token i:nil="true" />
    </ApprovalRequestParty>
  </ApprovalRequestParties>
  <ClaimDetails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Claim detail1</d2p1:string>
    <d2p1:string>Claim detail2</d2p1:string>
  </ClaimDetails>
  <ClaimNumber>C12345</ClaimNumber>
  <ComposeCheckProperties i:nil="true" />
  <ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <IsAuthorityHold>false</IsAuthorityHold>
  <ProcessType>MultiPartyPayment</ProcessType>
  <TotalAmount>84002.00</TotalAmount>
</CreateApprovalRequestRequest>
 
                                
                                 {
  "ClaimNumber": "claim-123",
  "TotalAmount": 0.0,
  "ProcessType": "SinglePartySave",
  "IsAuthorityHold": false,
  "ClaimDetails": null,
  "AccountGroupCode": "Default",
  "ApprovalRequestParties": [
    {
      "AccountId": 9,
      "ContactId": null,
      "ExternalIndividualId": null,
      "ExternalCompanyContactId": null,
      "ApprovalRole": "PaymentOnly",
      "LinkDeliveryType": "Email",
      "PhoneNumber": "9163520995",
      "EmailAddress": "[email protected]",
      "PaymentAmount": 0.0,
      "DisplayOtherPartiesInfo": null,
      "PaymentMethodType": null,
      "Token": null,
      "Address": {
        "CompanyContactInformation": null,
        "Attention": "Corporate Trust Dept.",
        "Address": "123 Main St.",
        "Address2": null,
        "City": "Folsom",
        "State": "CA",
        "Zip": "95630"
      },
      "PartyCheckProperties": null,
      "ExtendedParameters": null,
      "BypassVendorNetwork": null
    }
  ],
  "ComposeCheckProperties": null,
  "ExtendedParameters": null,
  "ClaimsPayAuthenticationKey": "85A30B5B-D895-4185-BD28-5644CB46F934"
}
                                
                                 <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">85A30B5B-D895-4185-BD28-5644CB46F934</ClaimsPayAuthenticationKey>
  <AccountGroupCode>Default</AccountGroupCode>
  <ApprovalRequestParties>
    <ApprovalRequestParty>
      <AccountId>9</AccountId>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
        <d4p1:Address>123 Main St.</d4p1:Address>
        <d4p1:Address2 i:nil="true" />
        <d4p1:Attention>Corporate Trust Dept.</d4p1:Attention>
        <d4p1:City>Folsom</d4p1:City>
        <d4p1:CompanyContactInformation i:nil="true" />
        <d4p1:State>CA</d4p1:State>
        <d4p1:Zip>95630</d4p1:Zip>
      </Address>
      <ApprovalRole>PaymentOnly</ApprovalRole>
      <BypassVendorNetwork i:nil="true" />
      <ContactId i:nil="true" />
      <DisplayOtherPartiesInfo i:nil="true" />
      <EmailAddress>[email protected]</EmailAddress>
      <ExtendedParameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <ExternalCompanyContactId i:nil="true" />
      <ExternalIndividualId i:nil="true" />
      <LinkDeliveryType>Email</LinkDeliveryType>
      <PartyCheckProperties i:nil="true" />
      <PaymentAmount>0</PaymentAmount>
      <PaymentMethodType i:nil="true" />
      <PhoneNumber>9163520995</PhoneNumber>
      <Token i:nil="true" />
    </ApprovalRequestParty>
  </ApprovalRequestParties>
  <ClaimDetails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <ClaimNumber>claim-123</ClaimNumber>
  <ComposeCheckProperties i:nil="true" />
  <ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <IsAuthorityHold>false</IsAuthorityHold>
  <ProcessType>SinglePartySave</ProcessType>
  <TotalAmount>0</TotalAmount>
</CreateApprovalRequestRequest>

Response Information

CreateApprovalRequestResponse

NameDescriptionTypeRequired*Additional information
ApprovalRequestId

Unique identifier for the approval request.

integer No
CreationDate

Date the approval request was created.

date No
ExpirationDate

Date the approval request will expire.

date No
TimeZone

Approval request time zone.

string No
ProcessType

The process type for the approval request.

string
Process Type Values
No
AccountGroupCode

The account group code of created approval request.

string No
Status

The status of the approval request process.

ApprovalRequestStatus No
ApprovalRequestParties

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

Collection of ApprovalRequestPartySummary No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

ApprovalRequestStatus

Possible enumeration values:

NameValueDescription
Initiated

1

The approval process has been initiated.

Completed

2

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

Rejected

3

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

Cancelled

4

The approval request has been canceled.

Expired

5

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

Incomplete

6

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

AuthorityHold

7

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

ApprovalRequestPartySummary

NameDescriptionTypeRequired*Additional information
ApprovalRequestPartyId

ClaimsPay Approval Request Party Identifier.

integer No
AccountId

ClaimsPay Account Identifier.

integer No
ContactId

Company Contact identifier. Only applicable to company accounts.

integer No
EmailAddress

The email address to which the approval email was sent.

string No
PhoneNumber

The Phone Number to which the approval text message was sent.

string No
Status

Status of the approval action for the claim party.

ApprovalRequestPartyStatus No

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

ApprovalRequestPartyStatus

Possible enumeration values:

NameValueDescription
Initiated

1

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

FailedWelcomeCommunication

2

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

WebsiteAccessBlocked

3

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

Rejected

4

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

WaitingForOtherParties

5

The claim party completed the actions required for their role.

Completed

6

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

PaymentIncomplete

7

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

PaymentScheduled

8

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

AuthorityHold

9

Approval process is on hold and party actions have not yet been initiated.

Response Formats

{
  "ApprovalRequestId": 12,
  "CreationDate": "2020-10-27T04:59:45",
  "ExpirationDate": "2020-10-28T16:59:45",
  "TimeZone": "Pacific",
  "ProcessType": "SinglePartyPayment",
  "AccountGroupCode": null,
  "Status": "Initiated",
  "ApprovalRequestParties": [
    {
      "ApprovalRequestPartyId": 169,
      "AccountId": 9,
      "ContactId": 6,
      "EmailAddress": "[email protected]",
      "PhoneNumber": "9163520995",
      "Status": "Initiated"
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": "Success"
}
<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">Success</ResponseMessage>
  <AccountGroupCode i:nil="true" />
  <ApprovalRequestId>12</ApprovalRequestId>
  <ApprovalRequestParties>
    <ApprovalRequestPartySummary>
      <AccountId>9</AccountId>
      <ApprovalRequestPartyId>169</ApprovalRequestPartyId>
      <ContactId>6</ContactId>
      <EmailAddress>[email protected]</EmailAddress>
      <PhoneNumber>9163520995</PhoneNumber>
      <Status>Initiated</Status>
    </ApprovalRequestPartySummary>
  </ApprovalRequestParties>
  <CreationDate>2020-10-27T04:59:45.9173338-07:00</CreationDate>
  <ExpirationDate>2020-10-28T16:59:45.9173338-07:00</ExpirationDate>
  <ProcessType>SinglePartyPayment</ProcessType>
  <Status>Initiated</Status>
  <TimeZone>Pacific</TimeZone>
</CreateApprovalRequestResponse>
{
  "ApprovalRequestId": 163,
  "CreationDate": "2020-10-27T04:59:45",
  "ExpirationDate": "2020-10-28T16:59:45",
  "TimeZone": "Pacific",
  "ProcessType": "MultiPartyPayment",
  "AccountGroupCode": "Default",
  "Status": "Initiated",
  "ApprovalRequestParties": [
    {
      "ApprovalRequestPartyId": 4,
      "AccountId": 8,
      "ContactId": 5,
      "EmailAddress": "[email protected]",
      "PhoneNumber": "11234543210",
      "Status": "Initiated"
    },
    {
      "ApprovalRequestPartyId": 278,
      "AccountId": 10,
      "ContactId": null,
      "EmailAddress": "[email protected]",
      "PhoneNumber": "11234543210",
      "Status": "Initiated"
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": "Success"
}
<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">Success</ResponseMessage>
  <AccountGroupCode>Default</AccountGroupCode>
  <ApprovalRequestId>163</ApprovalRequestId>
  <ApprovalRequestParties>
    <ApprovalRequestPartySummary>
      <AccountId>8</AccountId>
      <ApprovalRequestPartyId>4</ApprovalRequestPartyId>
      <ContactId>5</ContactId>
      <EmailAddress>[email protected]</EmailAddress>
      <PhoneNumber>11234543210</PhoneNumber>
      <Status>Initiated</Status>
    </ApprovalRequestPartySummary>
    <ApprovalRequestPartySummary>
      <AccountId>10</AccountId>
      <ApprovalRequestPartyId>278</ApprovalRequestPartyId>
      <ContactId i:nil="true" />
      <EmailAddress>[email protected]</EmailAddress>
      <PhoneNumber>11234543210</PhoneNumber>
      <Status>Initiated</Status>
    </ApprovalRequestPartySummary>
  </ApprovalRequestParties>
  <CreationDate>2020-10-27T04:59:45.9173338-07:00</CreationDate>
  <ExpirationDate>2020-10-28T16:59:45.9173338-07:00</ExpirationDate>
  <ProcessType>MultiPartyPayment</ProcessType>
  <Status>Initiated</Status>
  <TimeZone>Pacific</TimeZone>
</CreateApprovalRequestResponse>
{
  "ApprovalRequestId": 12,
  "CreationDate": "2020-10-27T04:59:45",
  "ExpirationDate": "2020-10-28T16:59:45",
  "TimeZone": "Pacific",
  "ProcessType": "SinglePartySave",
  "AccountGroupCode": null,
  "Status": "Initiated",
  "ApprovalRequestParties": [
    {
      "ApprovalRequestPartyId": 169,
      "AccountId": 9,
      "ContactId": 6,
      "EmailAddress": "[email protected]",
      "PhoneNumber": "9163520995",
      "Status": "Initiated"
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": "Success"
}
<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">Success</ResponseMessage>
  <AccountGroupCode i:nil="true" />
  <ApprovalRequestId>12</ApprovalRequestId>
  <ApprovalRequestParties>
    <ApprovalRequestPartySummary>
      <AccountId>9</AccountId>
      <ApprovalRequestPartyId>169</ApprovalRequestPartyId>
      <ContactId>6</ContactId>
      <EmailAddress>[email protected]</EmailAddress>
      <PhoneNumber>9163520995</PhoneNumber>
      <Status>Initiated</Status>
    </ApprovalRequestPartySummary>
  </ApprovalRequestParties>
  <CreationDate>2020-10-27T04:59:45.9173338-07:00</CreationDate>
  <ExpirationDate>2020-10-28T16:59:45.9173338-07:00</ExpirationDate>
  <ProcessType>SinglePartySave</ProcessType>
  <Status>Initiated</Status>
  <TimeZone>Pacific</TimeZone>
</CreateApprovalRequestResponse>

POST api/ApprovalRequest/GetById

This method is used to get approval request by id.

MethodEndpoint
GetById https://stgportalone.processonepayments.com/ClaimsPay/api/ApprovalRequest/GetById

GetApprovalRequestByIdRequest

NameDescriptionTypeRequired*Additional information
ApprovalRequestId

Unique identifier for the Approval request.

integer Yes
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

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

NameDescriptionTypeRequired*Additional information
ApprovalRequestId

Unique identifier for the approval request.

integer No
ClaimNumber

Claim number associated to the approval request.

string No
Status

The status of the approval request.

ApprovalRequestStatus No
CreationDate

Date the approval request was initiated.

date No
ExpirationDate

The expiration date of the approval request.

date No
TimeZone

Approval request time zone.

string No
ProcessType

The process type for the approval request.

string
Process Type Values
No
IsAuthorityHold

Indicates if the approval request was created with an Authority Hold which requires the approval request to be released prior to initiating the payment process to the approval request parties.

boolean No
AccountGroupCode

The account group code of the approval request.

string No
ApprovalRequestPartiesInfo

Information on each of the approval request party.

Collection of ApprovalRequestPartyInfo No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

ApprovalRequestPartyInfo

NameDescriptionTypeRequired*Additional information
ApprovalRequestPartyId

Claims pay approval request party identifier.

integer No
AccountId

Claims pay account identifier.

integer No
ContactId

Company contact identifier. Only applicable to company accounts.

integer No
EmailAddress

The email address to which the approval email was sent.

string No
PhoneNumber

The Phone Number to which the approval text message was sent.

string No
FullName

First and Last name of the approval request party.

string No
CompanyName

Company name if the ClaimsPayAccountType is Company.

string No
Status

The status of the approval request party.

ApprovalRequestPartyStatus No
DisputeComment

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

string No
PaymentSummary

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

PaymentSummary No

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

PaymentSummary

NameDescriptionTypeRequired*Additional information
CheckSummary

Check summary information that was saved with the Approval Request.

CheckSummary No
MailingAddress

Selected mailing address for check.

MailingAddress No
BankAccountSummary

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

BankAccountSummary No
CardInfo

Card summary information that was saved with the Approval request.

CardInfo No
PaymentMethodType

Selected payment method type.

PaymentMethodType No
TransactionSummary

Payment processing information.

TransactionSummary No

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

CheckSummary

NameDescriptionTypeRequired*Additional information
PayTo

Name(s) on the check.

string No
CheckMemo

Check Memo.

string No
CheckStubData

Information that was printed on the check stub.

Collection of string No
DocumentUrl

The URL of the the pdf to be printed and mailed with the check if it was provided for the check payment.

string No
MailDeliveryType

Defines the mailing method that was used for the check.

MailDeliveryType No
CheckFulfillmentOwner

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

CheckFulfillmentOwnerType No

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

CheckFulfillmentOwnerType

Possible enumeration values:

NameValueDescription
OneInc

1

Check fulfillment is owned by One Inc. When a payment is ready to be processed and the payment method is check an Issue Check transaction will be created for One Inc to fulfill the payment and the information will be returned to the source system.

Client

2

Check fulfillment is owned by the client. When a payment is ready to be processed and the payment method is check the information will be information to source system to complete the payment.

CardInfo

NameDescriptionTypeRequired*Additional information
Token

Card payment token.

string No
LastFourDigits

Last four digits of the card number.

string No
CardType

Card type.

CardType No
HolderName

Card holder name.

string No

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

TransactionSummary

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction identifier for the payment.

string No
TransactionDate

The date when transaction was executed.

date No
BatchNumber

ProcessOne BatchNumber or CheckBatchNumber.

integer No
PaymentProcessingStatus

The status of the claim party payment.

PaymentProcessingStatus No
PaymentResponseMessage

Information from the payment transaction.

string No

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

PaymentProcessingStatus

Possible enumeration values:

NameValueDescription
Successful

1

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

Failed

2

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

Skipped

3

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

Response Formats

{
  "ApprovalRequestId": 12,
  "ClaimNumber": "C12345",
  "Status": "Initiated",
  "CreationDate": "2020-10-27T04:59:45",
  "ExpirationDate": "2020-10-28T16:59:45",
  "TimeZone": "Pacific",
  "ProcessType": "MultiPartyPayment",
  "IsAuthorityHold": false,
  "AccountGroupCode": "Default",
  "ApprovalRequestPartiesInfo": [
    {
      "ApprovalRequestPartyId": 1,
      "AccountId": 123,
      "ContactId": 12,
      "EmailAddress": "[email protected]",
      "PhoneNumber": "555-0100",
      "FullName": "Janet Smith",
      "CompanyName": "Main Street Body Shop",
      "Status": "Completed",
      "DisputeComment": "Dispute comment",
      "PaymentSummary": {
        "CheckSummary": null,
        "MailingAddress": {
          "CompanyContactInformation": null,
          "Attention": "Corporate Trust Dept.",
          "Address": "123 Main St.",
          "Address2": null,
          "City": "Folsom",
          "State": "CA",
          "Zip": "95630"
        },
        "BankAccountSummary": {
          "Token": "9576cc6d-61e0-48ea-ae0c-9627d9cdd558",
          "AccountType": "Checking",
          "LastFourDigits": "1234",
          "BankName": "Test Bank",
          "NameOnAccount": "Janet Smith"
        },
        "CardInfo": {
          "Token": "498d3d81-25d7-4bab-9c5e-0ba363942f58",
          "LastFourDigits": "1234",
          "CardType": "Visa",
          "HolderName": "Janet Smith"
        },
        "PaymentMethodType": "VirtualCard",
        "TransactionSummary": {
          "TransactionId": "12345",
          "TransactionDate": "2020-10-27T04:59:52",
          "BatchNumber": 1,
          "PaymentProcessingStatus": "Successful",
          "PaymentResponseMessage": ""
        }
      }
    },
    {
      "ApprovalRequestPartyId": 2,
      "AccountId": 456,
      "ContactId": 34,
      "EmailAddress": "[email protected]",
      "PhoneNumber": "555-0100",
      "FullName": "Janet Smith",
      "CompanyName": "Main Street Body Shop",
      "Status": "Completed",
      "DisputeComment": "Dispute comment",
      "PaymentSummary": {
        "CheckSummary": null,
        "MailingAddress": {
          "CompanyContactInformation": null,
          "Attention": "Corporate Trust Dept.",
          "Address": "123 Main St.",
          "Address2": null,
          "City": "Folsom",
          "State": "CA",
          "Zip": "95630"
        },
        "BankAccountSummary": {
          "Token": "9576cc6d-61e0-48ea-ae0c-9627d9cdd558",
          "AccountType": "Checking",
          "LastFourDigits": "1234",
          "BankName": "Test Bank",
          "NameOnAccount": "Janet Smith"
        },
        "CardInfo": {
          "Token": "498d3d81-25d7-4bab-9c5e-0ba363942f58",
          "LastFourDigits": "1234",
          "CardType": "Visa",
          "HolderName": "Janet Smith"
        },
        "PaymentMethodType": "BankAccount",
        "TransactionSummary": {
          "TransactionId": "12345",
          "TransactionDate": "2020-10-27T04:59:52",
          "BatchNumber": 1,
          "PaymentProcessingStatus": "Successful",
          "PaymentResponseMessage": ""
        }
      }
    },
    {
      "ApprovalRequestPartyId": 3,
      "AccountId": 789,
      "ContactId": 78,
      "EmailAddress": "[email protected]",
      "PhoneNumber": "555-0100",
      "FullName": "Janet Smith",
      "CompanyName": "Main Street Body Shop",
      "Status": "Completed",
      "DisputeComment": "Dispute comment",
      "PaymentSummary": {
        "CheckSummary": {
          "PayTo": "Main Street Body Shop",
          "CheckMemo": "Claim Payment 12345",
          "CheckStubData": [
            "Claim Number",
            "C12345",
            "Claim details"
          ],
          "DocumentUrl": "https://testsite.com/Document?FileName=test.pdf",
          "MailDeliveryType": "NextDay",
          "CheckFulfillmentOwner": "OneInc"
        },
        "MailingAddress": {
          "CompanyContactInformation": null,
          "Attention": "Corporate Trust Dept.",
          "Address": "123 Main St.",
          "Address2": null,
          "City": "Folsom",
          "State": "CA",
          "Zip": "95630"
        },
        "BankAccountSummary": null,
        "CardInfo": null,
        "PaymentMethodType": "Check",
        "TransactionSummary": {
          "TransactionId": "12345",
          "TransactionDate": "2020-10-27T04:59:52",
          "BatchNumber": 1,
          "PaymentProcessingStatus": "Successful",
          "PaymentResponseMessage": ""
        }
      }
    }
  ],
  "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>1</ApprovalRequestPartyId>
      <CompanyName>Main Street Body Shop</CompanyName>
      <ContactId>12</ContactId>
      <DisputeComment>Dispute comment</DisputeComment>
      <EmailAddress>[email protected]</EmailAddress>
      <FullName>Janet Smith</FullName>
      <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>9576cc6d-61e0-48ea-ae0c-9627d9cdd558</d4p1:Token>
        </d4p1:BankAccountSummary>
        <d4p1:CardInfo>
          <d4p1:CardType>Visa</d4p1:CardType>
          <d4p1:HolderName>Janet Smith</d4p1:HolderName>
          <d4p1:LastFourDigits>1234</d4p1:LastFourDigits>
          <d4p1:Token>498d3d81-25d7-4bab-9c5e-0ba363942f58</d4p1:Token>
        </d4p1:CardInfo>
        <d4p1:CheckSummary i:nil="true" />
        <d4p1:MailingAddress>
          <d4p1:Address>123 Main St.</d4p1:Address>
          <d4p1:Address2 i:nil="true" />
          <d4p1:Attention>Corporate Trust Dept.</d4p1:Attention>
          <d4p1:City>Folsom</d4p1:City>
          <d4p1:CompanyContactInformation i:nil="true" />
          <d4p1:State>CA</d4p1:State>
          <d4p1:Zip>95630</d4p1:Zip>
        </d4p1:MailingAddress>
        <d4p1:PaymentMethodType>VirtualCard</d4p1:PaymentMethodType>
        <d4p1:TransactionSummary>
          <d4p1:BatchNumber>1</d4p1:BatchNumber>
          <d4p1:PaymentProcessingStatus>Successful</d4p1:PaymentProcessingStatus>
          <d4p1:PaymentResponseMessage></d4p1:PaymentResponseMessage>
          <d4p1:TransactionDate>2020-10-27T04:59:52.1672582-07:00</d4p1:TransactionDate>
          <d4p1:TransactionId>12345</d4p1:TransactionId>
        </d4p1:TransactionSummary>
      </PaymentSummary>
      <PhoneNumber>555-0100</PhoneNumber>
      <Status>Completed</Status>
    </ApprovalRequestPartyInfo>
    <ApprovalRequestPartyInfo>
      <AccountId>456</AccountId>
      <ApprovalRequestPartyId>2</ApprovalRequestPartyId>
      <CompanyName>Main Street Body Shop</CompanyName>
      <ContactId>34</ContactId>
      <DisputeComment>Dispute comment</DisputeComment>
      <EmailAddress>[email protected]</EmailAddress>
      <FullName>Janet Smith</FullName>
      <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>9576cc6d-61e0-48ea-ae0c-9627d9cdd558</d4p1:Token>
        </d4p1:BankAccountSummary>
        <d4p1:CardInfo>
          <d4p1:CardType>Visa</d4p1:CardType>
          <d4p1:HolderName>Janet Smith</d4p1:HolderName>
          <d4p1:LastFourDigits>1234</d4p1:LastFourDigits>
          <d4p1:Token>498d3d81-25d7-4bab-9c5e-0ba363942f58</d4p1:Token>
        </d4p1:CardInfo>
        <d4p1:CheckSummary i:nil="true" />
        <d4p1:MailingAddress>
          <d4p1:Address>123 Main St.</d4p1:Address>
          <d4p1:Address2 i:nil="true" />
          <d4p1:Attention>Corporate Trust Dept.</d4p1:Attention>
          <d4p1:City>Folsom</d4p1:City>
          <d4p1:CompanyContactInformation i:nil="true" />
          <d4p1:State>CA</d4p1:State>
          <d4p1:Zip>95630</d4p1:Zip>
        </d4p1:MailingAddress>
        <d4p1:PaymentMethodType>BankAccount</d4p1:PaymentMethodType>
        <d4p1:TransactionSummary>
          <d4p1:BatchNumber>1</d4p1:BatchNumber>
          <d4p1:PaymentProcessingStatus>Successful</d4p1:PaymentProcessingStatus>
          <d4p1:PaymentResponseMessage></d4p1:PaymentResponseMessage>
          <d4p1:TransactionDate>2020-10-27T04:59:52.1672582-07:00</d4p1:TransactionDate>
          <d4p1:TransactionId>12345</d4p1:TransactionId>
        </d4p1:TransactionSummary>
      </PaymentSummary>
      <PhoneNumber>555-0100</PhoneNumber>
      <Status>Completed</Status>
    </ApprovalRequestPartyInfo>
    <ApprovalRequestPartyInfo>
      <AccountId>789</AccountId>
      <ApprovalRequestPartyId>3</ApprovalRequestPartyId>
      <CompanyName>Main Street Body Shop</CompanyName>
      <ContactId>78</ContactId>
      <DisputeComment>Dispute comment</DisputeComment>
      <EmailAddress>[email protected]</EmailAddress>
      <FullName>Janet Smith</FullName>
      <PaymentSummary xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
        <d4p1:BankAccountSummary i:nil="true" />
        <d4p1:CardInfo i:nil="true" />
        <d4p1:CheckSummary>
          <d4p1:CheckFulfillmentOwner>OneInc</d4p1:CheckFulfillmentOwner>
          <d4p1:CheckMemo>Claim Payment 12345</d4p1:CheckMemo>
          <d4p1:CheckStubData xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>Claim Number</d6p1:string>
            <d6p1:string>C12345</d6p1:string>
            <d6p1:string>Claim details</d6p1:string>
          </d4p1:CheckStubData>
          <d4p1:DocumentUrl>https://testsite.com/Document?FileName=test.pdf</d4p1:DocumentUrl>
          <d4p1:MailDeliveryType>NextDay</d4p1:MailDeliveryType>
          <d4p1:PayTo>Main Street Body Shop</d4p1:PayTo>
        </d4p1:CheckSummary>
        <d4p1:MailingAddress>
          <d4p1:Address>123 Main St.</d4p1:Address>
          <d4p1:Address2 i:nil="true" />
          <d4p1:Attention>Corporate Trust Dept.</d4p1:Attention>
          <d4p1:City>Folsom</d4p1:City>
          <d4p1:CompanyContactInformation i:nil="true" />
          <d4p1:State>CA</d4p1:State>
          <d4p1:Zip>95630</d4p1:Zip>
        </d4p1:MailingAddress>
        <d4p1:PaymentMethodType>Check</d4p1:PaymentMethodType>
        <d4p1:TransactionSummary>
          <d4p1:BatchNumber>1</d4p1:BatchNumber>
          <d4p1:PaymentProcessingStatus>Successful</d4p1:PaymentProcessingStatus>
          <d4p1:PaymentResponseMessage></d4p1:PaymentResponseMessage>
          <d4p1:TransactionDate>2020-10-27T04:59:52.1672582-07:00</d4p1:TransactionDate>
          <d4p1:TransactionId>12345</d4p1:TransactionId>
        </d4p1:TransactionSummary>
      </PaymentSummary>
      <PhoneNumber>555-0100</PhoneNumber>
      <Status>Completed</Status>
    </ApprovalRequestPartyInfo>
  </ApprovalRequestPartiesInfo>
  <ClaimNumber>C12345</ClaimNumber>
  <CreationDate>2020-10-27T04:59:45.9173338-07:00</CreationDate>
  <ExpirationDate>2020-10-28T16:59:45.9173338-07:00</ExpirationDate>
  <IsAuthorityHold>false</IsAuthorityHold>
  <ProcessType>MultiPartyPayment</ProcessType>
  <Status>Initiated</Status>
  <TimeZone>Pacific</TimeZone>
</GetApprovalRequestByIdResponse>

POST api/ApprovalRequest/GetByStatus

This method is used to get approval requests by status.

MethodEndpoint
GetByStatus https://stgportalone.processonepayments.com/ClaimsPay/api/ApprovalRequest/GetByStatus

GetApprovalRequestsByStatusRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKeys

Authentication keys to define the search query.

Collection of string No
Statuses

Approval Request statuses.

Collection of ApprovalRequestStatus No
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 No
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 No
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

Request Formats

 
                                
                                 {
  "AuthenticationKeys": [
    "Authentication Key"
  ],
  "Statuses": [
    "Initiated",
    "Expired",
    "Cancelled"
  ],
  "StartDate": "2020-10-24T04:59:52",
  "EndDate": "2020-10-27T04:59:52",
  "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>2020-10-27T04:59:52.9953912-07:00</EndDate>
  <StartDate>2020-10-24T04:59:52.9953912-07:00</StartDate>
  <Statuses>
    <ApprovalRequestStatus>Initiated</ApprovalRequestStatus>
    <ApprovalRequestStatus>Expired</ApprovalRequestStatus>
    <ApprovalRequestStatus>Cancelled</ApprovalRequestStatus>
  </Statuses>
</GetApprovalRequestsByStatusRequest>

Response Information

GetApprovalRequestsByStatusResponse

NameDescriptionTypeRequired*Additional information
ApprovalRequests

The result of get by status query.

Collection of ApprovalRequestSummary No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

ApprovalRequestSummary

NameDescriptionTypeRequired*Additional information
ApprovalRequestId

Unique identifier for the approval request.

integer No
ClaimNumber

Claim number associated to the approval request.

string No
Status

The status of the approval request.

ApprovalRequestStatus No
CreationDate

Date the approval request was initiated.

date No
ExpirationDate

Date the approval request will expire.

date No
TimeZone

Approval request time zone.

string No
ProcessType

The process type for the approval request.

string
Process Type Values
No
IsAuthorityHold

Indicates if the approval request was created with an Authority Hold which requires the approval request to be released prior to initiating the payment process to the approval request parties.

boolean No
AccountGroupCode

The account group code of the approval request.

string No
ApprovalRequestPartyInfos

Information about each Approval request party.

Collection of ApprovalRequestPartyInfo No

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

Response Formats

{
  "ApprovalRequests": [
    {
      "ApprovalRequestId": 12,
      "ClaimNumber": "C12345",
      "Status": "Initiated",
      "CreationDate": "2020-10-27T04:59:45",
      "ExpirationDate": "2020-10-28T16:59:45",
      "TimeZone": "Pacific",
      "ProcessType": "MultiPartyPayment",
      "IsAuthorityHold": false,
      "AccountGroupCode": "Default",
      "ApprovalRequestPartyInfos": [
        {
          "ApprovalRequestPartyId": 1,
          "AccountId": 123,
          "ContactId": 12,
          "EmailAddress": "[email protected]",
          "PhoneNumber": "555-0100",
          "FullName": "Janet Smith",
          "CompanyName": "Main Street Body Shop",
          "Status": "Completed",
          "DisputeComment": "Dispute comment",
          "PaymentSummary": {
            "CheckSummary": null,
            "MailingAddress": {
              "CompanyContactInformation": null,
              "Attention": "Corporate Trust Dept.",
              "Address": "123 Main St.",
              "Address2": null,
              "City": "Folsom",
              "State": "CA",
              "Zip": "95630"
            },
            "BankAccountSummary": {
              "Token": "9576cc6d-61e0-48ea-ae0c-9627d9cdd558",
              "AccountType": "Checking",
              "LastFourDigits": "1234",
              "BankName": "Test Bank",
              "NameOnAccount": "Janet Smith"
            },
            "CardInfo": {
              "Token": "498d3d81-25d7-4bab-9c5e-0ba363942f58",
              "LastFourDigits": "1234",
              "CardType": "Visa",
              "HolderName": "Janet Smith"
            },
            "PaymentMethodType": "VirtualCard",
            "TransactionSummary": {
              "TransactionId": "12345",
              "TransactionDate": "2020-10-27T04:59:53",
              "BatchNumber": 1,
              "PaymentProcessingStatus": "Successful",
              "PaymentResponseMessage": ""
            }
          }
        },
        {
          "ApprovalRequestPartyId": 2,
          "AccountId": 456,
          "ContactId": 34,
          "EmailAddress": "[email protected]",
          "PhoneNumber": "555-0100",
          "FullName": "Janet Smith",
          "CompanyName": "Main Street Body Shop",
          "Status": "Completed",
          "DisputeComment": "Dispute comment",
          "PaymentSummary": {
            "CheckSummary": null,
            "MailingAddress": {
              "CompanyContactInformation": null,
              "Attention": "Corporate Trust Dept.",
              "Address": "123 Main St.",
              "Address2": null,
              "City": "Folsom",
              "State": "CA",
              "Zip": "95630"
            },
            "BankAccountSummary": {
              "Token": "9576cc6d-61e0-48ea-ae0c-9627d9cdd558",
              "AccountType": "Checking",
              "LastFourDigits": "1234",
              "BankName": "Test Bank",
              "NameOnAccount": "Janet Smith"
            },
            "CardInfo": {
              "Token": "498d3d81-25d7-4bab-9c5e-0ba363942f58",
              "LastFourDigits": "1234",
              "CardType": "Visa",
              "HolderName": "Janet Smith"
            },
            "PaymentMethodType": "BankAccount",
            "TransactionSummary": {
              "TransactionId": "12345",
              "TransactionDate": "2020-10-27T04:59:53",
              "BatchNumber": 1,
              "PaymentProcessingStatus": "Successful",
              "PaymentResponseMessage": ""
            }
          }
        },
        {
          "ApprovalRequestPartyId": 3,
          "AccountId": 789,
          "ContactId": 78,
          "EmailAddress": "[email protected]",
          "PhoneNumber": "555-0100",
          "FullName": "Janet Smith",
          "CompanyName": "Main Street Body Shop",
          "Status": "Completed",
          "DisputeComment": "Dispute comment",
          "PaymentSummary": {
            "CheckSummary": {
              "PayTo": "Main Street Body Shop",
              "CheckMemo": "Claim Payment 12345",
              "CheckStubData": [
                "Claim Number",
                "C12345",
                "Claim details"
              ],
              "DocumentUrl": "https://testsite.com/Document?FileName=test.pdf",
              "MailDeliveryType": "NextDay",
              "CheckFulfillmentOwner": "OneInc"
            },
            "MailingAddress": {
              "CompanyContactInformation": null,
              "Attention": "Corporate Trust Dept.",
              "Address": "123 Main St.",
              "Address2": null,
              "City": "Folsom",
              "State": "CA",
              "Zip": "95630"
            },
            "BankAccountSummary": null,
            "CardInfo": null,
            "PaymentMethodType": "Check",
            "TransactionSummary": {
              "TransactionId": "12345",
              "TransactionDate": "2020-10-27T04:59:53",
              "BatchNumber": 1,
              "PaymentProcessingStatus": "Successful",
              "PaymentResponseMessage": ""
            }
          }
        }
      ]
    },
    {
      "ApprovalRequestId": 12,
      "ClaimNumber": "C12345",
      "Status": "Completed",
      "CreationDate": "2020-10-27T04:59:45",
      "ExpirationDate": "2020-10-28T16:59:45",
      "TimeZone": "Pacific",
      "ProcessType": "MultiPartyPayment",
      "IsAuthorityHold": false,
      "AccountGroupCode": "Default",
      "ApprovalRequestPartyInfos": [
        {
          "ApprovalRequestPartyId": 1,
          "AccountId": 123,
          "ContactId": 12,
          "EmailAddress": "[email protected]",
          "PhoneNumber": "555-0100",
          "FullName": "Janet Smith",
          "CompanyName": "Main Street Body Shop",
          "Status": "Completed",
          "DisputeComment": "Dispute comment",
          "PaymentSummary": {
            "CheckSummary": null,
            "MailingAddress": {
              "CompanyContactInformation": null,
              "Attention": "Corporate Trust Dept.",
              "Address": "123 Main St.",
              "Address2": null,
              "City": "Folsom",
              "State": "CA",
              "Zip": "95630"
            },
            "BankAccountSummary": {
              "Token": "9576cc6d-61e0-48ea-ae0c-9627d9cdd558",
              "AccountType": "Checking",
              "LastFourDigits": "1234",
              "BankName": "Test Bank",
              "NameOnAccount": "Janet Smith"
            },
            "CardInfo": {
              "Token": "498d3d81-25d7-4bab-9c5e-0ba363942f58",
              "LastFourDigits": "1234",
              "CardType": "Visa",
              "HolderName": "Janet Smith"
            },
            "PaymentMethodType": "VirtualCard",
            "TransactionSummary": {
              "TransactionId": "12345",
              "TransactionDate": "2020-10-27T04:59:53",
              "BatchNumber": 1,
              "PaymentProcessingStatus": "Successful",
              "PaymentResponseMessage": ""
            }
          }
        },
        {
          "ApprovalRequestPartyId": 2,
          "AccountId": 456,
          "ContactId": 34,
          "EmailAddress": "[email protected]",
          "PhoneNumber": "555-0100",
          "FullName": "Janet Smith",
          "CompanyName": "Main Street Body Shop",
          "Status": "Completed",
          "DisputeComment": "Dispute comment",
          "PaymentSummary": {
            "CheckSummary": null,
            "MailingAddress": {
              "CompanyContactInformation": null,
              "Attention": "Corporate Trust Dept.",
              "Address": "123 Main St.",
              "Address2": null,
              "City": "Folsom",
              "State": "CA",
              "Zip": "95630"
            },
            "BankAccountSummary": {
              "Token": "9576cc6d-61e0-48ea-ae0c-9627d9cdd558",
              "AccountType": "Checking",
              "LastFourDigits": "1234",
              "BankName": "Test Bank",
              "NameOnAccount": "Janet Smith"
            },
            "CardInfo": {
              "Token": "498d3d81-25d7-4bab-9c5e-0ba363942f58",
              "LastFourDigits": "1234",
              "CardType": "Visa",
              "HolderName": "Janet Smith"
            },
            "PaymentMethodType": "BankAccount",
            "TransactionSummary": {
              "TransactionId": "12345",
              "TransactionDate": "2020-10-27T04:59:53",
              "BatchNumber": 1,
              "PaymentProcessingStatus": "Successful",
              "PaymentResponseMessage": ""
            }
          }
        },
        {
          "ApprovalRequestPartyId": 3,
          "AccountId": 789,
          "ContactId": 78,
          "EmailAddress": "[email protected]",
          "PhoneNumber": "555-0100",
          "FullName": "Janet Smith",
          "CompanyName": "Main Street Body Shop",
          "Status": "Completed",
          "DisputeComment": "Dispute comment",
          "PaymentSummary": {
            "CheckSummary": {
              "PayTo": "Main Street Body Shop",
              "CheckMemo": "Claim Payment 12345",
              "CheckStubData": [
                "Claim Number",
                "C12345",
                "Claim details"
              ],
              "DocumentUrl": "https://testsite.com/Document?FileName=test.pdf",
              "MailDeliveryType": "NextDay",
              "CheckFulfillmentOwner": "OneInc"
            },
            "MailingAddress": {
              "CompanyContactInformation": null,
              "Attention": "Corporate Trust Dept.",
              "Address": "123 Main St.",
              "Address2": null,
              "City": "Folsom",
              "State": "CA",
              "Zip": "95630"
            },
            "BankAccountSummary": null,
            "CardInfo": null,
            "PaymentMethodType": "Check",
            "TransactionSummary": {
              "TransactionId": "12345",
              "TransactionDate": "2020-10-27T04:59:53",
              "BatchNumber": 1,
              "PaymentProcessingStatus": "Successful",
              "PaymentResponseMessage": ""
            }
          }
        }
      ]
    }
  ],
  "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>1</ApprovalRequestPartyId>
          <CompanyName>Main Street Body Shop</CompanyName>
          <ContactId>12</ContactId>
          <DisputeComment>Dispute comment</DisputeComment>
          <EmailAddress>[email protected]</EmailAddress>
          <FullName>Janet Smith</FullName>
          <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>9576cc6d-61e0-48ea-ae0c-9627d9cdd558</d6p1:Token>
            </d6p1:BankAccountSummary>
            <d6p1:CardInfo>
              <d6p1:CardType>Visa</d6p1:CardType>
              <d6p1:HolderName>Janet Smith</d6p1:HolderName>
              <d6p1:LastFourDigits>1234</d6p1:LastFourDigits>
              <d6p1:Token>498d3d81-25d7-4bab-9c5e-0ba363942f58</d6p1:Token>
            </d6p1:CardInfo>
            <d6p1:CheckSummary i:nil="true" />
            <d6p1:MailingAddress>
              <d6p1:Address>123 Main St.</d6p1:Address>
              <d6p1:Address2 i:nil="true" />
              <d6p1:Attention>Corporate Trust Dept.</d6p1:Attention>
              <d6p1:City>Folsom</d6p1:City>
              <d6p1:CompanyContactInformation i:nil="true" />
              <d6p1:State>CA</d6p1:State>
              <d6p1:Zip>95630</d6p1:Zip>
            </d6p1:MailingAddress>
            <d6p1:PaymentMethodType>VirtualCard</d6p1:PaymentMethodType>
            <d6p1:TransactionSummary>
              <d6p1:BatchNumber>1</d6p1:BatchNumber>
              <d6p1:PaymentProcessingStatus>Successful</d6p1:PaymentProcessingStatus>
              <d6p1:PaymentResponseMessage></d6p1:PaymentResponseMessage>
              <d6p1:TransactionDate>2020-10-27T04:59:53.0109899-07:00</d6p1:TransactionDate>
              <d6p1:TransactionId>12345</d6p1:TransactionId>
            </d6p1:TransactionSummary>
          </PaymentSummary>
          <PhoneNumber>555-0100</PhoneNumber>
          <Status>Completed</Status>
        </ApprovalRequestPartyInfo>
        <ApprovalRequestPartyInfo>
          <AccountId>456</AccountId>
          <ApprovalRequestPartyId>2</ApprovalRequestPartyId>
          <CompanyName>Main Street Body Shop</CompanyName>
          <ContactId>34</ContactId>
          <DisputeComment>Dispute comment</DisputeComment>
          <EmailAddress>[email protected]</EmailAddress>
          <FullName>Janet Smith</FullName>
          <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>9576cc6d-61e0-48ea-ae0c-9627d9cdd558</d6p1:Token>
            </d6p1:BankAccountSummary>
            <d6p1:CardInfo>
              <d6p1:CardType>Visa</d6p1:CardType>
              <d6p1:HolderName>Janet Smith</d6p1:HolderName>
              <d6p1:LastFourDigits>1234</d6p1:LastFourDigits>
              <d6p1:Token>498d3d81-25d7-4bab-9c5e-0ba363942f58</d6p1:Token>
            </d6p1:CardInfo>
            <d6p1:CheckSummary i:nil="true" />
            <d6p1:MailingAddress>
              <d6p1:Address>123 Main St.</d6p1:Address>
              <d6p1:Address2 i:nil="true" />
              <d6p1:Attention>Corporate Trust Dept.</d6p1:Attention>
              <d6p1:City>Folsom</d6p1:City>
              <d6p1:CompanyContactInformation i:nil="true" />
              <d6p1:State>CA</d6p1:State>
              <d6p1:Zip>95630</d6p1:Zip>
            </d6p1:MailingAddress>
            <d6p1:PaymentMethodType>BankAccount</d6p1:PaymentMethodType>
            <d6p1:TransactionSummary>
              <d6p1:BatchNumber>1</d6p1:BatchNumber>
              <d6p1:PaymentProcessingStatus>Successful</d6p1:PaymentProcessingStatus>
              <d6p1:PaymentResponseMessage></d6p1:PaymentResponseMessage>
              <d6p1:TransactionDate>2020-10-27T04:59:53.0109899-07:00</d6p1:TransactionDate>
              <d6p1:TransactionId>12345</d6p1:TransactionId>
            </d6p1:TransactionSummary>
          </PaymentSummary>
          <PhoneNumber>555-0100</PhoneNumber>
          <Status>Completed</Status>
        </ApprovalRequestPartyInfo>
        <ApprovalRequestPartyInfo>
          <AccountId>789</AccountId>
          <ApprovalRequestPartyId>3</ApprovalRequestPartyId>
          <CompanyName>Main Street Body Shop</CompanyName>
          <ContactId>78</ContactId>
          <DisputeComment>Dispute comment</DisputeComment>
          <EmailAddress>[email protected]</EmailAddress>
          <FullName>Janet Smith</FullName>
          <PaymentSummary xmlns:d6p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
            <d6p1:BankAccountSummary i:nil="true" />
            <d6p1:CardInfo i:nil="true" />
            <d6p1:CheckSummary>
              <d6p1:CheckFulfillmentOwner>OneInc</d6p1:CheckFulfillmentOwner>
              <d6p1:CheckMemo>Claim Payment 12345</d6p1:CheckMemo>
              <d6p1:CheckStubData xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>Claim Number</d8p1:string>
                <d8p1:string>C12345</d8p1:string>
                <d8p1:string>Claim details</d8p1:string>
              </d6p1:CheckStubData>
              <d6p1:DocumentUrl>https://testsite.com/Document?FileName=test.pdf</d6p1:DocumentUrl>
              <d6p1:MailDeliveryType>NextDay</d6p1:MailDeliveryType>
              <d6p1:PayTo>Main Street Body Shop</d6p1:PayTo>
            </d6p1:CheckSummary>
            <d6p1:MailingAddress>
              <d6p1:Address>123 Main St.</d6p1:Address>
              <d6p1:Address2 i:nil="true" />
              <d6p1:Attention>Corporate Trust Dept.</d6p1:Attention>
              <d6p1:City>Folsom</d6p1:City>
              <d6p1:CompanyContactInformation i:nil="true" />
              <d6p1:State>CA</d6p1:State>
              <d6p1:Zip>95630</d6p1:Zip>
            </d6p1:MailingAddress>
            <d6p1:PaymentMethodType>Check</d6p1:PaymentMethodType>
            <d6p1:TransactionSummary>
              <d6p1:BatchNumber>1</d6p1:BatchNumber>
              <d6p1:PaymentProcessingStatus>Successful</d6p1:PaymentProcessingStatus>
              <d6p1:PaymentResponseMessage></d6p1:PaymentResponseMessage>
              <d6p1:TransactionDate>2020-10-27T04:59:53.0109899-07:00</d6p1:TransactionDate>
              <d6p1:TransactionId>12345</d6p1:TransactionId>
            </d6p1:TransactionSummary>
          </PaymentSummary>
          <PhoneNumber>555-0100</PhoneNumber>
          <Status>Completed</Status>
        </ApprovalRequestPartyInfo>
      </ApprovalRequestPartyInfos>
      <ClaimNumber>C12345</ClaimNumber>
      <CreationDate>2020-10-27T04:59:45.9173338-07:00</CreationDate>
      <ExpirationDate>2020-10-28T16:59:45.9173338-07:00</ExpirationDate>
      <IsAuthorityHold>false</IsAuthorityHold>
      <ProcessType>MultiPartyPayment</ProcessType>
      <Status>Initiated</Status>
      <TimeZone>Pacific</TimeZone>
    </ApprovalRequestSummary>
    <ApprovalRequestSummary>
      <AccountGroupCode>Default</AccountGroupCode>
      <ApprovalRequestId>12</ApprovalRequestId>
      <ApprovalRequestPartyInfos>
        <ApprovalRequestPartyInfo>
          <AccountId>123</AccountId>
          <ApprovalRequestPartyId>1</ApprovalRequestPartyId>
          <CompanyName>Main Street Body Shop</CompanyName>
          <ContactId>12</ContactId>
          <DisputeComment>Dispute comment</DisputeComment>
          <EmailAddress>[email protected]</EmailAddress>
          <FullName>Janet Smith</FullName>
          <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>9576cc6d-61e0-48ea-ae0c-9627d9cdd558</d6p1:Token>
            </d6p1:BankAccountSummary>
            <d6p1:CardInfo>
              <d6p1:CardType>Visa</d6p1:CardType>
              <d6p1:HolderName>Janet Smith</d6p1:HolderName>
              <d6p1:LastFourDigits>1234</d6p1:LastFourDigits>
              <d6p1:Token>498d3d81-25d7-4bab-9c5e-0ba363942f58</d6p1:Token>
            </d6p1:CardInfo>
            <d6p1:CheckSummary i:nil="true" />
            <d6p1:MailingAddress>
              <d6p1:Address>123 Main St.</d6p1:Address>
              <d6p1:Address2 i:nil="true" />
              <d6p1:Attention>Corporate Trust Dept.</d6p1:Attention>
              <d6p1:City>Folsom</d6p1:City>
              <d6p1:CompanyContactInformation i:nil="true" />
              <d6p1:State>CA</d6p1:State>
              <d6p1:Zip>95630</d6p1:Zip>
            </d6p1:MailingAddress>
            <d6p1:PaymentMethodType>VirtualCard</d6p1:PaymentMethodType>
            <d6p1:TransactionSummary>
              <d6p1:BatchNumber>1</d6p1:BatchNumber>
              <d6p1:PaymentProcessingStatus>Successful</d6p1:PaymentProcessingStatus>
              <d6p1:PaymentResponseMessage></d6p1:PaymentResponseMessage>
              <d6p1:TransactionDate>2020-10-27T04:59:53.0109899-07:00</d6p1:TransactionDate>
              <d6p1:TransactionId>12345</d6p1:TransactionId>
            </d6p1:TransactionSummary>
          </PaymentSummary>
          <PhoneNumber>555-0100</PhoneNumber>
          <Status>Completed</Status>
        </ApprovalRequestPartyInfo>
        <ApprovalRequestPartyInfo>
          <AccountId>456</AccountId>
          <ApprovalRequestPartyId>2</ApprovalRequestPartyId>
          <CompanyName>Main Street Body Shop</CompanyName>
          <ContactId>34</ContactId>
          <DisputeComment>Dispute comment</DisputeComment>
          <EmailAddress>[email protected]</EmailAddress>
          <FullName>Janet Smith</FullName>
          <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>9576cc6d-61e0-48ea-ae0c-9627d9cdd558</d6p1:Token>
            </d6p1:BankAccountSummary>
            <d6p1:CardInfo>
              <d6p1:CardType>Visa</d6p1:CardType>
              <d6p1:HolderName>Janet Smith</d6p1:HolderName>
              <d6p1:LastFourDigits>1234</d6p1:LastFourDigits>
              <d6p1:Token>498d3d81-25d7-4bab-9c5e-0ba363942f58</d6p1:Token>
            </d6p1:CardInfo>
            <d6p1:CheckSummary i:nil="true" />
            <d6p1:MailingAddress>
              <d6p1:Address>123 Main St.</d6p1:Address>
              <d6p1:Address2 i:nil="true" />
              <d6p1:Attention>Corporate Trust Dept.</d6p1:Attention>
              <d6p1:City>Folsom</d6p1:City>
              <d6p1:CompanyContactInformation i:nil="true" />
              <d6p1:State>CA</d6p1:State>
              <d6p1:Zip>95630</d6p1:Zip>
            </d6p1:MailingAddress>
            <d6p1:PaymentMethodType>BankAccount</d6p1:PaymentMethodType>
            <d6p1:TransactionSummary>
              <d6p1:BatchNumber>1</d6p1:BatchNumber>
              <d6p1:PaymentProcessingStatus>Successful</d6p1:PaymentProcessingStatus>
              <d6p1:PaymentResponseMessage></d6p1:PaymentResponseMessage>
              <d6p1:TransactionDate>2020-10-27T04:59:53.0109899-07:00</d6p1:TransactionDate>
              <d6p1:TransactionId>12345</d6p1:TransactionId>
            </d6p1:TransactionSummary>
          </PaymentSummary>
          <PhoneNumber>555-0100</PhoneNumber>
          <Status>Completed</Status>
        </ApprovalRequestPartyInfo>
        <ApprovalRequestPartyInfo>
          <AccountId>789</AccountId>
          <ApprovalRequestPartyId>3</ApprovalRequestPartyId>
          <CompanyName>Main Street Body Shop</CompanyName>
          <ContactId>78</ContactId>
          <DisputeComment>Dispute comment</DisputeComment>
          <EmailAddress>[email protected]</EmailAddress>
          <FullName>Janet Smith</FullName>
          <PaymentSummary xmlns:d6p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
            <d6p1:BankAccountSummary i:nil="true" />
            <d6p1:CardInfo i:nil="true" />
            <d6p1:CheckSummary>
              <d6p1:CheckFulfillmentOwner>OneInc</d6p1:CheckFulfillmentOwner>
              <d6p1:CheckMemo>Claim Payment 12345</d6p1:CheckMemo>
              <d6p1:CheckStubData xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>Claim Number</d8p1:string>
                <d8p1:string>C12345</d8p1:string>
                <d8p1:string>Claim details</d8p1:string>
              </d6p1:CheckStubData>
              <d6p1:DocumentUrl>https://testsite.com/Document?FileName=test.pdf</d6p1:DocumentUrl>
              <d6p1:MailDeliveryType>NextDay</d6p1:MailDeliveryType>
              <d6p1:PayTo>Main Street Body Shop</d6p1:PayTo>
            </d6p1:CheckSummary>
            <d6p1:MailingAddress>
              <d6p1:Address>123 Main St.</d6p1:Address>
              <d6p1:Address2 i:nil="true" />
              <d6p1:Attention>Corporate Trust Dept.</d6p1:Attention>
              <d6p1:City>Folsom</d6p1:City>
              <d6p1:CompanyContactInformation i:nil="true" />
              <d6p1:State>CA</d6p1:State>
              <d6p1:Zip>95630</d6p1:Zip>
            </d6p1:MailingAddress>
            <d6p1:PaymentMethodType>Check</d6p1:PaymentMethodType>
            <d6p1:TransactionSummary>
              <d6p1:BatchNumber>1</d6p1:BatchNumber>
              <d6p1:PaymentProcessingStatus>Successful</d6p1:PaymentProcessingStatus>
              <d6p1:PaymentResponseMessage></d6p1:PaymentResponseMessage>
              <d6p1:TransactionDate>2020-10-27T04:59:53.0109899-07:00</d6p1:TransactionDate>
              <d6p1:TransactionId>12345</d6p1:TransactionId>
            </d6p1:TransactionSummary>
          </PaymentSummary>
          <PhoneNumber>555-0100</PhoneNumber>
          <Status>Completed</Status>
        </ApprovalRequestPartyInfo>
      </ApprovalRequestPartyInfos>
      <ClaimNumber>C12345</ClaimNumber>
      <CreationDate>2020-10-27T04:59:45.9173338-07:00</CreationDate>
      <ExpirationDate>2020-10-28T16:59:45.9173338-07:00</ExpirationDate>
      <IsAuthorityHold>false</IsAuthorityHold>
      <ProcessType>MultiPartyPayment</ProcessType>
      <Status>Completed</Status>
      <TimeZone>Pacific</TimeZone>
    </ApprovalRequestSummary>
  </ApprovalRequests>
</GetApprovalRequestsByStatusResponse>

POST api/ApprovalRequest/Cancel

This method is used to cancel approval request.

MethodEndpoint
Cancel https://stgportalone.processonepayments.com/ClaimsPay/api/ApprovalRequest/Cancel

CancelApprovalRequestRequest

NameDescriptionTypeRequired*Additional information
ApprovalRequestId

Unique identifier for the Approval request.

integer Yes
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

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

NameDescriptionTypeRequired*Additional information
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

Response Formats

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

MethodEndpoint
Resend https://stgportalone.processonepayments.com/ClaimsPay/api/ApprovalRequest/Resend

ResendApprovalRequestRequest

NameDescriptionTypeRequired*Additional information
ApprovalRequestId

Unique identifier for the Approval request.

integer Yes
ResendParties

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

Collection of ResendApprovalRequestPartyInfo No
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

ResendApprovalRequestPartyInfo

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer Yes
ContactId

Company Contact identifier. Only applicable to company accounts.

integer No
LinkDeliveryType

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

MessageDeliveryType Yes
PhoneNumber

The verified (opted-in) phone number for the party to which the Multi-Payee Approval SMS messages will be sent. If DeliveryType is Text and it is not populated, SMS will be sent to the phone number stored for the AccountId or ContactId.

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

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

Request Formats

 
                                
                                 {
  "ApprovalRequestId": 12,
  "ResendParties": [
    {
      "AccountId": 123,
      "ContactId": 123,
      "LinkDeliveryType": "Email",
      "PhoneNumber": "555-0100",
      "EmailAddress": "[email protected]"
    }
  ],
  "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>[email protected]</EmailAddress>
      <LinkDeliveryType>Email</LinkDeliveryType>
      <PhoneNumber>555-0100</PhoneNumber>
    </ResendApprovalRequestPartyInfo>
  </ResendParties>
</ResendApprovalRequestRequest>

Response Information

ResendApprovalRequestResponse

NameDescriptionTypeRequired*Additional information
ApprovalRequestId

Unique identifier for the Approval request.

integer No
PartiesSummary

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

Collection of ResendApprovalRequestPartySummary No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

ResendApprovalRequestPartySummary

NameDescriptionTypeRequired*Additional information
ApprovalRequestPartyId

ClaimsPay Approval Request Party Identifier.

integer No
AccountId

ClaimsPay Account Identifier.

integer No
ContactId

Company Contact identifier. Only applicable to company accounts.

integer No
EmailAddress

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

string No
PhoneNumber

The Phone Number to which the approval text message will be sent.

string No
ResendStatus

Resend operation response code.

string No
ResponseMessage

Response message.

string No

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

Response Formats

{
  "ApprovalRequestId": 12,
  "PartiesSummary": [
    {
      "ApprovalRequestPartyId": 1234,
      "AccountId": 123,
      "ContactId": 123,
      "EmailAddress": "[email protected]",
      "PhoneNumber": "555-0100",
      "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>[email protected]</EmailAddress>
      <PhoneNumber>555-0100</PhoneNumber>
      <ResendStatus>Success</ResendStatus>
      <ResponseMessage></ResponseMessage>
    </ResendApprovalRequestPartySummary>
  </PartiesSummary>
</ResendApprovalRequestResponse>

POST api/ApprovalRequest/Release

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

MethodEndpoint
Release https://stgportalone.processonepayments.com/ClaimsPay/api/ApprovalRequest/Release

ReleaseApprovalRequestRequest

NameDescriptionTypeRequired*Additional information
ApprovalRequestId

Unique identifier for the Approval request.

integer Yes
ReleasedBy

User name of the authorized user that is releasing the Approval Request

string No

Max length: 20

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

Request Formats

 
                                
                                 {
  "ApprovalRequestId": 1,
  "ReleasedBy": "sample string 1",
  "ClaimsPayAuthenticationKey": "sample string 2"
}
                                
                                 <ReleaseApprovalRequestRequest 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">sample string 2</ClaimsPayAuthenticationKey>
  <ApprovalRequestId>1</ApprovalRequestId>
  <ReleasedBy>sample string 1</ReleasedBy>
</ReleaseApprovalRequestRequest>

Response Information

ReleaseApprovalRequestResponse

NameDescriptionTypeRequired*Additional information
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

Response Formats

{
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<ReleaseApprovalRequestResponse 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">sample string 1</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 2</ResponseMessage>
</ReleaseApprovalRequestResponse>

PrepaidCardAccount

POST api/PrepaidCardAccount/Load

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

MethodEndpoint
Load https://stgportalone.processonepayments.com/ClaimsPay/api/PrepaidCardAccount/Load

LoadPrepaidCardAccountRequest

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer Yes
ContactId

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

integer No
Amount

Amount of payment.

decimal number Yes
ClaimNumber

The claim number that is associated to the claim payment.

string No
ClaimDetails

Claim details which will be sent in the payment email.

string No
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 No
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 No
SourceUser

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

string No
AccountGroupCode

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

string No
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

Request Formats

 
                                
                                 {
  "AccountId": 123,
  "ContactId": 123,
  "Amount": 120.0,
  "ClaimNumber": "C12345",
  "ClaimDetails": "Claim details",
  "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>Claim details</ClaimDetails>
  <ClaimNumber>C12345</ClaimNumber>
  <ContactId>123</ContactId>
  <PrepaidCardReferenceNumber>12345</PrepaidCardReferenceNumber>
  <SourceUser>Janet Smith</SourceUser>
</LoadPrepaidCardAccountRequest>

Response Information

LoadPrepaidCardAccountResponse

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction identifier.

string No
TransactionDate

Transaction date and time.

date No
TimeZone

Transaction time zone.

string No
BatchNumber

Number of the batch.

integer No
PrepaidAccountBalance

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

decimal number No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

Response Formats

{
  "TransactionId": "12345",
  "TransactionDate": "2020-10-27T04:59:45",
  "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>2020-10-27T04:59:45</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.

MethodEndpoint
ReverseLoad https://stgportalone.processonepayments.com/ClaimsPay/api/PrepaidCardAccount/ReverseLoad

ReverseLoadPrepaidCardAccountRequest

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer Yes
TransactionId

Transaction identifier of load that is to be reversed.

string Yes
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

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

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction identifier of the reverse load operation.

string No
TransactionDate

Transaction date and time.

date No
TimeZone

Transaction time zone.

string No
BatchNumber

Number of the batch.

integer No
PrepaidAccountBalance

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

decimal number No
OriginalPrepaidAccountBalance

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

decimal number No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

Response Formats

{
  "TransactionId": "12345",
  "TransactionDate": "2020-10-27T04:59:45",
  "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>2020-10-27T04:59:45</TransactionDate>
  <TransactionId>12345</TransactionId>
</ReverseLoadPrepaidCardAccountResponse>

POST api/PrepaidCardAccount/DisburseFunds

This method is used to disburse funds from a prepaid card account. You can use DisbursementType.Ach or DisbursementType.Check

MethodEndpoint
DisburseFunds https://stgportalone.processonepayments.com/ClaimsPay/api/PrepaidCardAccount/DisburseFunds

DisburseFundsRequest

NameDescriptionTypeRequired*Additional information
TransactionId

Original Transaction identification which you would like to DisburseFunds

string No
Amount

Amount of the disbursement.

decimal number No
ClaimNumber

Claim number that will be associated to the payment.

string No
DisbursementType

Type of method to disburse funds.

DisbursementType No
BankAccountDetails

Bank Account details.

BankAccountDetails No
Token

Saved bank account token.

string No
SourceUser

Identifier/name of user who initiated the Disburse request

string No
AddressDetails

Details on the address to which the check should be mailed.

AddressDetails No
Contact

For Company AccountTypes only. For Company, the First and Last name of the ContactId who is initiating the action. Will be displayed in the outbound transaction report in the Contact Field

string No
Comment

Optional alphanumeric string

string No

If present, max field length 255, alpha numeric and special characters allowed

CheckMemo

Optional field contains information for a check

string No

If present, max field length 50

ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

DisbursementType

Possible enumeration values:

NameValueDescription
Undefined

0

Ach

1

disburse by bank account data

Check

2

disburse by check

AddressDetails

NameDescriptionTypeRequired*Additional information
Address1

string No
ContactName

string No
NameOnAccount

string No
City

string No
State

string No
Zip

string No

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

Request Formats

 
                                
                                 {
  "TransactionId": "sample string 1",
  "Amount": 2.0,
  "ClaimNumber": "sample string 3",
  "DisbursementType": "Undefined",
  "BankAccountDetails": {
    "RoutingNumber": "sample string 1",
    "AccountNumber": "sample string 2",
    "CustomerName": "sample string 3",
    "AccountType": "Checking"
  },
  "Token": "sample string 4",
  "SourceUser": "sample string 5",
  "AddressDetails": {
    "Address1": "sample string 1",
    "ContactName": "sample string 2",
    "NameOnAccount": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "Zip": "sample string 6"
  },
  "Contact": "sample string 6",
  "Comment": "sample string 7",
  "CheckMemo": "sample string 8",
  "ClaimsPayAuthenticationKey": "sample string 9"
}
                                
                                 <DisburseFundsRequest 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">sample string 9</ClaimsPayAuthenticationKey>
  <AddressDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:City>sample string 4</d2p1:City>
    <d2p1:ContactName>sample string 2</d2p1:ContactName>
    <d2p1:NameOnAccount>sample string 3</d2p1:NameOnAccount>
    <d2p1:State>sample string 5</d2p1:State>
    <d2p1:Zip>sample string 6</d2p1:Zip>
  </AddressDetails>
  <Amount>2</Amount>
  <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>
  <CheckMemo>sample string 8</CheckMemo>
  <ClaimNumber>sample string 3</ClaimNumber>
  <Comment>sample string 7</Comment>
  <Contact>sample string 6</Contact>
  <DisbursementType>Undefined</DisbursementType>
  <SourceUser>sample string 5</SourceUser>
  <Token>sample string 4</Token>
  <TransactionId>sample string 1</TransactionId>
</DisburseFundsRequest>

Response Information

DisburseFundsResponse

NameDescriptionTypeRequired*Additional information
PrepaidAccountBalance

Balance of the prepaid account after the disbursement has been completed.

decimal number No
TransactionId

Transaction identifier

string No
TransactionDate

Transaction date and time

date No
TimeZone

Transaction time zone.

string No
Address

Transaction address details.

AddressDetails No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

Response Formats

{
  "PrepaidAccountBalance": 1.0,
  "TransactionId": "sample string 1",
  "TransactionDate": "2020-10-27T04:59:56",
  "TimeZone": "sample string 2",
  "Address": {
    "Address1": "sample string 1",
    "ContactName": "sample string 2",
    "NameOnAccount": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "Zip": "sample string 6"
  },
  "ResponseCode": "sample string 3",
  "ResponseMessage": "sample string 4"
}
<DisburseFundsResponse 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">sample string 3</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 4</ResponseMessage>
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:City>sample string 4</d2p1:City>
    <d2p1:ContactName>sample string 2</d2p1:ContactName>
    <d2p1:NameOnAccount>sample string 3</d2p1:NameOnAccount>
    <d2p1:State>sample string 5</d2p1:State>
    <d2p1:Zip>sample string 6</d2p1:Zip>
  </Address>
  <PrepaidAccountBalance>1</PrepaidAccountBalance>
  <TimeZone>sample string 2</TimeZone>
  <TransactionDate>2020-10-27T04:59:56</TransactionDate>
  <TransactionId>sample string 1</TransactionId>
</DisburseFundsResponse>

PaymentMethod

POST api/PaymentMethod/Remove

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

MethodEndpoint
Remove https://stgportalone.processonepayments.com/ClaimsPay/api/PaymentMethod/Remove

RemovePaymentMethodRequest

NameDescriptionTypeRequired*Additional information
Token

Saved bank account token.

string Yes
AccountId

ClaimsPay Account Identifier.

integer Yes
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

Request Formats

 
                                
                                 {
  "Token": "67af2796-7186-4e84-9e4b-43068045b8ea",
  "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>67af2796-7186-4e84-9e4b-43068045b8ea</Token>
</RemovePaymentMethodRequest>

Response Information

RemovePaymentMethodResponse

NameDescriptionTypeRequired*Additional information
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

Response Formats

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

MethodEndpoint
Save https://stgportalone.processonepayments.com/ClaimsPay/api/PaymentMethod/Save

SavePaymentMethodRequest

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer Yes
ClaimNumber

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

string No
BankAccountDetails

Bank Account details.

BankAccountDetails Yes
BypassBankAccountValidation

Bypasses bank account validation.

boolean No
SourceUser

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

string No
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

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

NameDescriptionTypeRequired*Additional information
TimeZone

Transaction time zone.

string No
TokenCreationTime

Token creation date and time in merchant time zone.

date No
BankAccountSummary

Bank account summary information.

BankAccountSummary No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

Response Formats

{
  "TimeZone": "Pacific",
  "TokenCreationTime": "2020-10-27T04:59:57",
  "BankAccountSummary": {
    "Token": "9576cc6d-61e0-48ea-ae0c-9627d9cdd558",
    "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>9576cc6d-61e0-48ea-ae0c-9627d9cdd558</d2p1:Token>
  </BankAccountSummary>
  <TimeZone>Pacific</TimeZone>
  <TokenCreationTime>2020-10-27T04:59:57</TokenCreationTime>
</SavePaymentMethodResponse>

POST api/PaymentMethod/GetInfo

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

MethodEndpoint
GetInfo https://stgportalone.processonepayments.com/ClaimsPay/api/PaymentMethod/GetInfo

GetPaymentMethodInfoRequest

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer No
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

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

NameDescriptionTypeRequired*Additional information
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.

Collection of BankAccountSummary No
Cards

Array of cards that are associated to the AccountId. The array will return an CardSummary object (token and supporting information that can be used to process a Push to Card payment) for each card.

Collection of CardSummary No
HasPrepaidCardAccount

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

boolean No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

Response Formats

{
  "BankAccounts": [
    {
      "Token": "9576cc6d-61e0-48ea-ae0c-9627d9cdd558",
      "AccountType": "Checking",
      "LastFourDigits": "1234",
      "BankName": "Test Bank",
      "NameOnAccount": "Janet Smith"
    }
  ],
  "Cards": null,
  "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>9576cc6d-61e0-48ea-ae0c-9627d9cdd558</d2p1:Token>
    </d2p1:BankAccountSummary>
  </BankAccounts>
  <Cards xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts" i:nil="true" />
  <HasPrepaidCardAccount>false</HasPrepaidCardAccount>
</GetPaymentMethodInfoResponse>

POST api/PaymentMethod/UpdateCard

This method is intended to update the stored card information with a new information.

MethodEndpoint
UpdateCard https://stgportalone.processonepayments.com/ClaimsPay/api/PaymentMethod/UpdateCard

UpdateCardRequest

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer Yes
Token

Previously saved card token.

string Yes
Zip

Card holder zip.

string No
Address

Card holder address.

string No
City

Card holder city.

string No
State

Card holder state.

string No
Phone

Customer phone.

string No
ExpirationYear

Year of the expiration of the credit card.

integer No
ExpirationMonth

Month of the expiration of the credit card.

integer No
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

Request Formats

 
                                
                                 {
  "AccountId": 123,
  "Token": "498d3d81-25d7-4bab-9c5e-0ba363942f58",
  "Zip": "95630",
  "Address": "123 Main St.",
  "City": "Folsom",
  "State": "CA",
  "Phone": "555-0100",
  "ExpirationYear": 2023,
  "ExpirationMonth": 1,
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
                                
                                 <UpdateCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Card">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">Authentication Key</ClaimsPayAuthenticationKey>
  <AccountId>123</AccountId>
  <Address>123 Main St.</Address>
  <City>Folsom</City>
  <ExpirationMonth>1</ExpirationMonth>
  <ExpirationYear>2023</ExpirationYear>
  <Phone>555-0100</Phone>
  <State>CA</State>
  <Token>498d3d81-25d7-4bab-9c5e-0ba363942f58</Token>
  <Zip>95630</Zip>
</UpdateCardRequest>

Response Information

UpdateCardResponse

NameDescriptionTypeRequired*Additional information
TimeZone

Short time zone name with daylight saving time suffix.

string No
UpdateTime

Update date and time in merchant time zone.

date No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

Response Formats

{
  "TimeZone": "Pacific",
  "UpdateTime": "2020-10-27T04:59:58",
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<UpdateCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Card">
  <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>
  <TimeZone>Pacific</TimeZone>
  <UpdateTime>2020-10-27T04:59:58</UpdateTime>
</UpdateCardResponse>

Card

Card operations

POST api/Card/PushFunds

MethodEndpoint
PushFunds https://stgportalone.processonepayments.com/ClaimsPay/api/Card/PushFunds

PushFundsToCardRequest

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer Yes
ContactId

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

integer No
Amount

Amount of payment.

decimal number Yes
Token

Previously saved card token.

string Yes
AccountGroupCode

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

string No
ClaimNumber

Claim number that will be associated to the payment.

string Yes
ClaimDetails

Claim details which will be sent in the payment email.

string No
SourceUser

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

string No
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

Request Formats

 
                                
                                 {
  "AccountId": 123,
  "ContactId": 123,
  "Amount": 120.0,
  "Token": "498d3d81-25d7-4bab-9c5e-0ba363942f58",
  "AccountGroupCode": "Default",
  "ClaimNumber": "C12345",
  "ClaimDetails": "Claim details",
  "SourceUser": "Janet Smith",
  "ClaimsPayAuthenticationKey": "Authentication Key"
}
                                
                                 <PushFundsToCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Card">
  <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>
  <ClaimDetails>Claim details</ClaimDetails>
  <ClaimNumber>C12345</ClaimNumber>
  <ContactId>123</ContactId>
  <SourceUser>Janet Smith</SourceUser>
  <Token>498d3d81-25d7-4bab-9c5e-0ba363942f58</Token>
</PushFundsToCardRequest>

Response Information

PushFundsToCardResponse

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction identifier.

string No
TransactionDate

Transaction date and time.

date No
TimeZone

Transaction time zone.

string No
BatchNumber

Number of the batch.

integer No
CardInfo

Card summary information.

CardInfo No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

Response Formats

{
  "TransactionId": "123",
  "TransactionDate": "2020-10-27T04:59:59",
  "TimeZone": "Pacific",
  "BatchNumber": 5,
  "CardInfo": {
    "Token": "498d3d81-25d7-4bab-9c5e-0ba363942f58",
    "LastFourDigits": "1234",
    "CardType": "Visa",
    "HolderName": "Janet Smith"
  },
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<PushFundsToCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Card">
  <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>5</BatchNumber>
  <CardInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
    <d2p1:CardType>Visa</d2p1:CardType>
    <d2p1:HolderName>Janet Smith</d2p1:HolderName>
    <d2p1:LastFourDigits>1234</d2p1:LastFourDigits>
    <d2p1:Token>498d3d81-25d7-4bab-9c5e-0ba363942f58</d2p1:Token>
  </CardInfo>
  <TimeZone>Pacific</TimeZone>
  <TransactionDate>2020-10-27T04:59:59.403006-07:00</TransactionDate>
  <TransactionId>123</TransactionId>
</PushFundsToCardResponse>

Check

POST api/Check/Issue

This method is used to issue a check associated to a ClaimsPay AccountID.

MethodEndpoint
Issue https://stgportalone.processonepayments.com/ClaimsPay/api/Check/Issue

IssueCheckRequest

NameDescriptionTypeRequired*Additional information
AccountId

ClaimsPay Account Identifier.

integer Yes
ContactId

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

integer No
Amount

Amount of payment.

decimal number Yes
ClaimNumber

Claim number that will be associated to the payment.

string Yes
Memo

Check memo line text.

string No

If present, max field length 40, alpha numeric and special characters allowed.

ClaimDetails

Claim detail information that will be printed on the check Stub. Printed information will be limited to 19 lines with up to 111 characters each line. If a string is sent that is greater than 111 characters, the values will be parsed into multiple lines by splitting the lines at spaces. If the data sent results in over 19 rows after parsing, the system will only print the first 19 rows.

Collection of string No

If present, up to 19 strings off 111 characters. Empty values allowed.

DocumentUrl

URL for the pdf support documentation for the claim payment. Up to 250 characters. If the party is sent a check fulfilled by One Inc, the pdf will be sent with the mailed check; the pdf must be limited to four (4) pages in length. If the pdf exceeds the allowable length, the mailing of the check will fail.

string No

If present must be valid URL format up to 250 characters.

MailDeliveryType

Defines the mailing method that will be used for the check.

MailDeliveryType No
RecipientInfo

Check recipient information.

RecipientInfo Yes
AccountGroupCode

This field is used to route money from different accounts based on a predefined groups. For payments made via check, the AccountGroupCode will indicate to the system which bank account and routing number should be used to issue the check.

string No
SourceUser

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

string No
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

RecipientInfo

NameDescriptionTypeRequired*Additional information
PayToName

Name of person or company that is the recipient of the check.

string Yes

Max length: 240

AdditionalPayToNames

Name of additional persons or companies that will be listed as additional recipients on the check. Each name must be preceded with either AND or OR.

Collection of AdditionalPayToName No
ShipToAddress

The ship to information for check delivery.

ShipToAddress Yes

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

AdditionalPayToName

NameDescriptionTypeRequired*Additional information
Separator

Merge operator for additional persons or companies.

Separator No

Allowable values: AND, OR

PayToName

Name of additional persons or companies.

string No

Max length of 64 characters

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

ShipToAddress

NameDescriptionTypeRequired*Additional information
Name

The person or company to which the check will be mailed.

string Yes

Max length: 60

CompanyContactInformation

Address field for additional company or contact information such as department or title. This applies to company accounts only.

string No

Max length: 60

Attention

Attention line to provide additional identifying information for the recipient.

string No

Max length: 60

Address1

Address to which the check will be mailed.

string Yes

Max length: 50

Address2

Address Line 2 to which the check will be mailed.

string No

Max length: 50

City

The city to which the check will be mailed.

string Yes

Max length: 30

State

The state to which the check will be mailed.

string Yes
Zip

The zip code to which the check will be mailed.

string Yes

Length: 5

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

Request Formats

 
                                
                                 {
  "AccountId": 1,
  "ContactId": 1,
  "Amount": 1.0,
  "ClaimNumber": "sample string 1",
  "Memo": "sample string 2",
  "ClaimDetails": [
    "sample string 1",
    "sample string 2"
  ],
  "DocumentUrl": "sample string 3",
  "MailDeliveryType": "Undefined",
  "RecipientInfo": {
    "PayToName": "sample string 1",
    "AdditionalPayToNames": [
      {
        "Separator": "Undefined",
        "PayToName": "sample string 1"
      },
      {
        "Separator": "Undefined",
        "PayToName": "sample string 1"
      }
    ],
    "ShipToAddress": {
      "Name": "sample string 1",
      "CompanyContactInformation": "sample string 2",
      "Attention": "sample string 3",
      "Address1": "sample string 4",
      "Address2": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "Zip": "sample string 8"
    }
  },
  "AccountGroupCode": "sample string 4",
  "SourceUser": "sample string 5",
  "ClaimsPayAuthenticationKey": "sample string 6"
}
                                
                                 <IssueCheckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Check">
  <ClaimsPayAuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 6</ClaimsPayAuthenticationKey>
  <AccountGroupCode>sample string 4</AccountGroupCode>
  <AccountId>1</AccountId>
  <Amount>1</Amount>
  <ClaimDetails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ClaimDetails>
  <ClaimNumber>sample string 1</ClaimNumber>
  <ContactId>1</ContactId>
  <DocumentUrl>sample string 3</DocumentUrl>
  <MailDeliveryType>Undefined</MailDeliveryType>
  <Memo>sample string 2</Memo>
  <RecipientInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">
    <d2p1:AdditionalPayToNames>
      <d2p1:AdditionalPayToName>
        <d2p1:PayToName>sample string 1</d2p1:PayToName>
        <d2p1:Separator>Undefined</d2p1:Separator>
      </d2p1:AdditionalPayToName>
      <d2p1:AdditionalPayToName>
        <d2p1:PayToName>sample string 1</d2p1:PayToName>
        <d2p1:Separator>Undefined</d2p1:Separator>
      </d2p1:AdditionalPayToName>
    </d2p1:AdditionalPayToNames>
    <d2p1:PayToName>sample string 1</d2p1:PayToName>
    <d2p1:ShipToAddress>
      <d2p1:Address1>sample string 4</d2p1:Address1>
      <d2p1:Address2>sample string 5</d2p1:Address2>
      <d2p1:Attention>sample string 3</d2p1:Attention>
      <d2p1:City>sample string 6</d2p1:City>
      <d2p1:CompanyContactInformation>sample string 2</d2p1:CompanyContactInformation>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:State>sample string 7</d2p1:State>
      <d2p1:Zip>sample string 8</d2p1:Zip>
    </d2p1:ShipToAddress>
  </RecipientInfo>
  <SourceUser>sample string 5</SourceUser>
</IssueCheckRequest>

Response Information

IssueCheckResponse

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction identifier.

string No
TransactionDate

Transaction date and time.

date No
TimeZone

Transaction time zone.

string No
BatchNumber

Number of the check batch.

integer No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

Response Formats

{
  "TransactionId": "sample string 1",
  "TransactionDate": "2020-10-27T05:00:00",
  "TimeZone": "sample string 2",
  "BatchNumber": 1,
  "ResponseCode": "sample string 3",
  "ResponseMessage": "sample string 4"
}
<IssueCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts.Check">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 3</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.ClaimsPay.RestApi.Contracts.DataContracts">sample string 4</ResponseMessage>
  <BatchNumber>1</BatchNumber>
  <TimeZone>sample string 2</TimeZone>
  <TransactionDate>2020-10-27T05:00:00</TransactionDate>
  <TransactionId>sample string 1</TransactionId>
</IssueCheckResponse>

POST api/Check/Cancel

This method is used to cancel a check.

MethodEndpoint
Cancel https://stgportalone.processonepayments.com/ClaimsPay/api/Check/Cancel

CancelCheckRequest

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction identifier.

string Yes
ClaimsPayAuthenticationKey

ClaimsPay instance authentication key.

string Yes

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

Request Formats

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

Response Information

CancelCheckResponse

NameDescriptionTypeRequired*Additional information
TransactionId

An id of the cancel transaction.

string No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

ResponseMessage

Response message.

string No

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

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

Response Formats

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


Test Data

You can use the following card numbers for testing purposes. Numbers marked with an * apply to testing of ClaimsPay Card/PushFunds.

Card Type Card number Cvv2 Expiration date Comments
Visa 4111111111111111* Any 3 digit Any future date *will be successful for ClaimsPay Push to Card
MasterCard 5431111111111111* Any 3 digit Any future date See available amount combinations below.
*Will always return an error when using token for a ClaimsPay Push to Card payment
Discover 6011601160116611 Any 3 digit Any future date See available amount combinations below.
AmericanExpress 341111111111111 Any 4 digit Any future date See available amount combinations below.
Hybrid Visa PinlessDebit Star 4024007167282317 Any 3 digit Any future date This is as a Hybrid Visa card. If your Merchant is provisioned for Pinless Debit cards, the card will process as a pinless debit Star. If your merchant account is not setup for Pinless Debit, it will process as a Visa
Hybrid Discover PinlessDebit Pulse 6011172923498605 Any 3 digit Any future date This is as a Hybrid Discover card. If your Merchant is provisioned for Pinless Debit cards, the card will process as a pinless debit Pulse. If your merchant account is not setup for Pinless Debit, it will process as a Discover
Hybrid MasterCard PinlessDebit Nyce 5384483278305365 Any 3 digit Any future date This is as a Hybrid Mastercard. If your Merchant is provisioned for Pinless Debit cards, the card will process as a pinless debit Nyce. If your merchant account is not setup for Pinless Debit, it will process as a Mastercard

Use the following card number and amount combination to simulate different API response codes. Numbers marked with an * apply to testing of ClaimsPay Push to Card functionality.

Card number Amount Response Code Description
4444444444444448*
5431111111111111
341111111111111
6011601160116611
1.00 or any not listed amount Success Test: Charge approved
*Use for ClaimsPay Push to Card testing
4444444444444448
5431111111111111
341111111111111
6011601160116611
2.00 or 12.00 IncorrectValidationValue Test: CVV2 code is invalid
4444444444444448
5431111111111111
341111111111111
6011601160116611
3.00 or 13.00 Declined Test: Declined
4444444444444448
5431111111111111
341111111111111
6011601160116611
4.00 OverMaximumPayment Test: Exceed max payment amount
4444444444444448
5431111111111111
341111111111111
6011601160116611
5.00 or 15.00 DuplicateTransaction Test: Duplicate transaction
4444444444444448*
5431111111111111
341111111111111
6011601160116611
6.00* or 16.00 GatewayInternalError Test: System is down
*Use for ClaimsPay Push to Card testing
4444444444444448*
5431111111111111
341111111111111
6011601160116611
7.00* or 17.00 InvalidCardNumber Test: Invalid card number returned by gateway
*Use for ClaimsPay Push to Card testing
4444444444444448
5431111111111111
341111111111111
6011601160116611
14.00 AvsVerificationFailed Test: Avs verification failed
4444444444444448
5431111111111111
341111111111111
6011601160116611
18.00 Call Test: Issuer wants voice contact with cardholder
4444444444444448*
5431111111111111
341111111111111
6011601160116611
19.00* NoProcessorResponse Test: No response from Processor
*Use for ClaimsPay Push to Card testing

Use the following card numbers to simulate specific API response codes regardless of amount.

Test Data for Save transaction type.
Card number Response Code Description
4444444444444117 Success Test: Successfully saved
Test Data for Charge transaction type.
Card number Response Code Description
4444444444444125 Success Test: Charge approved
4444444444444133 IncorrectValidationValue Test: CVV2 code is invalid
4444444444444141 Declined Test: Insufficient funds
4444444444444158 OverMaximumPayment Test: Amount sent exceeds maximum allowable amount.
4444444444444166 DuplicateTransaction Test: Duplicate transaction
4444444444444174 GatewayInternalError Test: System is down
4444444444444182 InvalidCardNumber Test: Invalid card number returned by gateway
4444444444444190 Success Test: Charge approved
4444444444444208 IncorrectValidationValue Test: CVV2 code is invalid
4444444444444216 Declined Test: Insufficient funds
4444444444444224 AvsVerificationFailed Test: Avs verification failed
4444444444444232 DuplicateTransaction Test: Duplicate transaction
4444444444444240 GatewayInternalError Test: System is down
4444444444444257 InvalidCardNumber Test: Invalid card number returned by gateway
4444444444444265 Call Test: Issuer wants voice contact with cardholder
4444444444444273 NoProcessorResponse Test: No response from Processor
Test Data for Charge transaction type (for subsequent void / refund).
Card number Response Code Description
4444444444444299 Success Test: Charge approved
4444444444444307 Success Test: Charge approved
4444444444444315 Success Test: Charge approved
4444444444444323 Success Test: Charge approved
4444444444444331 Success Test: Charge approved
4444444444444349 Success Test: Charge approved
4444444444444356 Success Test: Charge approved
4444444444444364 Success Test: Charge approved
4444444444444372 Success Test: Charge approved
4444444444444380 Success Test: Charge approved
4444444444444398 Success Test: Charge approved
4444444444444505 Success Test: Charge approved
4444444444444513 Success Test: Charge approved
Test Data for void / refund transaction type.
Card number Response Code Description
4444444444444299 InvalidCardNumber Test: This is an invalid card number or account is closed
4444444444444307 IncorrectValidationValue Test: CVV2 code is invalid
4444444444444315 Declined Test: Insufficient funds
4444444444444323 InvalidCreditCardAmount Test: Amount sent exceeds maximum allowable amount.
4444444444444331 DuplicateTransaction Test: Duplicate transaction
4444444444444349 GatewayInternalError Test: System is down
4444444444444356 AvsVerificationFailed Test: Avs Verification Failed
4444444444444364 CardTypeNotAccepted Test: The card type provided is not supported
4444444444444372 CardExpired Test: The Card is Expired
4444444444444380 Call Test: Issuer wants voice contact with cardholder
4444444444444398 NoProcessorResponse Test: No response from Processor
4444444444444505 Success Test: Refund successful
4444444444444513 Success Test: Void successful

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 | Card PushFunds | PaymentMehod UpdateCard
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 | Card PushFunds
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 | Card PushFunds
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 | Card PushFunds
OperationNotSupportedByMerchant This error may occur when trying to execute operation which is currently disabled for merchant. BankAccount Verify | PaymentMethod Save | Card PushFunds
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 | PaymentMethod UpdateCard
BatchHasBeenClosed This error message is returned when you attempt to void a transaction when the batch has already been closed. BankAccount VoidCredit
InvalidZipcode An invalid zip code was passed. PaymentMethod UpdateCard
InvalidExpirationDate An invalid expiration date was passed. PaymentMethod UpdateCard
InvalidCardNumber This is an invalid card number. Card PushFunds
CityAndStateMustBeSpecified When either City or State are provided, both values are required. PaymentMethod UpdateCard