BankAccount

POST api/BankAccount/Credit

Direct ACH claim payment

MethodEndpoint
Credit https://processonestg.oneincsystems.com/Outbound/api/BankAccount/Credit

CreditBankAccountRequest

NameDescriptionTypeRequired*Additional information
ContactName

Company Contact First and Last Name.

string No
CustomerId

A customer id associated with the transaction

string No
Amount

Amount of payment

decimal number No
Token

Saved bank account token

string No
ClientReferenceData

Client reference data object.

ClientReferenceData No
CallbackId

A callback id for the Credit Bank Account transaction

string No
AccountGroupCode

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

string No
BankAccountDetails

Bank Account Details object

BankAccountDetails No
AuthenticationKey

Instance authentication key

string No

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

ClientReferenceData

NameDescriptionTypeRequired*Additional information
ClientReferenceData1

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

string No
ClientReferenceData2

Used to pass an external transaction identifier. The value will be searchable in the transaction search report.

string No
ClientReferenceData3

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

string No
ClientReferenceData4

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

string No
ClientReferenceData5

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

string No

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

BankAccountDetails

NameDescriptionTypeRequired*Additional information
RoutingNumber

Bank routing number

string No
AccountNumber

Bank account number

string No
AccountType

Bank account type

BankAccountType No
CustomerName

Customer Name for this Bank Account

string No
TokenReusability

TokenReusability No

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

BankAccountType

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

Checking

1

Checking

Savings

2

Savings

TokenReusability

Possible enumeration values:

NameValueDescription
Undefined

0

Token on file does not have permission to reuse between merchants

AllMerchants

1

Token on file has permission to reuse between merchants

Request Formats

 
                                
                                 {
  "ContactName": null,
  "CustomerId": null,
  "Amount": 10.0,
  "Token": "c9d2b472-edf0-4b33-9008-d970f75851e7",
  "ClientReferenceData": {
    "ClientReferenceData1": "ClaimNumber",
    "ClientReferenceData2": null,
    "ClientReferenceData3": "SourceUser",
    "ClientReferenceData4": null,
    "ClientReferenceData5": "SourceAccount"
  },
  "CallbackId": "1234test",
  "AccountGroupCode": "Default",
  "BankAccountDetails": {
    "RoutingNumber": "011103093",
    "AccountNumber": "123123123",
    "AccountType": 1,
    "CustomerName": "Customer Name",
    "TokenReusability": 0
  },
  "AuthenticationKey": "5dbb093d-6164-4982-b233-225df2f666ea"
}
                                
                                 <CreditBankAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts.BankAccount">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts">5dbb093d-6164-4982-b233-225df2f666ea</AuthenticationKey>
  <AccountGroupCode>Default</AccountGroupCode>
  <Amount>10</Amount>
  <BankAccountDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts">
    <d2p1:AccountNumber>123123123</d2p1:AccountNumber>
    <d2p1:AccountType>Checking</d2p1:AccountType>
    <d2p1:CustomerName>Customer Name</d2p1:CustomerName>
    <d2p1:RoutingNumber>011103093</d2p1:RoutingNumber>
    <d2p1:TokenReusability>Undefined</d2p1:TokenReusability>
  </BankAccountDetails>
  <CallbackId>1234test</CallbackId>
  <ClientReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts">
    <d2p1:ClientReferenceData1>ClaimNumber</d2p1:ClientReferenceData1>
    <d2p1:ClientReferenceData2 i:nil="true" />
    <d2p1:ClientReferenceData3>SourceUser</d2p1:ClientReferenceData3>
    <d2p1:ClientReferenceData4 i:nil="true" />
    <d2p1:ClientReferenceData5>SourceAccount</d2p1:ClientReferenceData5>
  </ClientReferenceData>
  <Token>c9d2b472-edf0-4b33-9008-d970f75851e7</Token>
  <ContactName i:nil="true" />
  <CustomerId i:nil="true" />
</CreditBankAccountRequest>

Response Information

CreditBankAccountResponse

NameDescriptionTypeRequired*Additional information
BankAccountInformation

Summary information on the bank account to which the payment was made.

BankAccountInformation No
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
ResponseCode

Operation response code from ProcessOne

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message from ProcessOne

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.

BankAccountInformation

NameDescriptionTypeRequired*Additional information
AccountType

Checking / Savings

BankAccountType No
LastFourDigits

Last four digits of the bank account number

string No
BankName

Bank Name

string No
NameOnAccount

Name on Bank Account

string No

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

Response Formats

