BankAccount

POST api/BankAccount/Credit

Direct ACH claim payment

CreditBankAccountRequest

NameDescriptionTypeAdditional information
ContactName

Company Contact First and Last Name.

string
CustomerId

A customer id associated with the transaction

string
Amount

Amount of payment

decimal number
Token

Saved bank account token

string
ClientReferenceData

Client reference data object.

ClientReferenceData
CallbackId

A callback id for the Credit Bank Account transaction

string
AccountGroupCode

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

string
BankAccountDetails

Bank Account Details object

BankAccountDetails
AuthenticationKey

Instance authentication key

string

ClientReferenceData

NameDescriptionTypeAdditional information
ClientReferenceData1

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

string
ClientReferenceData2

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

string
ClientReferenceData3

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

string
ClientReferenceData4

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

string
ClientReferenceData5

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

string

BankAccountDetails

NameDescriptionTypeAdditional information
RoutingNumber

Bank routing number

string
AccountNumber

Bank account number

string
AccountType

Bank account type

BankAccountType
CustomerName

Customer Name for this Bank Account

string
TokenReusability

TokenReusability

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": "e6061606-f003-4e98-9190-67d904f3b745",
  "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": "16fed0ec-c10c-4cb4-9021-2491f10e2cdb"
}
<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">16fed0ec-c10c-4cb4-9021-2491f10e2cdb</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>e6061606-f003-4e98-9190-67d904f3b745</Token>
  <ContactName i:nil="true" />
  <CustomerId i:nil="true" />
</CreditBankAccountRequest>

Response Information

CreditBankAccountResponse

NameDescriptionTypeAdditional information
BankAccountInformation

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

BankAccountInformation
TransactionId

Transaction identifier

string
TransactionDate

Transaction date and time

date
TimeZone

Transaction time zone

string
BatchNumber

Number of the batch

integer
ResponseCode

Operation response code from ProcessOne

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message from ProcessOne

string

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

BankAccountInformation

NameDescriptionTypeAdditional information
AccountType

Checking / Savings

BankAccountType
LastFourDigits

Last four digits of the bank account number

string
BankName

Bank Name

string
NameOnAccount

Name on Bank Account

string

Response Formats

