Card

POST api/Card/PushFunds

Push funds to card.

CardPushFundsRequest

NameDescriptionTypeAdditional information
Amount

decimal number
Token

string
CardDetails

CardDetails
ClientReferenceData

ClientReferenceData
AccountGroupCode

string
Save

boolean
CallbackId

string
AuthenticationKey

string

CardDetails

NameDescriptionTypeAdditional information
ExpirationYear

integer
ExpirationMonth

integer
Holder

Holder
Number

string

Holder

NameDescriptionTypeAdditional information
Name

string
Zip

string
Address

string
City

string
State

string
Phone

string

ClientReferenceData

NameDescriptionTypeAdditional information
ClientReferenceData1

string
ClientReferenceData2

string
ClientReferenceData3

string
ClientReferenceData4

string
ClientReferenceData5

string

Request Formats

 
{
  "Amount": 1.0,
  "Token": "sample string 2",
  "CardDetails": {
    "ExpirationYear": 1,
    "ExpirationMonth": 2,
    "Holder": {
      "Name": "sample string 1",
      "Zip": "sample string 2",
      "Address": "sample string 3",
      "City": "sample string 4",
      "State": "sample string 5",
      "Phone": "sample string 6"
    },
    "Number": "sample string 3"
  },
  "ClientReferenceData": {
    "ClientReferenceData1": "sample string 1",
    "ClientReferenceData2": "sample string 2",
    "ClientReferenceData3": "sample string 3",
    "ClientReferenceData4": "sample string 4",
    "ClientReferenceData5": "sample string 5"
  },
  "AccountGroupCode": "sample string 3",
  "Save": true,
  "CallbackId": "sample string 5",
  "AuthenticationKey": "sample string 6"
}
<CardPushFundsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts.Card">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts">sample string 6</AuthenticationKey>
  <AccountGroupCode>sample string 3</AccountGroupCode>
  <Amount>1</Amount>
  <CallbackId>sample string 5</CallbackId>
  <CardDetails>
    <ExpirationMonth>2</ExpirationMonth>
    <ExpirationYear>1</ExpirationYear>
    <Holder>
      <Address>sample string 3</Address>
      <City>sample string 4</City>
      <Name>sample string 1</Name>
      <Phone>sample string 6</Phone>
      <State>sample string 5</State>
      <Zip>sample string 2</Zip>
    </Holder>
    <Number>sample string 3</Number>
  </CardDetails>
  <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>
  <Save>true</Save>
  <Token>sample string 2</Token>
</CardPushFundsRequest>

Response Information

CardPushFundsResponse

NameDescriptionTypeAdditional information
TransactionId

string
TransactionDate

date
TimeZone

string
Token

string
CardType

CardType
HolderName

string
CardLastFourDigits

string
BatchNumber

integer
ResponseCode

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

string

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

CardType

Possible enumeration values:

NameValueDescription
Undefined

0

Visa

1

MasterCard

2

AmericanExpress

3

Discover

4

Response Formats

{
  "TransactionId": "sample string 1",
  "TransactionDate": "2020-02-19T12:34:39",
  "TimeZone": "sample string 2",
  "Token": "sample string 3",
  "CardType": 0,
  "HolderName": "sample string 4",
  "CardLastFourDigits": "sample string 5",
  "BatchNumber": 6,
  "ResponseCode": "sample string 7",
  "ResponseMessage": "sample string 8"
}
<CardPushFundsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Outbound.Contracts.DataContracts.Card">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts">sample string 7</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.Libs.RestApiValidation.DataContracts">sample string 8</ResponseMessage>
  <BatchNumber>6</BatchNumber>
  <CardLastFourDigits>sample string 5</CardLastFourDigits>
  <CardType>Undefined</CardType>
  <HolderName>sample string 4</HolderName>
  <TimeZone>sample string 2</TimeZone>
  <Token>sample string 3</Token>
  <TransactionDate>2020-02-19T12:34:39</TransactionDate>
  <TransactionId>sample string 1</TransactionId>
</CardPushFundsResponse>

BankAccount

POST api/BankAccount/Credit

Direct ACH claim payment

CreditBankAccountRequest

NameDescriptionTypeAdditional information
ContactName