{
  "BankAccountInformation": {
    "AccountType": 1,
    "LastFourDigits": "3123",
    "BankName": "Bank Name",
    "NameOnAccount": "Customer Name"
  },
  "TransactionId": "1234",
  "TransactionDate": "2020-10-27T06:11:18",
  "TimeZone": "PDT",
  "BatchNumber": 1,
  "ResponseCode": "Success",
  "ResponseMessage": "Success"
}
<CreditBankAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts.BankAccount">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts">Success</ResponseMessage>
  <BankAccountInformation>
    <AccountType>Checking</AccountType>
    <BankName>Bank Name</BankName>
    <LastFourDigits>3123</LastFourDigits>
    <NameOnAccount>Customer Name</NameOnAccount>
  </BankAccountInformation>
  <BatchNumber>1</BatchNumber>
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2020-10-27T06:11:18</TransactionDate>
  <TransactionId>1234</TransactionId>
</CreditBankAccountResponse>

POST api/BankAccount/VoidCredit

Void direct ACH claim payment

MethodEndpoint
VoidCredit https://processonestg.oneincsystems.com/Outbound/api/BankAccount/VoidCredit

VoidCreditBankAccountRequest

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction identifier

string No
CallbackId

A callback id for the Credit Bank Account transaction

string No
AuthenticationKey

Instance authentication key

string No

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

Request Formats

 
                                
                                 {
  "TransactionId": "1234",
  "CallbackId": "1234test",
  "AuthenticationKey": "bb268b21-ce75-4c07-ad9f-1ee9cacb8dbf"
}
                                
                                 <VoidCreditBankAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts.BankAccount">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts">bb268b21-ce75-4c07-ad9f-1ee9cacb8dbf</AuthenticationKey>
  <CallbackId>1234test</CallbackId>
  <TransactionId>1234</TransactionId>
</VoidCreditBankAccountRequest>

Response Information

VoidCreditBankAccountResponse

NameDescriptionTypeRequired*Additional information
BatchNumber

Number of the batch

integer No
ResponseCode

Operation response code from ProcessOne

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message from ProcessOne

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": 1,
  "ResponseCode": "Success",
  "ResponseMessage": "Success"
}
<VoidCreditBankAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts.BankAccount">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts">Success</ResponseMessage>
  <BatchNumber>1</BatchNumber>
</VoidCreditBankAccountResponse>

Check

POST api/Check/Issue

Mail check payment method

MethodEndpoint
Issue https://processonestg.oneincsystems.com/Outbound/api/Check/Issue

IssueCheckRequest

NameDescriptionTypeRequired*Additional information
Amount

Amount of payment

decimal number No
Memo

Check memo line text

string No
DocumentUrl

URL for the support documentation for the claim payment. (Applicable to Vendor Payments

string No
RecipientInfo

Check recipient information

RecipientInfo No
CheckStubData

Information that will be printed on the check stub in addition to the Check number, date and amount

CheckStubData No
MailDeliveryType

Defines the mailing method that will be used for the check

MailDeliveryType No
AccountGroupCode

This account group code that defines the issuing bank and supporting information that will be printed on the check

string No
ClientReferenceData

Client Reference Data

ClientReferenceData No
AuthenticationKey

Instance authentication key

string No

* 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 No
AdditionalPayToParties

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

The ship to information for check delivery

ShipToAddress No

* 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 No
Name2

Second line for persons mailing name

string No
Attention

Attention line to provide additional identifying information for the recipient

string No
Address1

Address to which the check will be mailed

string No
Address2

Address Line 2 to which the check will be mailed

string No
City

The city to which the check will be mailed

string No
State

The state to which the check will be mailed

string No
Zip

The zip code to which the check will be mailed

string No
Country

The country to which the check will be mailed. Supported value of US only

string No

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

CheckStubData

NameDescriptionTypeRequired*Additional information
ReferenceNumberLabel

The label printed on the check stub to define the reference number that will provide the user information about the check's purpose. Example: Claim Number

string No
ReferenceNumber

The reference number that will be printed on the check stub to provide the recipient context

string No
StubReferenceDetails

Additional information to be printed on the check stub.

Collection of string No

* 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

Request Formats

 
                                
                                 {
  "Amount": 120.0,
  "Memo": "Memo line text",
  "DocumentUrl": "https://oneinsystems.com/",
  "RecipientInfo": {
    "PayToName": "John Stevense",
    "AdditionalPayToParties": null,
    "ShipToAddress": {
      "Name": "John",
      "Name2": null,
      "Attention": null,
      "Address1": "620 Coolidge Drive #200",
      "Address2": null,
      "City": "City",
      "State": "CA",
      "Zip": "12345",
      "Country": null
    }
  },
  "CheckStubData": {
    "ReferenceNumberLabel": null,
    "ReferenceNumber": null,
    "StubReferenceDetails": null
  },
  "MailDeliveryType": 1,
  "AccountGroupCode": "Default",
  "ClientReferenceData": {
    "ClientReferenceData1": "ClaimNumber",
    "ClientReferenceData2": null,
    "ClientReferenceData3": "SourceUser",
    "ClientReferenceData4": null,
    "ClientReferenceData5": "SourceAccount"
  },
  "AuthenticationKey": "96d4dee5-e5bc-4111-909a-2a539b157c72"
}
                                
                                 <IssueCheckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts.Check">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts">96d4dee5-e5bc-4111-909a-2a539b157c72</AuthenticationKey>
  <AccountGroupCode>Default</AccountGroupCode>
  <Amount>120</Amount>
  <CheckStubData>
    <ReferenceNumber i:nil="true" />
    <ReferenceNumberLabel i:nil="true" />
    <StubReferenceDetails xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  </CheckStubData>
  <ClientReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts">
    <d2p1:ClientReferenceData1>ClaimNumber</d2p1:ClientReferenceData1>
    <d2p1:ClientReferenceData2 i:nil="true" />
    <d2p1:ClientReferenceData3>SourceUser</d2p1:ClientReferenceData3>
    <d2p1:ClientReferenceData4 i:nil="true" />
    <d2p1:ClientReferenceData5>SourceAccount</d2p1:ClientReferenceData5>
  </ClientReferenceData>
  <DocumentUrl>https://oneinsystems.com/</DocumentUrl>
  <MailDeliveryType>Standard</MailDeliveryType>
  <Memo>Memo line text</Memo>
  <RecipientInfo>
    <AdditionalPayToParties xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <PayToName>John Stevense</PayToName>
    <ShipToAddress>
      <Address1>620 Coolidge Drive #200</Address1>
      <Address2 i:nil="true" />
      <Attention i:nil="true" />
      <City>City</City>
      <Country i:nil="true" />
      <Name>John</Name>
      <Name2 i:nil="true" />
      <State>CA</State>
      <Zip>12345</Zip>
    </ShipToAddress>
  </RecipientInfo>
</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
CheckBatchNumber

Number of the check batch

integer No
ResponseCode

Operation response code from ProcessOne

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message from ProcessOne

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": "1234",
  "TransactionDate": "2020-10-27T06:11:19",
  "TimeZone": "PDT",
  "CheckBatchNumber": null,
  "ResponseCode": "true",
  "ResponseMessage": ""
}
<IssueCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts.Check">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts">true</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts"></ResponseMessage>
  <CheckBatchNumber i:nil="true" />
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2020-10-27T06:11:19</TransactionDate>
  <TransactionId>1234</TransactionId>