{
  "BankAccountInformation": {
    "AccountType": 1,
    "LastFourDigits": "3123",
    "BankName": "Customer Name",
    "NameOnAccount": "Customer Name"
  },
  "TransactionId": "1234",
  "TransactionDate": "2020-09-24T11:23:20",
  "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>Customer Name</BankName>
    <LastFourDigits>3123</LastFourDigits>
    <NameOnAccount>Customer Name</NameOnAccount>
  </BankAccountInformation>
  <BatchNumber>1</BatchNumber>
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2020-09-24T11:23:20</TransactionDate>
  <TransactionId>1234</TransactionId>
</CreditBankAccountResponse>

POST api/BankAccount/VoidCredit

Void direct ACH claim payment

VoidCreditBankAccountRequest

NameDescriptionTypeAdditional information
TransactionId

Transaction identifier

string
CallbackId

A callback id for the Credit Bank Account transaction

string
AuthenticationKey

Instance authentication key

string

Request Formats

 
{
  "TransactionId": "1234",
  "CallbackId": "1234test",
  "AuthenticationKey": "2c61c33e-c4bb-4a5c-9058-1af18ca13e7d"
}
<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">2c61c33e-c4bb-4a5c-9058-1af18ca13e7d</AuthenticationKey>
  <CallbackId>1234test</CallbackId>
  <TransactionId>1234</TransactionId>
</VoidCreditBankAccountRequest>

Response Information

VoidCreditBankAccountResponse

NameDescriptionTypeAdditional information
BatchNumber

Number of the batch

integer
ResponseCode

Operation response code from ProcessOne

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message from ProcessOne

string

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

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

IssueCheckRequest

NameDescriptionTypeAdditional information
Amount

Amount of payment

decimal number
Memo

Check memo line text

string
DocumentUrl

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

string
RecipientInfo

Check recipient information

RecipientInfo
CheckStubData

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

CheckStubData
MailDeliveryType

Defines the mailing method that will be used for the check

MailDeliveryType
AccountGroupCode

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

string
ClientReferenceData

Client Reference Data

ClientReferenceData
AuthenticationKey

Instance authentication key

string

RecipientInfo

NameDescriptionTypeAdditional information
PayToName

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

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

The ship to information for check delivery

ShipToAddress

ShipToAddress

NameDescriptionTypeAdditional information
Name

The person or company to which the check will be mailed

string
Name2

Second line for persons mailing name

string
Attention

Attention line to provide additional identifying information for the recipient

string
Address1

Address to which the check will be mailed

string
Address2

Address Line 2 to which the check will be mailed

string
City

The city to which the check will be mailed

string
State

The state to which the check will be mailed

string
Zip

The zip code to which the check will be mailed

string
Country

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

string

CheckStubData

NameDescriptionTypeAdditional 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
ReferenceNumber

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

string
StubReferenceDetails

Additional information to be printed on the check stub.

Collection of string

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": 1.0,
  "Memo": "sample string 1",
  "DocumentUrl": "sample string 2",
  "RecipientInfo": {
    "PayToName": "sample string 1",
    "AdditionalPayToParties": [
      "sample string 1",
      "sample string 2"
    ],
    "ShipToAddress": {
      "Name": "sample string 1",
      "Name2": "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",
      "Country": "sample string 9"
    }
  },
  "CheckStubData": {
    "ReferenceNumberLabel": "sample string 1",
    "ReferenceNumber": "sample string 2",
    "StubReferenceDetails": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "MailDeliveryType": 1,
  "AccountGroupCode": "sample string 3",
  "ClientReferenceData": {
    "ClientReferenceData1": "sample string 1",
    "ClientReferenceData2": "sample string 2",
    "ClientReferenceData3": "sample string 3",
    "ClientReferenceData4": "sample string 4",
    "ClientReferenceData5": "sample string 5"
  },
  "AuthenticationKey": "sample string 4"
}
<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">sample string 4</AuthenticationKey>
  <AccountGroupCode>sample string 3</AccountGroupCode>
  <Amount>1</Amount>
  <CheckStubData>
    <ReferenceNumber>sample string 2</ReferenceNumber>
    <ReferenceNumberLabel>sample string 1</ReferenceNumberLabel>
    <StubReferenceDetails xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </StubReferenceDetails>
  </CheckStubData>
  <ClientReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts">
    <d2p1:ClientReferenceData1>sample string 1</d2p1:ClientReferenceData1>
    <d2p1:ClientReferenceData2>sample string 2</d2p1:ClientReferenceData2>
    <d2p1:ClientReferenceData3>sample string 3</d2p1:ClientReferenceData3>
    <d2p1:ClientReferenceData4>sample string 4</d2p1:ClientReferenceData4>
    <d2p1:ClientReferenceData5>sample string 5</d2p1:ClientReferenceData5>
  </ClientReferenceData>
  <DocumentUrl>sample string 2</DocumentUrl>
  <MailDeliveryType>Standard</MailDeliveryType>
  <Memo>sample string 1</Memo>
  <RecipientInfo>
    <AdditionalPayToParties xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </AdditionalPayToParties>
    <PayToName>sample string 1</PayToName>
    <ShipToAddress>
      <Address1>sample string 4</Address1>
      <Address2>sample string 5</Address2>
      <Attention>sample string 3</Attention>
      <City>sample string 6</City>
      <Country>sample string 9</Country>
      <Name>sample string 1</Name>
      <Name2>sample string 2</Name2>
      <State>sample string 7</State>
      <Zip>sample string 8</Zip>
    </ShipToAddress>
  </RecipientInfo>
</IssueCheckRequest>

Response Information

IssueCheckResponse

NameDescriptionTypeAdditional information
TransactionId

Transaction identifier

string
TransactionDate

Transaction date and time

date
TimeZone

Transaction time zone

string
CheckBatchNumber

Number of the check batch

integer
ResponseCode

Operation response code from ProcessOne

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message from ProcessOne

string

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

Response Formats

{
  "TransactionId": "sample string 1",
  "TransactionDate": "2020-09-24T11:23:20",
  "TimeZone": "sample string 2",
  "CheckBatchNumber": 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.ProcessOne.RestApi.Outbound.Contracts.DataContracts.Check">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts">sample string 3</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts">sample string 4</ResponseMessage>
  <CheckBatchNumber>1</CheckBatchNumber>
  <TimeZone>sample string 2</TimeZone>
  <TransactionDate>2020-09-24T11:23:20</TransactionDate>
  <TransactionId>sample string 1</TransactionId>
</IssueCheckResponse>

POST api/Check/Cancel

CancelCheckRequest

NameDescriptionTypeAdditional information
TransactionId

Transaction identifier

string
AuthenticationKey

Instance authentication key

string

Request Formats

 
{
  "TransactionId": "sample string 1",
  "AuthenticationKey": "sample string 2"
}
<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">sample string 2</AuthenticationKey>
  <TransactionId>sample string 1</TransactionId>
</CancelCheckRequest>

Response Information

CancelCheckResponse

NameDescriptionTypeAdditional information
TransactionId

Transaction identifier

string
ResponseCode

Operation response code from ProcessOne

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message from ProcessOne

string

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

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.ProcessOne.RestApi.Outbound.Contracts.DataContracts.Check">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts">sample string 2</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts">sample string 3</ResponseMessage>
  <TransactionId>sample string 1</TransactionId>
</CancelCheckResponse>

POST api/Check/ChangeStatus

ChangeCheckStatusRequest

NameDescriptionTypeAdditional information
NewCheckStatus

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

UserAllowedCheckStatus
TransactionId

Transaction identifier

string
SourceUser

Source user

string
AuthenticationKey

Instance authentication key

string

UserAllowedCheckStatus

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

Voided

1

Voided

Cleared

2

Cleared

Issued

3

Issued

Request Formats

 
{
  "NewCheckStatus": 0,
  "TransactionId": "sample string 1",
  "SourceUser": "sample string 2",
  "AuthenticationKey": "sample string 3"
}
<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">sample string 3</AuthenticationKey>
  <NewCheckStatus>Undefined</NewCheckStatus>
  <SourceUser>sample string 2</SourceUser>
  <TransactionId>sample string 1</TransactionId>
</ChangeCheckStatusRequest>

Response Information

ChangeCheckStatusResponse

NameDescriptionTypeAdditional information
TransactionId

Transaction identifier

integer
ResponseCode

Operation response code from ProcessOne

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message from ProcessOne

string

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

Response Formats

{
  "TransactionId": 1,
  "ResponseCode": "sample string 2",
  "ResponseMessage": "sample string 3"
}
<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">sample string 2</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts">sample string 3</ResponseMessage>
  <TransactionId>1</TransactionId>
</ChangeCheckStatusResponse>