string
CustomerId

string
Amount

decimal number
Token

string
ClientReferenceData

ClientReferenceData
CallbackId

string
AccountGroupCode

string
BankAccountDetails

BankAccountDetails
AuthenticationKey

string

BankAccountDetails

NameDescriptionTypeAdditional information
RoutingNumber

string
AccountNumber

string
AccountType

BankAccountType
CustomerName

string

BankAccountType

Possible enumeration values:

NameValueDescription
Undefined

0

Checking

1

Savings

2

Request Formats

 
{
  "ContactName": null,
  "CustomerId": null,
  "Amount": 10.0,
  "Token": "32a921df-b815-44ae-b078-763c0037a801",
  "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"
  },
  "AuthenticationKey": "1d58be15-c404-415e-ba35-a9c9b5b6e317"
}
<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">1d58be15-c404-415e-ba35-a9c9b5b6e317</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>
  </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>32a921df-b815-44ae-b078-763c0037a801</Token>
  <ContactName i:nil="true" />
  <CustomerId i:nil="true" />
</CreditBankAccountRequest>

Response Information

CreditBankAccountResponse

NameDescriptionTypeAdditional information
BankAccountInformation

BankAccountInformation
TransactionId

string
TransactionDate

date
TimeZone

string
BatchNumber

integer
ResponseCode

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

string

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

BankAccountInformation

NameDescriptionTypeAdditional information
AccountType

BankAccountType
LastFourDigits

string
BankName

string
NameOnAccount

string

Response Formats

{
  "BankAccountInformation": {
    "AccountType": 1,
    "LastFourDigits": "3123",
    "BankName": "Customer Name",
    "NameOnAccount": "Customer Name"
  },
  "TransactionId": "1234",
  "TransactionDate": "2020-02-19T12:34:40",
  "TimeZone": "PST",
  "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>PST</TimeZone>
  <TransactionDate>2020-02-19T12:34:40</TransactionDate>
  <TransactionId>1234</TransactionId>
</CreditBankAccountResponse>

POST api/BankAccount/VoidCredit

Void direct ACH claim payment

VoidCreditBankAccountRequest

NameDescriptionTypeAdditional information
TransactionId

string
CallbackId

string
AuthenticationKey

string

Request Formats

 
{
  "TransactionId": "1234",
  "CallbackId": "1234test",
  "AuthenticationKey": "b3bf54c4-9a5a-49e3-8368-a746b4525b2a"
}
<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">b3bf54c4-9a5a-49e3-8368-a746b4525b2a</AuthenticationKey>
  <CallbackId>1234test</CallbackId>
  <TransactionId>1234</TransactionId>
</VoidCreditBankAccountRequest>

Response Information

VoidCreditBankAccountResponse

NameDescriptionTypeAdditional information
BatchNumber

integer
ResponseCode

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

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

decimal number
Memo

string
DocumentUrl

string
RecipientInfo

RecipientInfo
CheckStubData

CheckStubData
MailDeliveryType

MailDeliveryType
AccountGroupCode

string
ClientReferenceData

ClientReferenceData
AuthenticationKey

string

RecipientInfo

NameDescriptionTypeAdditional information
PayToName

string
AdditionalPayToParties

Collection of string
ShipToAddress

ShipToAddress

String

ShipToAddress

NameDescriptionTypeAdditional information
Name

string
Name2

string
Attention

string
Address1

string
Address2

string
City

string
State

string
Zip

string
Country

string

CheckStubData

NameDescriptionTypeAdditional information
ReferenceNumberLabel

string
ReferenceNumber

string
StubReferenceDetails

Collection of string

MailDeliveryType

Possible enumeration values:

NameValueDescription
Standard

1

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": "Standard",
  "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

string
TransactionDate

date
TimeZone

string
CheckBatchNumber

integer
ResponseCode

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

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-02-19T12:34:40",
  "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-02-19T12:34:40</TransactionDate>
  <TransactionId>sample string 1</TransactionId>
</IssueCheckResponse>

POST api/Check/Cancel

CancelCheckRequest

NameDescriptionTypeAdditional information
TransactionId

string
AuthenticationKey

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

string
ResponseCode

string

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

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>