</IssueCheckResponse>

POST api/Check/Cancel

MethodEndpoint
Cancel https://processonestg.oneincsystems.com/Outbound/api/Check/Cancel

CancelCheckRequest

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction identifier

string No
AuthenticationKey

Instance authentication key

string No

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

Request Formats

 
                                
                                 {
  "TransactionId": "1234",
  "AuthenticationKey": "423410ed-bf48-4fe0-8c90-4f047c6dbd9f"
}
                                
                                 <CancelCheckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts.Check">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts">423410ed-bf48-4fe0-8c90-4f047c6dbd9f</AuthenticationKey>
  <TransactionId>1234</TransactionId>
</CancelCheckRequest>

Response Information

CancelCheckResponse

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction identifier

string No
ResponseCode

Operation response code from ProcessOne

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message from ProcessOne

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": "1234",
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<CancelCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts.Check">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts"></ResponseMessage>
  <TransactionId>1234</TransactionId>
</CancelCheckResponse>

POST api/Check/ChangeStatus

MethodEndpoint
ChangeStatus https://processonestg.oneincsystems.com/Outbound/api/Check/ChangeStatus

ChangeCheckStatusRequest

NameDescriptionTypeRequired*Additional information
NewCheckStatus

The new Check Status to change the original Check Transaction Check Status

UserAllowedCheckStatus No
TransactionId

Transaction identifier

string No
SourceUser

Source user

string No
AuthenticationKey

Instance authentication key

string No

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

UserAllowedCheckStatus

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

Voided

1

Voided

Cleared

2

Cleared

Issued

3

Issued

Request Formats

 
                                
                                 {
  "NewCheckStatus": 0,
  "TransactionId": "1234",
  "SourceUser": "Source User",
  "AuthenticationKey": "4ec721d1-0ffb-4465-8686-847895af2675"
}
                                
                                 <ChangeCheckStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts.Check">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts">4ec721d1-0ffb-4465-8686-847895af2675</AuthenticationKey>
  <NewCheckStatus>Undefined</NewCheckStatus>
  <SourceUser>Source User</SourceUser>
  <TransactionId>1234</TransactionId>
</ChangeCheckStatusRequest>

Response Information

ChangeCheckStatusResponse

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction identifier

integer No
ResponseCode

Operation response code from ProcessOne

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message from ProcessOne

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": 1234,
  "ResponseCode": "Success",
  "ResponseMessage": ""
}
<ChangeCheckStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts.Check">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts">Success</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts"></ResponseMessage>
  <TransactionId>1234</TransactionId>
</ChangeCheckStatusResponse>