PaymentToken

POST api/PaymentToken/GetInfo

This operation provides information about a saved Credit Card or EFT payment method that corresponds to a specific token. A valid token and a valid authentication key must be provided in order to retrieve information.

MethodEndpoint
GetInfo https://stgapiprocessone.oneincsystems.com/api/PaymentToken/GetInfo

GetInfoRequest

NameDescriptionTypeRequired*Additional information
Token

Payment token

string No
AuthenticationKey

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": "5a735ba2-bc45-4bf0-8993-f07b5dcf124d",
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <GetInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.PaymentToken">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <Token>5a735ba2-bc45-4bf0-8993-f07b5dcf124d</Token>
</GetInfoRequest>

Response Information

GetInfoResponse

NameDescriptionTypeRequired*Additional information
TokenType

Token type

TokenType No
Eft

EFT details

TokenEftInfo No
CreditCard

Credit card details

TokenCreditCardInfo No
ClientReferenceData

Client reference data

ClientReferenceData No
TransactionId

Transaction ID

string No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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.

TokenType

Possible enumeration values:

NameValueDescription
Undefined

0

Token type is undefined

CreditCard

1

CreditCard

Eft

2

EFT

TokenEftInfo

NameDescriptionTypeRequired*Additional information
RoutingNumber

The bank routing number. Must only contain numbers.

string No
LastFourDigits

Last 4 digits of account number

string No
Type

EFT account type - Checking / Savings

EftAccountType No
CustomerName

Customer name

string No

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

EftAccountType

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

Checking

1

Checking

Savings

2

Savings

TokenCreditCardInfo

NameDescriptionTypeRequired*Additional information
LastFourDigits

Last 4 digits of credit card number

string No
Type

Credit card type

CreditCardType No
ExpirationYear

Year of the expiration of the credit card

integer No
ExpirationMonth

Month of the expiration of the credit card

integer No
Holder

Card holder

Customer No
BaseCardType

Base Credit Card type

CreditCardType No

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

CreditCardType

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.

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.

Response Formats

{
  "TokenType": 1,
  "Eft": null,
  "CreditCard": {
    "LastFourDigits": "1234",
    "Type": 1,
    "ExpirationYear": 2020,
    "ExpirationMonth": 11,
    "Holder": {
      "Name": "John Stevens",
      "Zip": "12345",
      "Address": "test address",
      "City": null,
      "State": null,
      "Phone": null
    },
    "BaseCardType": 0
  },
  "ClientReferenceData": null,
  "TransactionId": null,
  "ResponseCode": "Success",
  "Message": null
}
<GetInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.PaymentToken">
  <Message i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts" />
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <ClientReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts" i:nil="true" />
  <CreditCard>
    <BaseCardType>Undefined</BaseCardType>
    <ExpirationMonth>11</ExpirationMonth>
    <ExpirationYear>2020</ExpirationYear>
    <Holder xmlns:d3p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
      <d3p1:Address>test address</d3p1:Address>
      <d3p1:City i:nil="true" />
      <d3p1:Name>John Stevens</d3p1:Name>
      <d3p1:Phone i:nil="true" />
      <d3p1:State i:nil="true" />
      <d3p1:Zip>12345</d3p1:Zip>
    </Holder>
    <LastFourDigits>1234</LastFourDigits>
    <Type>Visa</Type>
  </CreditCard>
  <Eft i:nil="true" />
  <TokenType>CreditCard</TokenType>
  <TransactionId i:nil="true" />
</GetInfoResponse>

POST api/PaymentToken/GetTokenInfoBatch

This operation provides information about a saved Credit Card or EFT payment methods that corresponds to the specific tokens. The valid tokens and a valid authentication key must be provided in order to retrieve information.

MethodEndpoint
GetTokenInfoBatch https://stgapiprocessone.oneincsystems.com/api/PaymentToken/GetTokenInfoBatch

GetTokenInfoBatchRequest

NameDescriptionTypeRequired*Additional information
PaymentTokens

Payment tokens

Collection of string No
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "PaymentTokens": [
    "sample string 1",
    "sample string 2"
  ],
  "AuthenticationKey": "sample string 1"
}
                                
                                 <GetTokenInfoBatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.PaymentToken">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 1</AuthenticationKey>
  <PaymentTokens xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PaymentTokens>
</GetTokenInfoBatchRequest>

Response Information

GetTokenInfoBatchResponse

NameDescriptionTypeRequired*Additional information
TokenInfoResults

A tokens information

Collection of TokenInfo No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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.

ListOfTokenInfo

NameDescriptionTypeRequired*Additional information
TokenType

Token type

TokenType No
Eft

EFT details

TokenEftInfo No
CreditCard

Credit card details

TokenCreditCardInfo No
ClientReferenceData

Client reference data

ClientReferenceData No
TransactionId

Transaction ID

string No
PaymentToken

Payment token

string No

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

Response Formats

{
  "TokenInfoResults": [
    {
      "TokenType": 0,
      "Eft": {
        "RoutingNumber": "sample string 1",
        "LastFourDigits": "sample string 2",
        "Type": 0,
        "CustomerName": "sample string 3"
      },
      "CreditCard": {
        "LastFourDigits": "sample string 1",
        "Type": 0,
        "ExpirationYear": 1,
        "ExpirationMonth": 1,
        "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"
        },
        "BaseCardType": 0
      },
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "TransactionId": "sample string 1",
      "PaymentToken": "sample string 2"
    },
    {
      "TokenType": 0,
      "Eft": {
        "RoutingNumber": "sample string 1",
        "LastFourDigits": "sample string 2",
        "Type": 0,
        "CustomerName": "sample string 3"
      },
      "CreditCard": {
        "LastFourDigits": "sample string 1",
        "Type": 0,
        "ExpirationYear": 1,
        "ExpirationMonth": 1,
        "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"
        },
        "BaseCardType": 0
      },
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "TransactionId": "sample string 1",
      "PaymentToken": "sample string 2"
    }
  ],
  "ResponseCode": "sample string 1",
  "Message": "sample string 2"
}
<GetTokenInfoBatchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.PaymentToken">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 2</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 1</ResponseCode>
  <TokenInfoResults>
    <TokenInfo>
      <ClientReferenceData xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
        <d4p1:ClientReferenceData1>sample string 1</d4p1:ClientReferenceData1>
        <d4p1:ClientReferenceData2>sample string 2</d4p1:ClientReferenceData2>
        <d4p1:ClientReferenceData3>sample string 3</d4p1:ClientReferenceData3>
        <d4p1:ClientReferenceData4>sample string 4</d4p1:ClientReferenceData4>
        <d4p1:ClientReferenceData5>sample string 5</d4p1:ClientReferenceData5>
      </ClientReferenceData>
      <CreditCard>
        <BaseCardType>Undefined</BaseCardType>
        <ExpirationMonth>1</ExpirationMonth>
        <ExpirationYear>1</ExpirationYear>
        <Holder xmlns:d5p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
          <d5p1:Address>sample string 3</d5p1:Address>
          <d5p1:City>sample string 4</d5p1:City>
          <d5p1:Name>sample string 1</d5p1:Name>
          <d5p1:Phone>sample string 6</d5p1:Phone>
          <d5p1:State>sample string 5</d5p1:State>
          <d5p1:Zip>sample string 2</d5p1:Zip>
        </Holder>
        <LastFourDigits>sample string 1</LastFourDigits>
        <Type>Undefined</Type>
      </CreditCard>
      <Eft>
        <CustomerName>sample string 3</CustomerName>
        <LastFourDigits>sample string 2</LastFourDigits>
        <RoutingNumber>sample string 1</RoutingNumber>
        <Type>Undefined</Type>
      </Eft>
      <PaymentToken>sample string 2</PaymentToken>
      <TokenType>Undefined</TokenType>
      <TransactionId>sample string 1</TransactionId>
    </TokenInfo>
    <TokenInfo>
      <ClientReferenceData xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
        <d4p1:ClientReferenceData1>sample string 1</d4p1:ClientReferenceData1>
        <d4p1:ClientReferenceData2>sample string 2</d4p1:ClientReferenceData2>
        <d4p1:ClientReferenceData3>sample string 3</d4p1:ClientReferenceData3>
        <d4p1:ClientReferenceData4>sample string 4</d4p1:ClientReferenceData4>
        <d4p1:ClientReferenceData5>sample string 5</d4p1:ClientReferenceData5>
      </ClientReferenceData>
      <CreditCard>
        <BaseCardType>Undefined</BaseCardType>
        <ExpirationMonth>1</ExpirationMonth>
        <ExpirationYear>1</ExpirationYear>
        <Holder xmlns:d5p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
          <d5p1:Address>sample string 3</d5p1:Address>
          <d5p1:City>sample string 4</d5p1:City>
          <d5p1:Name>sample string 1</d5p1:Name>
          <d5p1:Phone>sample string 6</d5p1:Phone>
          <d5p1:State>sample string 5</d5p1:State>
          <d5p1:Zip>sample string 2</d5p1:Zip>
        </Holder>
        <LastFourDigits>sample string 1</LastFourDigits>
        <Type>Undefined</Type>
      </CreditCard>
      <Eft>
        <CustomerName>sample string 3</CustomerName>
        <LastFourDigits>sample string 2</LastFourDigits>
        <RoutingNumber>sample string 1</RoutingNumber>
        <Type>Undefined</Type>
      </Eft>
      <PaymentToken>sample string 2</PaymentToken>
      <TokenType>Undefined</TokenType>
      <TransactionId>sample string 1</TransactionId>
    </TokenInfo>
  </TokenInfoResults>
</GetTokenInfoBatchResponse>

POST api/PaymentToken/Remove

In case you want to delete a previously saved Credit Card or EFT payment method, you can remove the token that corresponds to it. Just provide the token you want to remove and your authentication key in your POST request, to delete the token.

MethodEndpoint
Remove https://stgapiprocessone.oneincsystems.com/api/PaymentToken/Remove

RemovePaymentTokenRequest

NameDescriptionTypeRequired*Additional information
Token

Payment token

string No
CustomerId

A customer id associated with transaction

string No
AuthenticationKey

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": "156a581f-f654-4dd2-8102-e843446079d1",
  "CustomerId": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <RemovePaymentTokenRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.PaymentToken">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <CustomerId i:nil="true" />
  <Token>156a581f-f654-4dd2-8102-e843446079d1</Token>
</RemovePaymentTokenRequest>

Response Information

RemovePaymentTokenResponse

NameDescriptionTypeRequired*Additional information
TransactionDate

Transaction date and time

date No
TimeZone

Short time zone name with daylight saving time suffix

string No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "TransactionDate": "2020-10-27T06:33:50",
  "TimeZone": "PDT",
  "ResponseCode": "Success",
  "Message": "Success"
}
<RemovePaymentTokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.PaymentToken">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2020-10-27T06:33:50</TransactionDate>
</RemovePaymentTokenResponse>

CreditCard

POST api/CreditCard/Save

This operation tokenizes all the required information about a credit card payment method. Once the card information is tokenized, you no longer have to provide us any sensitive credit card information. To initiate transactions with a tokenized card simply provide the token that is returned by our API.

MethodEndpoint
Save https://stgapiprocessone.oneincsystems.com/api/CreditCard/Save

SaveCreditCardRequest

NameDescriptionTypeRequired*Additional information
CreditCard

Credit card information

CreditCardDetails No
CallbackId

A callback id associated to save credit card transaction

string No
ClientReferenceData

Client reference data

ClientReferenceData No
CustomerId

A customer id associated with transaction

string No
AuthenticationKey

Instance authentication key

string Yes

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

CreditCardDetails

NameDescriptionTypeRequired*Additional information
ExpirationYear

Year of the expiration of the credit card

integer No
ExpirationMonth

Month of the expiration of the credit card

integer No
Holder

Card holder

Customer No
Number

Credit card number

string Yes
ValidationValue

Credit card CVV code

string No

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

Request Formats

 
                                
                                 {
  "CreditCard": {
    "ExpirationYear": 2020,
    "ExpirationMonth": 10,
    "Holder": {
      "Name": "John Stevens",
      "Zip": "12345",
      "Address": "test address",
      "City": null,
      "State": null,
      "Phone": null
    },
    "Number": "4012000033330026",
    "ValidationValue": "123"
  },
  "CallbackId": null,
  "ClientReferenceData": {
    "ClientReferenceData1": "1234",
    "ClientReferenceData2": "f088982e-3d95-4b6b-b180-98b0f3d0af49",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "CustomerId": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <SaveCreditCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <CallbackId i:nil="true" />
  <ClientReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
    <d2p1:ClientReferenceData1>1234</d2p1:ClientReferenceData1>
    <d2p1:ClientReferenceData2>f088982e-3d95-4b6b-b180-98b0f3d0af49</d2p1:ClientReferenceData2>
    <d2p1:ClientReferenceData3>Location</d2p1:ClientReferenceData3>
    <d2p1:ClientReferenceData4 i:nil="true" />
    <d2p1:ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <CreditCard>
    <ExpirationMonth>10</ExpirationMonth>
    <ExpirationYear>2020</ExpirationYear>
    <Holder xmlns:d3p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
      <d3p1:Address>test address</d3p1:Address>
      <d3p1:City i:nil="true" />
      <d3p1:Name>John Stevens</d3p1:Name>
      <d3p1:Phone i:nil="true" />
      <d3p1:State i:nil="true" />
      <d3p1:Zip>12345</d3p1:Zip>
    </Holder>
    <Number>4012000033330026</Number>
    <ValidationValue>123</ValidationValue>
  </CreditCard>
  <CustomerId i:nil="true" />
</SaveCreditCardRequest>

Response Information

SaveCreditCardResponse

NameDescriptionTypeRequired*Additional information
Token

ProcessOne payment token

string No
TokenCreationTime

Token creation date and time in merchant time zone

date No
TimeZone

Short time zone name with daylight saving time suffix

string No
BaseCardType

Base Credit Card type

CreditCardType No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "Token": "fb8a7178-1528-422d-94cd-78675e2a1ab5",
  "TokenCreationTime": "2020-10-27T06:33:51",
  "TimeZone": "PDT",
  "BaseCardType": 0,
  "ResponseCode": "Success",
  "Message": "Success"
}
<SaveCreditCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <BaseCardType>Undefined</BaseCardType>
  <TimeZone>PDT</TimeZone>
  <Token>fb8a7178-1528-422d-94cd-78675e2a1ab5</Token>
  <TokenCreationTime>2020-10-27T06:33:51</TokenCreationTime>
</SaveCreditCardResponse>

POST api/CreditCard/Update

This operation provides a way to update information about a previously saved credit card. Refer to the table and examples below to see what information can be updated without a need to generate a new token.

MethodEndpoint
Update https://stgapiprocessone.oneincsystems.com/api/CreditCard/Update

UpdateCreditCardRequest

NameDescriptionTypeRequired*Additional information
Token

Saved CreditCard token

string No
ExpirationYear

Year of the expiration of the credit card

integer No
ExpirationMonth

Month of the expiration of the credit card

integer No
ZipCode

CreditCard holder Zip code

string No
CreditCardNetworkType

Credit Card network type

CreditCardNetworkType No
HolderAddress

CreditCard holder address

string No
City

Customer City

string No
State

Customer State

string No
Phone

Customer Phone

string No
AuthenticationKey

Instance authentication key

string Yes

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

CreditCardNetworkType

Possible enumeration values:

NameValueDescription
Unknown

0

Unknown

Hybrid

1

Hybrid (Debit/Credit) card

Debit

2

Debit card

Credit

3

Credit card

Request Formats

 
                                
                                 {
  "Token": "d526a7a3-895d-437d-9b2c-3179a7562330",
  "ExpirationYear": 2020,
  "ExpirationMonth": 10,
  "ZipCode": "12345",
  "CreditCardNetworkType": 3,
  "HolderAddress": null,
  "City": null,
  "State": null,
  "Phone": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <UpdateCreditCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <City i:nil="true" />
  <CreditCardNetworkType>Credit</CreditCardNetworkType>
  <ExpirationMonth>10</ExpirationMonth>
  <ExpirationYear>2020</ExpirationYear>
  <HolderAddress i:nil="true" />
  <Phone i:nil="true" />
  <State i:nil="true" />
  <Token>d526a7a3-895d-437d-9b2c-3179a7562330</Token>
  <ZipCode>12345</ZipCode>
</UpdateCreditCardRequest>

Response Information

UpdateCreditCardResponse

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

Message

Response message

string No

Message 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": null,
  "UpdateTime": null,
  "ResponseCode": "Success",
  "Message": "Success"
}
<UpdateCreditCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <TimeZone i:nil="true" />
  <UpdateTime i:nil="true" />
</UpdateCreditCardResponse>

POST api/CreditCard/Charge

This operation allows making a payment with a given credit card, which initiates a transfer of money from a particular customer account to the merchant account. You either have to provide a valid token or include credit card information in your request.

MethodEndpoint
Charge https://stgapiprocessone.oneincsystems.com/api/CreditCard/Charge

ChargeCreditCardRequest

NameDescriptionTypeRequired*Additional information
Amount

Charge amount

decimal number Yes
ChargeFee

Should we charge with fee (default - true)

boolean No
Token

Saved CreditCard token

string No
CreditCard

Either CreditCard or token parameter is required. If both are sent, token will be used

CreditCardDetails No
ClientReferenceData

Client reference data

ClientReferenceData No
IsRecurring

Is recurring charge

boolean No
AccountGroupCode

Account group code

string No
CallbackId

A callback id associated to charge credit card transaction

string No
Save

Enables to save and tokenize credit card information

boolean No
ConvenienceFeeType

Customizable convenience fee type that is matched with different types of transactions

string No
CustomerId

A customer id associated with transaction

string No
SplitPayGroupId

A unique number to transactions that are part of "split pay"

string No
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "Amount": 20.0,
  "ChargeFee": true,
  "Token": null,
  "CreditCard": {
    "ExpirationYear": 2020,
    "ExpirationMonth": 10,
    "Holder": {
      "Name": "John Stevens",
      "Zip": "12345",
      "Address": "test address",
      "City": null,
      "State": null,
      "Phone": null
    },
    "Number": "4012000033330026",
    "ValidationValue": "123"
  },
  "ClientReferenceData": {
    "ClientReferenceData1": "1234",
    "ClientReferenceData2": "2412923f-f93c-484f-b35d-13de2bed4d37",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "IsRecurring": false,
  "AccountGroupCode": "Default",
  "CallbackId": null,
  "Save": false,
  "ConvenienceFeeType": null,
  "CustomerId": null,
  "SplitPayGroupId": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <ChargeCreditCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <AccountGroupCode>Default</AccountGroupCode>
  <Amount>20.00</Amount>
  <CallbackId i:nil="true" />
  <ChargeFee>true</ChargeFee>
  <ClientReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
    <d2p1:ClientReferenceData1>1234</d2p1:ClientReferenceData1>
    <d2p1:ClientReferenceData2>2412923f-f93c-484f-b35d-13de2bed4d37</d2p1:ClientReferenceData2>
    <d2p1:ClientReferenceData3>Location</d2p1:ClientReferenceData3>
    <d2p1:ClientReferenceData4 i:nil="true" />
    <d2p1:ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <ConvenienceFeeType i:nil="true" />
  <CreditCard>
    <ExpirationMonth>10</ExpirationMonth>
    <ExpirationYear>2020</ExpirationYear>
    <Holder xmlns:d3p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
      <d3p1:Address>test address</d3p1:Address>
      <d3p1:City i:nil="true" />
      <d3p1:Name>John Stevens</d3p1:Name>
      <d3p1:Phone i:nil="true" />
      <d3p1:State i:nil="true" />
      <d3p1:Zip>12345</d3p1:Zip>
    </Holder>
    <Number>4012000033330026</Number>
    <ValidationValue>123</ValidationValue>
  </CreditCard>
  <CustomerId i:nil="true" />
  <IsRecurring>false</IsRecurring>
  <Save>false</Save>
  <SplitPayGroupId i:nil="true" />
  <Token i:nil="true" />
</ChargeCreditCardRequest>

Response Information

ChargeCreditCardResponse

NameDescriptionTypeRequired*Additional information
Token

ProcessOne payment token

string No
TransactionId

Transaction ID

string No
TransactionDate

Transaction date and time

date No
TimeZone

Transaction time zone

string No
AuthorizationCode

A gateway Authorization Code

string No
BatchNumber

Number of the batch

integer No
CreditCardType

Credit Card type

CreditCardType No
HolderName

Card Holder Name

string No
HolderZip

Card Holder Zip code

string No
BaseCardType

Base Credit Card type

CreditCardType No
PostedAmount

Transaction Posted Amount

decimal number No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "Token": null,
  "TransactionId": null,
  "TransactionDate": "2020-10-27T06:33:52",
  "TimeZone": "PDT",
  "AuthorizationCode": null,
  "BatchNumber": 0,
  "CreditCardType": 1,
  "HolderName": "John Stevens",
  "HolderZip": "12345",
  "BaseCardType": 0,
  "PostedAmount": 0.0,
  "ResponseCode": "Success",
  "Message": "Success"
}
<ChargeCreditCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <AuthorizationCode i:nil="true" />
  <BaseCardType>Undefined</BaseCardType>
  <BatchNumber>0</BatchNumber>
  <CreditCardType>Visa</CreditCardType>
  <HolderName>John Stevens</HolderName>
  <HolderZip>12345</HolderZip>
  <PostedAmount>0</PostedAmount>
  <TimeZone>PDT</TimeZone>
  <Token i:nil="true" />
  <TransactionDate>2020-10-27T06:33:52</TransactionDate>
  <TransactionId i:nil="true" />
</ChargeCreditCardResponse>

POST api/CreditCard/Void

This operation provides a way to void or cancel a previously made credit card payment that has not been fully processed yet. If a payment was already processed, a refund operation is required. You have to provide the transaction id of a transaction that you want to void. You can include a callback id if you prefer to get the information about a void transaction record by the callback id.

MethodEndpoint
Void https://stgapiprocessone.oneincsystems.com/api/CreditCard/Void

VoidCreditCardRequest

NameDescriptionTypeRequired*Additional information
TransactionId

An id of transaction to void

string Yes
CallbackId

A callback id associated to void transaction

string No
AuthenticationKey

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": "99992",
  "CallbackId": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <VoidCreditCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <CallbackId i:nil="true" />
  <TransactionId>99992</TransactionId>
</VoidCreditCardRequest>

Response Information

VoidCreditCardResponse

NameDescriptionTypeRequired*Additional information
TransactionId

An id of void transaction

string No
AuthorizationCode

A gateway AuthorizationCode

string No
BatchNumber

A batch number of void transaction

integer No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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": "99992",
  "AuthorizationCode": null,
  "BatchNumber": 0,
  "ResponseCode": "Success",
  "Message": "Success"
}
<VoidCreditCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <AuthorizationCode i:nil="true" />
  <BatchNumber>0</BatchNumber>
  <TransactionId>99992</TransactionId>
</VoidCreditCardResponse>

POST api/CreditCard/Refund

This operation provides a way to refund a previously made credit card payment that has been fully processed. To initiate a refund, call this API operation and provide a valid transaction id. You can include a callback id if you prefer to get the information about the refund transaction record by the callback id. Note: As payment transactions cannot be refunded until after they have been settled, if the batch has not yet closed for the transaction id in the refund request, the system will automatically Void the payment.

MethodEndpoint
Refund https://stgapiprocessone.oneincsystems.com/api/CreditCard/Refund

RefundCreditCardRequest

NameDescriptionTypeRequired*Additional information
TransactionId

An id of transaction to refund

string Yes
CallbackId

A callback id associated to refund transaction

string No
PartialRefundAmount

Amount to refund

decimal number No
AuthenticationKey

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": "99992",
  "CallbackId": null,
  "PartialRefundAmount": 10.0,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <RefundCreditCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <CallbackId i:nil="true" />
  <PartialRefundAmount>10</PartialRefundAmount>
  <TransactionId>99992</TransactionId>
</RefundCreditCardRequest>

Response Information

RefundCreditCardResponse

NameDescriptionTypeRequired*Additional information
TransactionId

An id of refund transaction

string No
AuthorizationCode

A gateway AuthorizationCode

string No
BatchNumber

A batch number of refund transaction

integer No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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": "99992",
  "AuthorizationCode": null,
  "BatchNumber": 0,
  "ResponseCode": "Success",
  "Message": "Success"
}
<RefundCreditCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <AuthorizationCode i:nil="true" />
  <BatchNumber>0</BatchNumber>
  <TransactionId>99992</TransactionId>
</RefundCreditCardResponse>

POST api/CreditCard/Verify

This operation verifies that a provided credit card information represents an existing and valid credit card.

MethodEndpoint
Verify https://stgapiprocessone.oneincsystems.com/api/CreditCard/Verify

VerifyCreditCardRequest

NameDescriptionTypeRequired*Additional information
CreditCard

Credit card information

CreditCardDetails No
CallbackId

A callback id associated with this transaction

string No
ClientReferenceData

Client reference data

ClientReferenceData No
CustomerId

A customer id associated with transaction

string No
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "CreditCard": {
    "ExpirationYear": 2020,
    "ExpirationMonth": 10,
    "Holder": {
      "Name": "John Stevens",
      "Zip": "12345",
      "Address": "test address",
      "City": null,
      "State": null,
      "Phone": null
    },
    "Number": "4012000033330026",
    "ValidationValue": "123"
  },
  "CallbackId": null,
  "ClientReferenceData": {
    "ClientReferenceData1": "1234",
    "ClientReferenceData2": "570a5b14-1474-43bb-9dc8-bd431e38c141",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "CustomerId": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <VerifyCreditCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <CallbackId i:nil="true" />
  <ClientReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
    <d2p1:ClientReferenceData1>1234</d2p1:ClientReferenceData1>
    <d2p1:ClientReferenceData2>570a5b14-1474-43bb-9dc8-bd431e38c141</d2p1:ClientReferenceData2>
    <d2p1:ClientReferenceData3>Location</d2p1:ClientReferenceData3>
    <d2p1:ClientReferenceData4 i:nil="true" />
    <d2p1:ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <CreditCard>
    <ExpirationMonth>10</ExpirationMonth>
    <ExpirationYear>2020</ExpirationYear>
    <Holder xmlns:d3p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
      <d3p1:Address>test address</d3p1:Address>
      <d3p1:City i:nil="true" />
      <d3p1:Name>John Stevens</d3p1:Name>
      <d3p1:Phone i:nil="true" />
      <d3p1:State i:nil="true" />
      <d3p1:Zip>12345</d3p1:Zip>
    </Holder>
    <Number>4012000033330026</Number>
    <ValidationValue>123</ValidationValue>
  </CreditCard>
  <CustomerId i:nil="true" />
</VerifyCreditCardRequest>

Response Information

VerifyCreditCardResponse

NameDescriptionTypeRequired*Additional information
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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",
  "Message": "Success"
}
<VerifyCreditCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
</VerifyCreditCardResponse>

POST api/CreditCard/GetCardData

This operation returns information about a specified credit card by the card number.

MethodEndpoint
GetCardData https://stgapiprocessone.oneincsystems.com/api/CreditCard/GetCardData

GetCardDataRequest

NameDescriptionTypeRequired*Additional information
CreditCardNumber

Credit card number

string Yes
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "CreditCardNumber": "4444444444444448",
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <GetCardDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <CreditCardNumber>4444444444444448</CreditCardNumber>
</GetCardDataRequest>

Response Information

GetCardDataResponse

NameDescriptionTypeRequired*Additional information
BaseCardType

Base Credit Card type

CreditCardType No
CreditCardNetworkType

Credit Card network type

CreditCardNetworkType No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "BaseCardType": 1,
  "CreditCardNetworkType": 2,
  "ResponseCode": "Success",
  "Message": "Success"
}
<GetCardDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <BaseCardType>Visa</BaseCardType>
  <CreditCardNetworkType>Debit</CreditCardNetworkType>
</GetCardDataResponse>

POST api/CreditCard/GetConvenienceFee

This operation returns the credit card convenience fee amount that corresponds to the specified fee type and dollar amount. If fee type is not provided, the API will return the default convenience fee type for your merchant. Convenience fee types vary from merchant to merchant and have to be addressed during contract negotiation.

MethodEndpoint
GetConvenienceFee https://stgapiprocessone.oneincsystems.com/api/CreditCard/GetConvenienceFee

ConvenienceFeeRequest

NameDescriptionTypeRequired*Additional information
Amount

Charge amount for fee calculation

decimal number No
ConvenienceFeeType

Customizable convenience fee type that is matched with different types of transactions

string No
IsRecurring

Is recurring Convenience Fee

boolean No
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "Amount": 100.0,
  "ConvenienceFeeType": null,
  "IsRecurring": false,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <ConvenienceFeeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <Amount>100</Amount>
  <ConvenienceFeeType i:nil="true" />
  <IsRecurring>false</IsRecurring>
</ConvenienceFeeRequest>

Response Information

ConvenienceFeeResponse

NameDescriptionTypeRequired*Additional information
ConvenienceFee

Amount of convenience fee

decimal number No
CalculationType

Fee calculation type for current fee tier

string No
FlatRate

Flat rate for fee tier, applicable for CalculationType = FlatRate

decimal number No
Percent

Percent rate for fee tier, applicable for CalculationType = Percent

decimal number No
MinimumAmount

Minimum fee amount, applicable for CalculationType = Percent

decimal number No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "ConvenienceFee": 1.0,
  "CalculationType": null,
  "FlatRate": null,
  "Percent": null,
  "MinimumAmount": null,
  "ResponseCode": "Success",
  "Message": "Success"
}
<ConvenienceFeeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <CalculationType i:nil="true" />
  <ConvenienceFee>1</ConvenienceFee>
  <FlatRate i:nil="true" />
  <MinimumAmount i:nil="true" />
  <Percent i:nil="true" />
</ConvenienceFeeResponse>

POST api/CreditCard/GetAcceptedCardTypes

This operation returns the list of accepted by merchant card types .

MethodEndpoint
GetAcceptedCardTypes https://stgapiprocessone.oneincsystems.com/api/CreditCard/GetAcceptedCardTypes

GetAcceptedCardTypesRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <GetAcceptedCardTypesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
</GetAcceptedCardTypesRequest>

Response Information

GetAcceptedCardTypesResponse

NameDescriptionTypeRequired*Additional information
AcceptedCardTypes

List of Accepted Card Types

Collection of CreditCardType No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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.

ListOfCreditCardType

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

Response Formats

{
  "AcceptedCardTypes": [
    3,
    4,
    2
  ],
  "ResponseCode": "Success",
  "Message": "Success"
}
<GetAcceptedCardTypesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <AcceptedCardTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.Enums">
    <d2p1:CreditCardType>AmericanExpress</d2p1:CreditCardType>
    <d2p1:CreditCardType>Discover</d2p1:CreditCardType>
    <d2p1:CreditCardType>MasterCard</d2p1:CreditCardType>
  </AcceptedCardTypes>
</GetAcceptedCardTypesResponse>

POST api/CreditCard/GetCardUpdates

This operation allows customer policy systems to extract credit card information that has been updated by Evergreen service

MethodEndpoint
GetCardUpdates https://stgapiprocessone.oneincsystems.com/api/CreditCard/GetCardUpdates

GetCardUpdatesRequest

NameDescriptionTypeRequired*Additional information
QueryAuthenticationKeys

Authentication keys to limit search query

Collection of string No
StartDate

Start date

date Yes
EndDate

End date

date Yes
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "QueryAuthenticationKeys": [
    "sample string 1",
    "sample string 2"
  ],
  "StartDate": "2020-10-27T06:33:56",
  "EndDate": "2020-10-27T06:33:56",
  "AuthenticationKey": "sample string 1"
}
                                
                                 <GetCardUpdatesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 1</AuthenticationKey>
  <EndDate>2020-10-27T06:33:56.1088844-07:00</EndDate>
  <QueryAuthenticationKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </QueryAuthenticationKeys>
  <StartDate>2020-10-27T06:33:56.1088844-07:00</StartDate>
</GetCardUpdatesRequest>

Response Information

GetCardUpdatesResponse

NameDescriptionTypeRequired*Additional information
CardData

Credit Cards information array

Collection of CardData No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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.

CardData

NameDescriptionTypeRequired*Additional information
ProcessOneToken

One Inc Token ID. Used for mapping updated token data to appropriate token.

string No
CardType

Credit Card Type.

CreditCardType No
LastFourDigits

Last Four Digits of credit card number.

string No
CardExpirationYear

Credit Card Expiration Month

integer No
CardExpirationMonth

Credit Card Expiration Month

integer No
CustomerName

Customer Name (name on card)

string No
UpdateDate

Update date of associated credit card update transaction

date No
UpdateTransactionId

Transaction ID of credit card update transaction

string No

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

Response Formats

{
  "CardData": [
    {
      "ProcessOneToken": "sample string 1",
      "CardType": 0,
      "LastFourDigits": "sample string 2",
      "CardExpirationYear": 3,
      "CardExpirationMonth": 4,
      "CustomerName": "sample string 5",
      "UpdateDate": "2020-10-27T06:33:56",
      "UpdateTransactionId": "sample string 7"
    },
    {
      "ProcessOneToken": "sample string 1",
      "CardType": 0,
      "LastFourDigits": "sample string 2",
      "CardExpirationYear": 3,
      "CardExpirationMonth": 4,
      "CustomerName": "sample string 5",
      "UpdateDate": "2020-10-27T06:33:56",
      "UpdateTransactionId": "sample string 7"
    }
  ],
  "ResponseCode": "sample string 1",
  "Message": "sample string 2"
}
<GetCardUpdatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.CreditCard">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 2</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 1</ResponseCode>
  <CardData>
    <CardData>
      <CardExpirationMonth>4</CardExpirationMonth>
      <CardExpirationYear>3</CardExpirationYear>
      <CardType>Undefined</CardType>
      <CustomerName>sample string 5</CustomerName>
      <LastFourDigits>sample string 2</LastFourDigits>
      <ProcessOneToken>sample string 1</ProcessOneToken>
      <UpdateDate>2020-10-27T06:33:56.1244853-07:00</UpdateDate>
      <UpdateTransactionId>sample string 7</UpdateTransactionId>
    </CardData>
    <CardData>
      <CardExpirationMonth>4</CardExpirationMonth>
      <CardExpirationYear>3</CardExpirationYear>
      <CardType>Undefined</CardType>
      <CustomerName>sample string 5</CustomerName>
      <LastFourDigits>sample string 2</LastFourDigits>
      <ProcessOneToken>sample string 1</ProcessOneToken>
      <UpdateDate>2020-10-27T06:33:56.1244853-07:00</UpdateDate>
      <UpdateTransactionId>sample string 7</UpdateTransactionId>
    </CardData>
  </CardData>
</GetCardUpdatesResponse>

HealthStatus

POST api/HealthStatus/Check

The easiest way to make sure you have a solid connection to our API is to check API health status. All you need is a valid authentication key.

MethodEndpoint
Check https://stgapiprocessone.oneincsystems.com/api/HealthStatus/Check

CheckHealthStatusRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <CheckHealthStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.HealthStatus">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
</CheckHealthStatusRequest>

Response Information

CheckHealthStatusResponse

NameDescriptionTypeRequired*Additional information
IsAlive

Is service alive

boolean No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "IsAlive": true,
  "ResponseCode": "Success",
  "Message": "Success"
}
<CheckHealthStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.HealthStatus">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <IsAlive>true</IsAlive>
</CheckHealthStatusResponse>

Transaction

POST api/Transaction/GetTransactionById

This operation provides detailed information about a particular, previously made, transaction. The API will look up the transaction by the Transaction ID that you provide in the body of the POST request. If a transaction ID cannot be found or if your authentication key is not valid. API will respond with an error message.

MethodEndpoint
GetTransactionById https://stgapiprocessone.oneincsystems.com/api/Transaction/GetTransactionById

GetTransactionByIdRequest

NameDescriptionTypeRequired*Additional information
TransactionId

A Transaction Id

string No
AuthenticationKey

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": "99991",
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <GetTransactionByIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <TransactionId>99991</TransactionId>
</GetTransactionByIdRequest>

Response Information

GetTransactionByIdResponse

NameDescriptionTypeRequired*Additional information
TransactionInformation

A transaction information

TransactionInformation No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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.

TransactionInformation

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction Id

string No
InternalReferenceTransactionId

Internal Reference Transaction Id

string No
OriginalAmount

Original amount of the transaction

decimal number No
PostedAmount

Posted amount of the transaction

decimal number No
TransactionType

Transaction type

TransactionType No
TransactionStatus

Transaction status

TransactionStatus No
PaymentDate

Payment date

date No
TimeZone

Client time zone

string No
CreditCardType

Credit card type

CreditCardType No
LastFourDigits

Last 4 digits of the credit card or the bank account

string No
RoutingNumber

Routing number

string No
AccountNumber

Account number

string No
BatchNumber

Batch number

integer No
InstanceName

Merchant instance name

string No
CustomerName

Customer name

string No
ClientReferenceData

Client extra data

ClientReferenceData No
ProcessOneToken

ProcessOne token

string No
CreditCardExpirationMonth

Credit card expiration month

integer No
CreditCardExpirationYear

Credit card expiration year

integer No
BankName

Bank name

string No
BankAccountType

Bank account type

EftAccountType No
ReturnReasonType

Return reason type

ReturnReasonType No
ReturnReasonCode

Return reason code

string No
BaseCardType

Base card type

CreditCardType No
AccountGroupCode

Account group code

string No
CustomerId

Customer Id

string No
CheckInformation

Check information

CheckInformation No

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

TransactionType

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

ChargeCreditCard

1

Charge by Credit Card

RefundCreditCard

2

Refund payment by Credit Card

VoidCreditCard

3

Void payment by Credit Card

CreditEft

5

Charge by credit electronic fund transfer

DebitEftNoFee

6

Charge by debit electronic fund transfer

VoidEft

7

Void EFT payment

ChargeBackDebit

9

Chargeback debit

ChargeBackCredit

10

Chargeback Credit

SaveCreditCard

11

Save CreditCard

RemoveSavedCreditCard

12

Remove saved Credit Card

RecurringChargeCreditCard

13

Recurring Credit Card Charge

ChargeCreditCardNoFee

14

Charge by Credit Card without fee

ReturnedEft

15

EFT Returned

AchDebitPassthrough

16

ACH Debit Pass-through

AchCreditPassthrough

17

ACH Credit Pass-through

RefundEft

18

EFT Refund

DebitSweepForEftCredit

19

EFT Debit Sweep For EFT Credit

AchReturnPassthrough

20

ACH Return Pass-through

SaveEft

21

Save EFT

DebitEft

22

EFT Debit

RecurringEft

23

Recurring EFT Payment

RemoveSavedEft

24

Remove Saved EFT

AdjustmentDebit

25

Adjustment Debit

AdjustmentCredit

26

Adjustment Credit

VoidAdjustment

27

Void Adjustment

VerifyCreditCard

28

Verify Credit Card

VerifyBankAccount

29

Verify Bank Account

CreditBankAccount

31

Credit Bank Account

VoidBankAccountCredit

32

Void Bank Account Credit

CreatePrepaidProfile

33

Create Prepaid Profile

UpdatePrepaidProfile

34

Update Prepaid Profile

LoadPrepaidAccount

35

Load Prepaid Account

ReversePrepaidAccountLoad

36

Reverse Prepaid AccountLoad

ReleaseLoadPrepaidAccount

37

Release Load Prepaid Account

DisbursePrepaidAccountEft

38

Disburse Prepaid Account Eft

DisbursePrepaidAccountCheck

39

Disburse Prepaid Account Check

ChangePrepaidAccountStatus

40

Change Prepaid Account Status

AddPrepaidCard

41

Add Prepaid Card

ChangePrepaidCardStatus

42

Change Prepaid Card Status

ReplacePrepaidCard

43

Replace Prepaid Card

ActivatePrepaidCard

44

Activate Prepaid Card

ReservePrepaidCard

45

Reserve Prepaid Card

LostStolenPrepaidCard

47

Lost Stolen Prepaid Card

OrderPrepaidCards

48

Order Prepaid Cards

ReturnedCreditBankAccount

49

Returned Credit Bank Account

PushToCard

50

Push To Card

IssueCheck

51

Issue Check

CancelCheck

52

Cancel Check

VoidedCheck

53

Void Check

ClearedCheck

54

Clear Check

RestoredCheck

55

Restore Check

IssueCheckExternal

56

Issue Check External

VoidCheckExternal

57

Void Check External

ClearCheckExternal

58

Clear Check External

PreNoteDebitBankAccount

59

EFT Debit PreNote

PreNoteCreditBankAccount

60

EFT Credit PreNote

TransactionStatus

Possible enumeration values:

NameValueDescription
Undefined

0

Transaction status is undefined

InProcess

1

Transaction has been started

Successful

2

Transaction has been processed successfully

Failed

3

Transaction failed

Voided

4

Transaction voided

Canceled

5

Transaction canceled

Reversed

6

Transaction reversed

CardReleased

7

Card released

Returned

8

Transaction returned

CheckRequested

9

Check requested

SystemVoided

10

System voided

Issued

11

Issued

ReturnReasonType

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

ChargebackCredit

1

Chargeback Credit

Eft

2

Eft

CheckInformation

NameDescriptionTypeRequired*Additional information
CheckNumber

Check number

string No
CheckStatus

Check status

CheckStatus No
CheckMemo

Check memo

string No
ShipToAddress

Ship to address

ShipToAddress No
CheckTrackingNumber

Check tracking number

string No
CheckTrackingUrl

Check tracking URL

string No
CheckBatchId

Check batch Id

integer No
CheckMailDeliveryType

Mail delivery type

MailDeliveryType No
IssuedDate

date No
ClearedDate

date No
VoidedDate

date No

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

CheckStatus

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

CheckRequested

1

Check Requested

Canceled

2

Canceled

InProcess

3

In process

Voided

4

Voided

Issued

5

Issued

Cleared

6

Cleared

ShipToAddress

NameDescriptionTypeRequired*Additional information
Name

Name

string No
Name2

Name2

string No
Attention

Attention

string No
Address

Address

string No
Address2

Address2

string No
City

City

string No
State

State

string No
Zip

Zip

string No
Country

Country

string No

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

MailDeliveryType

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

Standard

1

Standard

NextDay

2

Next Day

Response Formats

{
  "TransactionInformation": {
    "TransactionId": "99991",
    "InternalReferenceTransactionId": null,
    "OriginalAmount": 100.0,
    "PostedAmount": 100.0,
    "TransactionType": 5,
    "TransactionStatus": 2,
    "PaymentDate": "2020-10-27T06:33:57",
    "TimeZone": "PDT",
    "CreditCardType": 0,
    "LastFourDigits": "1234",
    "RoutingNumber": "123123123",
    "AccountNumber": "123123124",
    "BatchNumber": 11,
    "InstanceName": "merchant instance name",
    "CustomerName": "John Stevens",
    "ClientReferenceData": {
      "ClientReferenceData1": "1234",
      "ClientReferenceData2": null,
      "ClientReferenceData3": "test address",
      "ClientReferenceData4": null,
      "ClientReferenceData5": null
    },
    "ProcessOneToken": null,
    "CreditCardExpirationMonth": null,
    "CreditCardExpirationYear": null,
    "BankName": null,
    "BankAccountType": 0,
    "ReturnReasonType": null,
    "ReturnReasonCode": null,
    "BaseCardType": null,
    "AccountGroupCode": null,
    "CustomerId": null,
    "CheckInformation": null
  },
  "ResponseCode": "Success",
  "Message": "Success"
}
<GetTransactionByIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <TransactionInformation>
    <AccountGroupCode i:nil="true" />
    <AccountNumber>123123124</AccountNumber>
    <BankAccountType>Undefined</BankAccountType>
    <BankName i:nil="true" />
    <BaseCardType i:nil="true" />
    <BatchNumber>11</BatchNumber>
    <CheckInformation i:nil="true" />
    <ClientReferenceData xmlns:d3p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
      <d3p1:ClientReferenceData1>1234</d3p1:ClientReferenceData1>
      <d3p1:ClientReferenceData2 i:nil="true" />
      <d3p1:ClientReferenceData3>test address</d3p1:ClientReferenceData3>
      <d3p1:ClientReferenceData4 i:nil="true" />
      <d3p1:ClientReferenceData5 i:nil="true" />
    </ClientReferenceData>
    <CreditCardExpirationMonth i:nil="true" />
    <CreditCardExpirationYear i:nil="true" />
    <CreditCardType>Undefined</CreditCardType>
    <CustomerId i:nil="true" />
    <CustomerName>John Stevens</CustomerName>
    <InstanceName>merchant instance name</InstanceName>
    <InternalReferenceTransactionId i:nil="true" />
    <LastFourDigits>1234</LastFourDigits>
    <OriginalAmount>100</OriginalAmount>
    <PaymentDate>2020-10-27T06:33:57</PaymentDate>
    <PostedAmount>100</PostedAmount>
    <ProcessOneToken i:nil="true" />
    <ReturnReasonCode i:nil="true" />
    <ReturnReasonType i:nil="true" />
    <RoutingNumber>123123123</RoutingNumber>
    <TimeZone>PDT</TimeZone>
    <TransactionId>99991</TransactionId>
    <TransactionStatus>Successful</TransactionStatus>
    <TransactionType>CreditEft</TransactionType>
  </TransactionInformation>
</GetTransactionByIdResponse>

POST api/Transaction/GetTransactionByCallbackId

This operation provides a detailed information about a particular, previously made, transaction. A Callback ID is used to look up the transaction. Like other operations, a valid and existing callback id has to be provided in the request.

MethodEndpoint
GetTransactionByCallbackId https://stgapiprocessone.oneincsystems.com/api/Transaction/GetTransactionByCallbackId

GetTransactionByCallbackIdRequest

NameDescriptionTypeRequired*Additional information
CallbackId

A Transaction Callback Id

string Yes
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "CallbackId": "123",
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <GetTransactionByCallbackIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <CallbackId>123</CallbackId>
</GetTransactionByCallbackIdRequest>

Response Information

GetTransactionByCallbackIdResponse

NameDescriptionTypeRequired*Additional information
TransactionInformation

A transaction information

TransactionInformation No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "TransactionInformation": {
    "TransactionId": "1579",
    "InternalReferenceTransactionId": null,
    "OriginalAmount": 100.0,
    "PostedAmount": 100.0,
    "TransactionType": 5,
    "TransactionStatus": 2,
    "PaymentDate": "2020-10-27T06:33:57",
    "TimeZone": "PDT",
    "CreditCardType": 0,
    "LastFourDigits": "1234",
    "RoutingNumber": "123123123",
    "AccountNumber": "123123124",
    "BatchNumber": 11,
    "InstanceName": "merchant instance name",
    "CustomerName": "John Stevens",
    "ClientReferenceData": {
      "ClientReferenceData1": "1234",
      "ClientReferenceData2": null,
      "ClientReferenceData3": "test address",
      "ClientReferenceData4": null,
      "ClientReferenceData5": null
    },
    "ProcessOneToken": null,
    "CreditCardExpirationMonth": null,
    "CreditCardExpirationYear": null,
    "BankName": null,
    "BankAccountType": 0,
    "ReturnReasonType": null,
    "ReturnReasonCode": null,
    "BaseCardType": null,
    "AccountGroupCode": null,
    "CustomerId": null,
    "CheckInformation": null
  },
  "ResponseCode": "Success",
  "Message": "Success"
}
<GetTransactionByCallbackIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <TransactionInformation>
    <AccountGroupCode i:nil="true" />
    <AccountNumber>123123124</AccountNumber>
    <BankAccountType>Undefined</BankAccountType>
    <BankName i:nil="true" />
    <BaseCardType i:nil="true" />
    <BatchNumber>11</BatchNumber>
    <CheckInformation i:nil="true" />
    <ClientReferenceData xmlns:d3p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
      <d3p1:ClientReferenceData1>1234</d3p1:ClientReferenceData1>
      <d3p1:ClientReferenceData2 i:nil="true" />
      <d3p1:ClientReferenceData3>test address</d3p1:ClientReferenceData3>
      <d3p1:ClientReferenceData4 i:nil="true" />
      <d3p1:ClientReferenceData5 i:nil="true" />
    </ClientReferenceData>
    <CreditCardExpirationMonth i:nil="true" />
    <CreditCardExpirationYear i:nil="true" />
    <CreditCardType>Undefined</CreditCardType>
    <CustomerId i:nil="true" />
    <CustomerName>John Stevens</CustomerName>
    <InstanceName>merchant instance name</InstanceName>
    <InternalReferenceTransactionId i:nil="true" />
    <LastFourDigits>1234</LastFourDigits>
    <OriginalAmount>100</OriginalAmount>
    <PaymentDate>2020-10-27T06:33:57</PaymentDate>
    <PostedAmount>100</PostedAmount>
    <ProcessOneToken i:nil="true" />
    <ReturnReasonCode i:nil="true" />
    <ReturnReasonType i:nil="true" />
    <RoutingNumber>123123123</RoutingNumber>
    <TimeZone>PDT</TimeZone>
    <TransactionId>1579</TransactionId>
    <TransactionStatus>Successful</TransactionStatus>
    <TransactionType>CreditEft</TransactionType>
  </TransactionInformation>
</GetTransactionByCallbackIdResponse>

POST api/Transaction/GetTransactionsByBatchId

This operation provides a detailed information about all transactions that are included in the same batch with a specific batch id. In addition to your personal authentication key, you need to provide one or more authentication keys which will be used to filter transactions. Check transactions are not included in a batch id.

MethodEndpoint
GetTransactionsByBatchId https://stgapiprocessone.oneincsystems.com/api/Transaction/GetTransactionsByBatchId

GetTransactionsByBatchIdRequest

NameDescriptionTypeRequired*Additional information
QueryAuthenticationKeys

Authentication keys to limit search query

Collection of string Yes
BatchId

A Transaction Batch Id

string No
TransactionStatuses

Transaction statuses to limit search query

Collection of TransactionStatus No
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "QueryAuthenticationKeys": [
    "Authentication Key",
    "e49e52c5-51fb-4ad2-a6bd-96a0a7ae2cbc"
  ],
  "BatchId": "11",
  "TransactionStatuses": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <GetTransactionsByBatchIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <BatchId>11</BatchId>
  <QueryAuthenticationKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Authentication Key</d2p1:string>
    <d2p1:string>e49e52c5-51fb-4ad2-a6bd-96a0a7ae2cbc</d2p1:string>
  </QueryAuthenticationKeys>
  <TransactionStatuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.Enums" i:nil="true" />
</GetTransactionsByBatchIdRequest>

Response Information

GetTransactionsByBatchIdResponse

NameDescriptionTypeRequired*Additional information
Transactions

A transactions information

Collection of TransactionInformation No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "Transactions": [
    {
      "TransactionId": "1577",
      "InternalReferenceTransactionId": null,
      "OriginalAmount": 100.0,
      "PostedAmount": 100.0,
      "TransactionType": 5,
      "TransactionStatus": 2,
      "PaymentDate": "2020-10-27T06:33:58",
      "TimeZone": "PDT",
      "CreditCardType": 0,
      "LastFourDigits": "1234",
      "RoutingNumber": "123123123",
      "AccountNumber": "123123124",
      "BatchNumber": 11,
      "InstanceName": "merchant instance name",
      "CustomerName": "John Stevens",
      "ClientReferenceData": {
        "ClientReferenceData1": "1234",
        "ClientReferenceData2": null,
        "ClientReferenceData3": "test address",
        "ClientReferenceData4": null,
        "ClientReferenceData5": null
      },
      "ProcessOneToken": null,
      "CreditCardExpirationMonth": null,
      "CreditCardExpirationYear": null,
      "BankName": null,
      "BankAccountType": 0,
      "ReturnReasonType": null,
      "ReturnReasonCode": null,
      "BaseCardType": null,
      "AccountGroupCode": null,
      "CustomerId": null,
      "CheckInformation": null
    },
    {
      "TransactionId": "1578",
      "InternalReferenceTransactionId": null,
      "OriginalAmount": 100.0,
      "PostedAmount": 100.0,
      "TransactionType": 5,
      "TransactionStatus": 2,
      "PaymentDate": "2020-10-27T06:33:58",
      "TimeZone": "PDT",
      "CreditCardType": 0,
      "LastFourDigits": "1234",
      "RoutingNumber": "123123123",
      "AccountNumber": "123123124",
      "BatchNumber": 11,
      "InstanceName": "merchant instance name",
      "CustomerName": "John Stevens",
      "ClientReferenceData": {
        "ClientReferenceData1": "1234",
        "ClientReferenceData2": null,
        "ClientReferenceData3": "test address",
        "ClientReferenceData4": null,
        "ClientReferenceData5": null
      },
      "ProcessOneToken": null,
      "CreditCardExpirationMonth": null,
      "CreditCardExpirationYear": null,
      "BankName": null,
      "BankAccountType": 0,
      "ReturnReasonType": null,
      "ReturnReasonCode": null,
      "BaseCardType": null,
      "AccountGroupCode": null,
      "CustomerId": null,
      "CheckInformation": null
    }
  ],
  "ResponseCode": "Success",
  "Message": "Success"
}
<GetTransactionsByBatchIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <Transactions>
    <TransactionInformation>
      <AccountGroupCode i:nil="true" />
      <AccountNumber>123123124</AccountNumber>
      <BankAccountType>Undefined</BankAccountType>
      <BankName i:nil="true" />
      <BaseCardType i:nil="true" />
      <BatchNumber>11</BatchNumber>
      <CheckInformation i:nil="true" />
      <ClientReferenceData xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
        <d4p1:ClientReferenceData1>1234</d4p1:ClientReferenceData1>
        <d4p1:ClientReferenceData2 i:nil="true" />
        <d4p1:ClientReferenceData3>test address</d4p1:ClientReferenceData3>
        <d4p1:ClientReferenceData4 i:nil="true" />
        <d4p1:ClientReferenceData5 i:nil="true" />
      </ClientReferenceData>
      <CreditCardExpirationMonth i:nil="true" />
      <CreditCardExpirationYear i:nil="true" />
      <CreditCardType>Undefined</CreditCardType>
      <CustomerId i:nil="true" />
      <CustomerName>John Stevens</CustomerName>
      <InstanceName>merchant instance name</InstanceName>
      <InternalReferenceTransactionId i:nil="true" />
      <LastFourDigits>1234</LastFourDigits>
      <OriginalAmount>100</OriginalAmount>
      <PaymentDate>2020-10-27T06:33:58.6653969-07:00</PaymentDate>
      <PostedAmount>100</PostedAmount>
      <ProcessOneToken i:nil="true" />
      <ReturnReasonCode i:nil="true" />
      <ReturnReasonType i:nil="true" />
      <RoutingNumber>123123123</RoutingNumber>
      <TimeZone>PDT</TimeZone>
      <TransactionId>1577</TransactionId>
      <TransactionStatus>Successful</TransactionStatus>
      <TransactionType>CreditEft</TransactionType>
    </TransactionInformation>
    <TransactionInformation>
      <AccountGroupCode i:nil="true" />
      <AccountNumber>123123124</AccountNumber>
      <BankAccountType>Undefined</BankAccountType>
      <BankName i:nil="true" />
      <BaseCardType i:nil="true" />
      <BatchNumber>11</BatchNumber>
      <CheckInformation i:nil="true" />
      <ClientReferenceData xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
        <d4p1:ClientReferenceData1>1234</d4p1:ClientReferenceData1>
        <d4p1:ClientReferenceData2 i:nil="true" />
        <d4p1:ClientReferenceData3>test address</d4p1:ClientReferenceData3>
        <d4p1:ClientReferenceData4 i:nil="true" />
        <d4p1:ClientReferenceData5 i:nil="true" />
      </ClientReferenceData>
      <CreditCardExpirationMonth i:nil="true" />
      <CreditCardExpirationYear i:nil="true" />
      <CreditCardType>Undefined</CreditCardType>
      <CustomerId i:nil="true" />
      <CustomerName>John Stevens</CustomerName>
      <InstanceName>merchant instance name</InstanceName>
      <InternalReferenceTransactionId i:nil="true" />
      <LastFourDigits>1234</LastFourDigits>
      <OriginalAmount>100</OriginalAmount>
      <PaymentDate>2020-10-27T06:33:58.6653969-07:00</PaymentDate>
      <PostedAmount>100</PostedAmount>
      <ProcessOneToken i:nil="true" />
      <ReturnReasonCode i:nil="true" />
      <ReturnReasonType i:nil="true" />
      <RoutingNumber>123123123</RoutingNumber>
      <TimeZone>PDT</TimeZone>
      <TransactionId>1578</TransactionId>
      <TransactionStatus>Successful</TransactionStatus>
      <TransactionType>CreditEft</TransactionType>
    </TransactionInformation>
  </Transactions>
</GetTransactionsByBatchIdResponse>

POST api/Transaction/GetCheckTransactionsByBatchId

This operation provides a detailed information about all check transactions that are included in the same check batch with a specific check batch id. In addition to your personal authentication key, you need to provide one or more authentication keys which will be used to filter transactions.

MethodEndpoint
GetCheckTransactionsByBatchId https://stgapiprocessone.oneincsystems.com/api/Transaction/GetCheckTransactionsByBatchId

GetCheckTransactionsByBatchIdRequest

NameDescriptionTypeRequired*Additional information
QueryAuthenticationKeys

Authentication keys to limit search query

Collection of string Yes
CheckBatchId

A Check Batch Id

string Yes
TransactionStatuses

Transaction statuses to limit search query

Collection of TransactionStatus No
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "QueryAuthenticationKeys": [
    "sample string 1",
    "sample string 2"
  ],
  "CheckBatchId": "sample string 1",
  "TransactionStatuses": [
    0,
    0
  ],
  "AuthenticationKey": "sample string 2"
}
                                
                                 <GetCheckTransactionsByBatchIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 2</AuthenticationKey>
  <CheckBatchId>sample string 1</CheckBatchId>
  <QueryAuthenticationKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </QueryAuthenticationKeys>
  <TransactionStatuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.Enums">
    <d2p1:TransactionStatus>Undefined</d2p1:TransactionStatus>
    <d2p1:TransactionStatus>Undefined</d2p1:TransactionStatus>
  </TransactionStatuses>
</GetCheckTransactionsByBatchIdRequest>

Response Information

GetCheckTransactionsByBatchIdResponse

NameDescriptionTypeRequired*Additional information
Transactions

A transactions information

Collection of TransactionInformation No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "Transactions": [
    {
      "TransactionId": "sample string 1",
      "InternalReferenceTransactionId": "sample string 2",
      "OriginalAmount": 3.0,
      "PostedAmount": 4.0,
      "TransactionType": 0,
      "TransactionStatus": 0,
      "PaymentDate": "2020-10-27T06:33:59",
      "TimeZone": "sample string 6",
      "CreditCardType": 0,
      "LastFourDigits": "sample string 7",
      "RoutingNumber": "sample string 8",
      "AccountNumber": "sample string 9",
      "BatchNumber": 10,
      "InstanceName": "sample string 11",
      "CustomerName": "sample string 12",
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "ProcessOneToken": "sample string 13",
      "CreditCardExpirationMonth": 1,
      "CreditCardExpirationYear": 1,
      "BankName": "sample string 14",
      "BankAccountType": 0,
      "ReturnReasonType": 0,
      "ReturnReasonCode": "sample string 15",
      "BaseCardType": 0,
      "AccountGroupCode": "sample string 16",
      "CustomerId": "sample string 17",
      "CheckInformation": {
        "CheckNumber": "sample string 1",
        "CheckStatus": 0,
        "CheckMemo": "sample string 2",
        "ShipToAddress": {
          "Name": "sample string 1",
          "Name2": "sample string 2",
          "Attention": "sample string 3",
          "Address": "sample string 4",
          "Address2": "sample string 5",
          "City": "sample string 6",
          "State": "sample string 7",
          "Zip": "sample string 8",
          "Country": "sample string 9"
        },
        "CheckTrackingNumber": "sample string 3",
        "CheckTrackingUrl": "sample string 4",
        "CheckBatchId": 5,
        "CheckMailDeliveryType": 0,
        "IssuedDate": "2020-10-27T06:33:59",
        "ClearedDate": "2020-10-27T06:33:59",
        "VoidedDate": "2020-10-27T06:33:59"
      }
    },
    {
      "TransactionId": "sample string 1",
      "InternalReferenceTransactionId": "sample string 2",
      "OriginalAmount": 3.0,
      "PostedAmount": 4.0,
      "TransactionType": 0,
      "TransactionStatus": 0,
      "PaymentDate": "2020-10-27T06:33:59",
      "TimeZone": "sample string 6",
      "CreditCardType": 0,
      "LastFourDigits": "sample string 7",
      "RoutingNumber": "sample string 8",
      "AccountNumber": "sample string 9",
      "BatchNumber": 10,
      "InstanceName": "sample string 11",
      "CustomerName": "sample string 12",
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "ProcessOneToken": "sample string 13",
      "CreditCardExpirationMonth": 1,
      "CreditCardExpirationYear": 1,
      "BankName": "sample string 14",
      "BankAccountType": 0,
      "ReturnReasonType": 0,
      "ReturnReasonCode": "sample string 15",
      "BaseCardType": 0,
      "AccountGroupCode": "sample string 16",
      "CustomerId": "sample string 17",
      "CheckInformation": {
        "CheckNumber": "sample string 1",
        "CheckStatus": 0,
        "CheckMemo": "sample string 2",
        "ShipToAddress": {
          "Name": "sample string 1",
          "Name2": "sample string 2",
          "Attention": "sample string 3",
          "Address": "sample string 4",
          "Address2": "sample string 5",
          "City": "sample string 6",
          "State": "sample string 7",
          "Zip": "sample string 8",
          "Country": "sample string 9"
        },
        "CheckTrackingNumber": "sample string 3",
        "CheckTrackingUrl": "sample string 4",
        "CheckBatchId": 5,
        "CheckMailDeliveryType": 0,
        "IssuedDate": "2020-10-27T06:33:59",
        "ClearedDate": "2020-10-27T06:33:59",
        "VoidedDate": "2020-10-27T06:33:59"
      }
    }
  ],
  "ResponseCode": "sample string 1",
  "Message": "sample string 2"
}
<GetCheckTransactionsByBatchIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 2</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 1</ResponseCode>
  <Transactions>
    <TransactionInformation>
      <AccountGroupCode>sample string 16</AccountGroupCode>
      <AccountNumber>sample string 9</AccountNumber>
      <BankAccountType>Undefined</BankAccountType>
      <BankName>sample string 14</BankName>
      <BaseCardType>Undefined</BaseCardType>
      <BatchNumber>10</BatchNumber>
      <CheckInformation>
        <CheckBatchId>5</CheckBatchId>
        <CheckMailDeliveryType>Undefined</CheckMailDeliveryType>
        <CheckMemo>sample string 2</CheckMemo>
        <CheckNumber>sample string 1</CheckNumber>
        <CheckStatus>Undefined</CheckStatus>
        <CheckTrackingNumber>sample string 3</CheckTrackingNumber>
        <CheckTrackingUrl>sample string 4</CheckTrackingUrl>
        <ClearedDate>2020-10-27T06:33:59.4489768-07:00</ClearedDate>
        <IssuedDate>2020-10-27T06:33:59.4489768-07:00</IssuedDate>
        <ShipToAddress>
          <Address>sample string 4</Address>
          <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>
        <VoidedDate>2020-10-27T06:33:59.4489768-07:00</VoidedDate>
      </CheckInformation>
      <ClientReferenceData xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
        <d4p1:ClientReferenceData1>sample string 1</d4p1:ClientReferenceData1>
        <d4p1:ClientReferenceData2>sample string 2</d4p1:ClientReferenceData2>
        <d4p1:ClientReferenceData3>sample string 3</d4p1:ClientReferenceData3>
        <d4p1:ClientReferenceData4>sample string 4</d4p1:ClientReferenceData4>
        <d4p1:ClientReferenceData5>sample string 5</d4p1:ClientReferenceData5>
      </ClientReferenceData>
      <CreditCardExpirationMonth>1</CreditCardExpirationMonth>
      <CreditCardExpirationYear>1</CreditCardExpirationYear>
      <CreditCardType>Undefined</CreditCardType>
      <CustomerId>sample string 17</CustomerId>
      <CustomerName>sample string 12</CustomerName>
      <InstanceName>sample string 11</InstanceName>
      <InternalReferenceTransactionId>sample string 2</InternalReferenceTransactionId>
      <LastFourDigits>sample string 7</LastFourDigits>
      <OriginalAmount>3</OriginalAmount>
      <PaymentDate>2020-10-27T06:33:59.4489768-07:00</PaymentDate>
      <PostedAmount>4</PostedAmount>
      <ProcessOneToken>sample string 13</ProcessOneToken>
      <ReturnReasonCode>sample string 15</ReturnReasonCode>
      <ReturnReasonType>Undefined</ReturnReasonType>
      <RoutingNumber>sample string 8</RoutingNumber>
      <TimeZone>sample string 6</TimeZone>
      <TransactionId>sample string 1</TransactionId>
      <TransactionStatus>Undefined</TransactionStatus>
      <TransactionType>Undefined</TransactionType>
    </TransactionInformation>
    <TransactionInformation>
      <AccountGroupCode>sample string 16</AccountGroupCode>
      <AccountNumber>sample string 9</AccountNumber>
      <BankAccountType>Undefined</BankAccountType>
      <BankName>sample string 14</BankName>
      <BaseCardType>Undefined</BaseCardType>
      <BatchNumber>10</BatchNumber>
      <CheckInformation>
        <CheckBatchId>5</CheckBatchId>
        <CheckMailDeliveryType>Undefined</CheckMailDeliveryType>
        <CheckMemo>sample string 2</CheckMemo>
        <CheckNumber>sample string 1</CheckNumber>
        <CheckStatus>Undefined</CheckStatus>
        <CheckTrackingNumber>sample string 3</CheckTrackingNumber>
        <CheckTrackingUrl>sample string 4</CheckTrackingUrl>
        <ClearedDate>2020-10-27T06:33:59.4489768-07:00</ClearedDate>
        <IssuedDate>2020-10-27T06:33:59.4489768-07:00</IssuedDate>
        <ShipToAddress>
          <Address>sample string 4</Address>
          <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>
        <VoidedDate>2020-10-27T06:33:59.4489768-07:00</VoidedDate>
      </CheckInformation>
      <ClientReferenceData xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
        <d4p1:ClientReferenceData1>sample string 1</d4p1:ClientReferenceData1>
        <d4p1:ClientReferenceData2>sample string 2</d4p1:ClientReferenceData2>
        <d4p1:ClientReferenceData3>sample string 3</d4p1:ClientReferenceData3>
        <d4p1:ClientReferenceData4>sample string 4</d4p1:ClientReferenceData4>
        <d4p1:ClientReferenceData5>sample string 5</d4p1:ClientReferenceData5>
      </ClientReferenceData>
      <CreditCardExpirationMonth>1</CreditCardExpirationMonth>
      <CreditCardExpirationYear>1</CreditCardExpirationYear>
      <CreditCardType>Undefined</CreditCardType>
      <CustomerId>sample string 17</CustomerId>
      <CustomerName>sample string 12</CustomerName>
      <InstanceName>sample string 11</InstanceName>
      <InternalReferenceTransactionId>sample string 2</InternalReferenceTransactionId>
      <LastFourDigits>sample string 7</LastFourDigits>
      <OriginalAmount>3</OriginalAmount>
      <PaymentDate>2020-10-27T06:33:59.4489768-07:00</PaymentDate>
      <PostedAmount>4</PostedAmount>
      <ProcessOneToken>sample string 13</ProcessOneToken>
      <ReturnReasonCode>sample string 15</ReturnReasonCode>
      <ReturnReasonType>Undefined</ReturnReasonType>
      <RoutingNumber>sample string 8</RoutingNumber>
      <TimeZone>sample string 6</TimeZone>
      <TransactionId>sample string 1</TransactionId>
      <TransactionStatus>Undefined</TransactionStatus>
      <TransactionType>Undefined</TransactionType>
    </TransactionInformation>
  </Transactions>
</GetCheckTransactionsByBatchIdResponse>

POST api/Transaction/GetCheckTransactionsByDate

This operation provides a detailed information about all check transactions searchable by Date. In addition to using the Authentication Key as the ProcessOne Authentication Key assigned to you you need to provide QueryAuthenticationKeys which can include the ClaimsPayAuthenticationKey for One Inc. Issued Checks and/or the Outbound Payments Authentication Key for Externally Issued Checks which will be used to filter transactions.

MethodEndpoint
GetCheckTransactionsByDate https://stgapiprocessone.oneincsystems.com/api/Transaction/GetCheckTransactionsByDate

GetCheckTransactionsByDateRequest

NameDescriptionTypeRequired*Additional information
QueryAuthenticationKeys

Authentication keys to limit search query

Collection of string Yes
CheckDateType

The Date Type to be used for Check Data Search

CheckDateType Yes
CheckDateFrom

Check Date From

date Yes
CheckDateTo

Check Date To. If not sent, the current Date will be used

date No
TransactionStatuses

Transaction statuses to limit search query.

Collection of TransactionStatus No
AuthenticationKey

Instance authentication key

string Yes

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

CheckDateType

Possible enumeration values:

NameValueDescription
TransactionDate

0

Transaction Date

CheckIssuedDate

1

Check Issued Date

CheckClearedDate

2

Check Cleared Date

CheckVoidedDate

3

Check Voided Date

Request Formats

 
                                
                                 {
  "QueryAuthenticationKeys": [
    "sample string 1",
    "sample string 2"
  ],
  "CheckDateType": 0,
  "CheckDateFrom": "2020-10-27T06:34:00",
  "CheckDateTo": "2020-10-27T06:34:00",
  "TransactionStatuses": [
    0,
    0
  ],
  "AuthenticationKey": "sample string 1"
}
                                
                                 <GetCheckTransactionsByDateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 1</AuthenticationKey>
  <CheckDateFrom>2020-10-27T06:34:00.238713-07:00</CheckDateFrom>
  <CheckDateTo>2020-10-27T06:34:00.238713-07:00</CheckDateTo>
  <CheckDateType>TransactionDate</CheckDateType>
  <QueryAuthenticationKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </QueryAuthenticationKeys>
  <TransactionStatuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.Enums">
    <d2p1:TransactionStatus>Undefined</d2p1:TransactionStatus>
    <d2p1:TransactionStatus>Undefined</d2p1:TransactionStatus>
  </TransactionStatuses>
</GetCheckTransactionsByDateRequest>

Response Information

GetCheckTransactionsByDateResponse

NameDescriptionTypeRequired*Additional information
Transactions

A transactions information

Collection of TransactionInformation No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "Transactions": [
    {
      "TransactionId": "sample string 1",
      "InternalReferenceTransactionId": "sample string 2",
      "OriginalAmount": 3.0,
      "PostedAmount": 4.0,
      "TransactionType": 0,
      "TransactionStatus": 0,
      "PaymentDate": "2020-10-27T06:34:00",
      "TimeZone": "sample string 6",
      "CreditCardType": 0,
      "LastFourDigits": "sample string 7",
      "RoutingNumber": "sample string 8",
      "AccountNumber": "sample string 9",
      "BatchNumber": 10,
      "InstanceName": "sample string 11",
      "CustomerName": "sample string 12",
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "ProcessOneToken": "sample string 13",
      "CreditCardExpirationMonth": 1,
      "CreditCardExpirationYear": 1,
      "BankName": "sample string 14",
      "BankAccountType": 0,
      "ReturnReasonType": 0,
      "ReturnReasonCode": "sample string 15",
      "BaseCardType": 0,
      "AccountGroupCode": "sample string 16",
      "CustomerId": "sample string 17",
      "CheckInformation": {
        "CheckNumber": "sample string 1",
        "CheckStatus": 0,
        "CheckMemo": "sample string 2",
        "ShipToAddress": {
          "Name": "sample string 1",
          "Name2": "sample string 2",
          "Attention": "sample string 3",
          "Address": "sample string 4",
          "Address2": "sample string 5",
          "City": "sample string 6",
          "State": "sample string 7",
          "Zip": "sample string 8",
          "Country": "sample string 9"
        },
        "CheckTrackingNumber": "sample string 3",
        "CheckTrackingUrl": "sample string 4",
        "CheckBatchId": 5,
        "CheckMailDeliveryType": 0,
        "IssuedDate": "2020-10-27T06:34:00",
        "ClearedDate": "2020-10-27T06:34:00",
        "VoidedDate": "2020-10-27T06:34:00"
      }
    },
    {
      "TransactionId": "sample string 1",
      "InternalReferenceTransactionId": "sample string 2",
      "OriginalAmount": 3.0,
      "PostedAmount": 4.0,
      "TransactionType": 0,
      "TransactionStatus": 0,
      "PaymentDate": "2020-10-27T06:34:00",
      "TimeZone": "sample string 6",
      "CreditCardType": 0,
      "LastFourDigits": "sample string 7",
      "RoutingNumber": "sample string 8",
      "AccountNumber": "sample string 9",
      "BatchNumber": 10,
      "InstanceName": "sample string 11",
      "CustomerName": "sample string 12",
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "ProcessOneToken": "sample string 13",
      "CreditCardExpirationMonth": 1,
      "CreditCardExpirationYear": 1,
      "BankName": "sample string 14",
      "BankAccountType": 0,
      "ReturnReasonType": 0,
      "ReturnReasonCode": "sample string 15",
      "BaseCardType": 0,
      "AccountGroupCode": "sample string 16",
      "CustomerId": "sample string 17",
      "CheckInformation": {
        "CheckNumber": "sample string 1",
        "CheckStatus": 0,
        "CheckMemo": "sample string 2",
        "ShipToAddress": {
          "Name": "sample string 1",
          "Name2": "sample string 2",
          "Attention": "sample string 3",
          "Address": "sample string 4",
          "Address2": "sample string 5",
          "City": "sample string 6",
          "State": "sample string 7",
          "Zip": "sample string 8",
          "Country": "sample string 9"
        },
        "CheckTrackingNumber": "sample string 3",
        "CheckTrackingUrl": "sample string 4",
        "CheckBatchId": 5,
        "CheckMailDeliveryType": 0,
        "IssuedDate": "2020-10-27T06:34:00",
        "ClearedDate": "2020-10-27T06:34:00",
        "VoidedDate": "2020-10-27T06:34:00"
      }
    }
  ],
  "ResponseCode": "sample string 1",
  "Message": "sample string 2"
}
<GetCheckTransactionsByDateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 2</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 1</ResponseCode>
  <Transactions>
    <TransactionInformation>
      <AccountGroupCode>sample string 16</AccountGroupCode>
      <AccountNumber>sample string 9</AccountNumber>
      <BankAccountType>Undefined</BankAccountType>
      <BankName>sample string 14</BankName>
      <BaseCardType>Undefined</BaseCardType>
      <BatchNumber>10</BatchNumber>
      <CheckInformation>
        <CheckBatchId>5</CheckBatchId>
        <CheckMailDeliveryType>Undefined</CheckMailDeliveryType>
        <CheckMemo>sample string 2</CheckMemo>
        <CheckNumber>sample string 1</CheckNumber>
        <CheckStatus>Undefined</CheckStatus>
        <CheckTrackingNumber>sample string 3</CheckTrackingNumber>
        <CheckTrackingUrl>sample string 4</CheckTrackingUrl>
        <ClearedDate>2020-10-27T06:34:00.2699614-07:00</ClearedDate>
        <IssuedDate>2020-10-27T06:34:00.2699614-07:00</IssuedDate>
        <ShipToAddress>
          <Address>sample string 4</Address>
          <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>
        <VoidedDate>2020-10-27T06:34:00.2699614-07:00</VoidedDate>
      </CheckInformation>
      <ClientReferenceData xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
        <d4p1:ClientReferenceData1>sample string 1</d4p1:ClientReferenceData1>
        <d4p1:ClientReferenceData2>sample string 2</d4p1:ClientReferenceData2>
        <d4p1:ClientReferenceData3>sample string 3</d4p1:ClientReferenceData3>
        <d4p1:ClientReferenceData4>sample string 4</d4p1:ClientReferenceData4>
        <d4p1:ClientReferenceData5>sample string 5</d4p1:ClientReferenceData5>
      </ClientReferenceData>
      <CreditCardExpirationMonth>1</CreditCardExpirationMonth>
      <CreditCardExpirationYear>1</CreditCardExpirationYear>
      <CreditCardType>Undefined</CreditCardType>
      <CustomerId>sample string 17</CustomerId>
      <CustomerName>sample string 12</CustomerName>
      <InstanceName>sample string 11</InstanceName>
      <InternalReferenceTransactionId>sample string 2</InternalReferenceTransactionId>
      <LastFourDigits>sample string 7</LastFourDigits>
      <OriginalAmount>3</OriginalAmount>
      <PaymentDate>2020-10-27T06:34:00.2699614-07:00</PaymentDate>
      <PostedAmount>4</PostedAmount>
      <ProcessOneToken>sample string 13</ProcessOneToken>
      <ReturnReasonCode>sample string 15</ReturnReasonCode>
      <ReturnReasonType>Undefined</ReturnReasonType>
      <RoutingNumber>sample string 8</RoutingNumber>
      <TimeZone>sample string 6</TimeZone>
      <TransactionId>sample string 1</TransactionId>
      <TransactionStatus>Undefined</TransactionStatus>
      <TransactionType>Undefined</TransactionType>
    </TransactionInformation>
    <TransactionInformation>
      <AccountGroupCode>sample string 16</AccountGroupCode>
      <AccountNumber>sample string 9</AccountNumber>
      <BankAccountType>Undefined</BankAccountType>
      <BankName>sample string 14</BankName>
      <BaseCardType>Undefined</BaseCardType>
      <BatchNumber>10</BatchNumber>
      <CheckInformation>
        <CheckBatchId>5</CheckBatchId>
        <CheckMailDeliveryType>Undefined</CheckMailDeliveryType>
        <CheckMemo>sample string 2</CheckMemo>
        <CheckNumber>sample string 1</CheckNumber>
        <CheckStatus>Undefined</CheckStatus>
        <CheckTrackingNumber>sample string 3</CheckTrackingNumber>
        <CheckTrackingUrl>sample string 4</CheckTrackingUrl>
        <ClearedDate>2020-10-27T06:34:00.2699614-07:00</ClearedDate>
        <IssuedDate>2020-10-27T06:34:00.2699614-07:00</IssuedDate>
        <ShipToAddress>
          <Address>sample string 4</Address>
          <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>
        <VoidedDate>2020-10-27T06:34:00.2699614-07:00</VoidedDate>
      </CheckInformation>
      <ClientReferenceData xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
        <d4p1:ClientReferenceData1>sample string 1</d4p1:ClientReferenceData1>
        <d4p1:ClientReferenceData2>sample string 2</d4p1:ClientReferenceData2>
        <d4p1:ClientReferenceData3>sample string 3</d4p1:ClientReferenceData3>
        <d4p1:ClientReferenceData4>sample string 4</d4p1:ClientReferenceData4>
        <d4p1:ClientReferenceData5>sample string 5</d4p1:ClientReferenceData5>
      </ClientReferenceData>
      <CreditCardExpirationMonth>1</CreditCardExpirationMonth>
      <CreditCardExpirationYear>1</CreditCardExpirationYear>
      <CreditCardType>Undefined</CreditCardType>
      <CustomerId>sample string 17</CustomerId>
      <CustomerName>sample string 12</CustomerName>
      <InstanceName>sample string 11</InstanceName>
      <InternalReferenceTransactionId>sample string 2</InternalReferenceTransactionId>
      <LastFourDigits>sample string 7</LastFourDigits>
      <OriginalAmount>3</OriginalAmount>
      <PaymentDate>2020-10-27T06:34:00.2699614-07:00</PaymentDate>
      <PostedAmount>4</PostedAmount>
      <ProcessOneToken>sample string 13</ProcessOneToken>
      <ReturnReasonCode>sample string 15</ReturnReasonCode>
      <ReturnReasonType>Undefined</ReturnReasonType>
      <RoutingNumber>sample string 8</RoutingNumber>
      <TimeZone>sample string 6</TimeZone>
      <TransactionId>sample string 1</TransactionId>
      <TransactionStatus>Undefined</TransactionStatus>
      <TransactionType>Undefined</TransactionType>
    </TransactionInformation>
  </Transactions>
</GetCheckTransactionsByDateResponse>

POST api/Transaction/GetTransactionsByType

This operation provides a detailed information about all transactions that match any of the specified transaction types. In your request, you can provide one or more transaction types and authentication keys to expand or limit the scope of your query. You have to provide a specific time frame to limit your search.

MethodEndpoint
GetTransactionsByType https://stgapiprocessone.oneincsystems.com/api/Transaction/GetTransactionsByType

GetTransactionsByTypeRequest

NameDescriptionTypeRequired*Additional information
Types

Transaction types

Collection of TransactionType Yes
StartDate

Start date

date No
EndDate

End date

date No
QueryAuthenticationKeys

Authentication keys to limit search query

Collection of string Yes
TransactionStatuses

Transaction statuses to limit search query

Collection of TransactionStatus No
AfterTransactionId

Minimum transaction number (will not be included in the result)

integer No
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "Types": [
    5,
    1
  ],
  "StartDate": "2020-10-17T06:34:01",
  "EndDate": "2020-10-27T06:34:01",
  "QueryAuthenticationKeys": [
    "Authentication Key",
    "316732db-eccb-4f63-8503-58491bdf8292"
  ],
  "TransactionStatuses": null,
  "AfterTransactionId": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <GetTransactionsByTypeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <AfterTransactionId i:nil="true" />
  <EndDate>2020-10-27T06:34:01.0824937-07:00</EndDate>
  <QueryAuthenticationKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Authentication Key</d2p1:string>
    <d2p1:string>316732db-eccb-4f63-8503-58491bdf8292</d2p1:string>
  </QueryAuthenticationKeys>
  <StartDate>2020-10-17T06:34:01.0824937-07:00</StartDate>
  <TransactionStatuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.Enums" i:nil="true" />
  <Types xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.Enums">
    <d2p1:TransactionType>CreditEft</d2p1:TransactionType>
    <d2p1:TransactionType>ChargeCreditCard</d2p1:TransactionType>
  </Types>
</GetTransactionsByTypeRequest>

Response Information

GetTransactionsByTypeResponse

NameDescriptionTypeRequired*Additional information
Transactions

Collection of transactions

Collection of TransactionInformation No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "Transactions": [
    {
      "TransactionId": "1580",
      "InternalReferenceTransactionId": null,
      "OriginalAmount": 100.0,
      "PostedAmount": 100.0,
      "TransactionType": 5,
      "TransactionStatus": 2,
      "PaymentDate": "2020-10-27T06:34:01",
      "TimeZone": "PDT",
      "CreditCardType": 0,
      "LastFourDigits": "1234",
      "RoutingNumber": "123123123",
      "AccountNumber": "123123124",
      "BatchNumber": 11,
      "InstanceName": "merchant instance name",
      "CustomerName": "John Stevens",
      "ClientReferenceData": {
        "ClientReferenceData1": "1234",
        "ClientReferenceData2": null,
        "ClientReferenceData3": "test address",
        "ClientReferenceData4": null,
        "ClientReferenceData5": null
      },
      "ProcessOneToken": null,
      "CreditCardExpirationMonth": null,
      "CreditCardExpirationYear": null,
      "BankName": null,
      "BankAccountType": 0,
      "ReturnReasonType": null,
      "ReturnReasonCode": null,
      "BaseCardType": null,
      "AccountGroupCode": null,
      "CustomerId": null,
      "CheckInformation": null
    },
    {
      "TransactionId": "1581",
      "InternalReferenceTransactionId": null,
      "OriginalAmount": 100.0,
      "PostedAmount": 100.0,
      "TransactionType": 5,
      "TransactionStatus": 2,
      "PaymentDate": "2020-10-27T06:34:01",
      "TimeZone": "PDT",
      "CreditCardType": 0,
      "LastFourDigits": "1234",
      "RoutingNumber": "123123123",
      "AccountNumber": "123123124",
      "BatchNumber": 11,
      "InstanceName": "merchant instance name",
      "CustomerName": "John Stevens",
      "ClientReferenceData": {
        "ClientReferenceData1": "1234",
        "ClientReferenceData2": null,
        "ClientReferenceData3": "test address",
        "ClientReferenceData4": null,
        "ClientReferenceData5": null
      },
      "ProcessOneToken": null,
      "CreditCardExpirationMonth": null,
      "CreditCardExpirationYear": null,
      "BankName": null,
      "BankAccountType": 0,
      "ReturnReasonType": null,
      "ReturnReasonCode": null,
      "BaseCardType": null,
      "AccountGroupCode": null,
      "CustomerId": null,
      "CheckInformation": null
    }
  ],
  "ResponseCode": "Success",
  "Message": "Success"
}
<GetTransactionsByTypeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <Transactions>
    <TransactionInformation>
      <AccountGroupCode i:nil="true" />
      <AccountNumber>123123124</AccountNumber>
      <BankAccountType>Undefined</BankAccountType>
      <BankName i:nil="true" />
      <BaseCardType i:nil="true" />
      <BatchNumber>11</BatchNumber>
      <CheckInformation i:nil="true" />
      <ClientReferenceData xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
        <d4p1:ClientReferenceData1>1234</d4p1:ClientReferenceData1>
        <d4p1:ClientReferenceData2 i:nil="true" />
        <d4p1:ClientReferenceData3>test address</d4p1:ClientReferenceData3>
        <d4p1:ClientReferenceData4 i:nil="true" />
        <d4p1:ClientReferenceData5 i:nil="true" />
      </ClientReferenceData>
      <CreditCardExpirationMonth i:nil="true" />
      <CreditCardExpirationYear i:nil="true" />
      <CreditCardType>Undefined</CreditCardType>
      <CustomerId i:nil="true" />
      <CustomerName>John Stevens</CustomerName>
      <InstanceName>merchant instance name</InstanceName>
      <InternalReferenceTransactionId i:nil="true" />
      <LastFourDigits>1234</LastFourDigits>
      <OriginalAmount>100</OriginalAmount>
      <PaymentDate>2020-10-27T06:34:01.0981135-07:00</PaymentDate>
      <PostedAmount>100</PostedAmount>
      <ProcessOneToken i:nil="true" />
      <ReturnReasonCode i:nil="true" />
      <ReturnReasonType i:nil="true" />
      <RoutingNumber>123123123</RoutingNumber>
      <TimeZone>PDT</TimeZone>
      <TransactionId>1580</TransactionId>
      <TransactionStatus>Successful</TransactionStatus>
      <TransactionType>CreditEft</TransactionType>
    </TransactionInformation>
    <TransactionInformation>
      <AccountGroupCode i:nil="true" />
      <AccountNumber>123123124</AccountNumber>
      <BankAccountType>Undefined</BankAccountType>
      <BankName i:nil="true" />
      <BaseCardType i:nil="true" />
      <BatchNumber>11</BatchNumber>
      <CheckInformation i:nil="true" />
      <ClientReferenceData xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
        <d4p1:ClientReferenceData1>1234</d4p1:ClientReferenceData1>
        <d4p1:ClientReferenceData2 i:nil="true" />
        <d4p1:ClientReferenceData3>test address</d4p1:ClientReferenceData3>
        <d4p1:ClientReferenceData4 i:nil="true" />
        <d4p1:ClientReferenceData5 i:nil="true" />
      </ClientReferenceData>
      <CreditCardExpirationMonth i:nil="true" />
      <CreditCardExpirationYear i:nil="true" />
      <CreditCardType>Undefined</CreditCardType>
      <CustomerId i:nil="true" />
      <CustomerName>John Stevens</CustomerName>
      <InstanceName>merchant instance name</InstanceName>
      <InternalReferenceTransactionId i:nil="true" />
      <LastFourDigits>1234</LastFourDigits>
      <OriginalAmount>100</OriginalAmount>
      <PaymentDate>2020-10-27T06:34:01.0981135-07:00</PaymentDate>
      <PostedAmount>100</PostedAmount>
      <ProcessOneToken i:nil="true" />
      <ReturnReasonCode i:nil="true" />
      <ReturnReasonType i:nil="true" />
      <RoutingNumber>123123123</RoutingNumber>
      <TimeZone>PDT</TimeZone>
      <TransactionId>1581</TransactionId>
      <TransactionStatus>Successful</TransactionStatus>
      <TransactionType>CreditEft</TransactionType>
    </TransactionInformation>
  </Transactions>
</GetTransactionsByTypeResponse>

POST api/Transaction/UpdateTransactionMetadata

Most of the transactions include ClientReferenceData metadata fields that you can use to link additional information to transaction record. This operation allows to update the metadata fields of a particular transaction with a specific transaction id. Specify the Transaction ID and the new value of the metadata fields that you want to update.

MethodEndpoint
UpdateTransactionMetadata https://stgapiprocessone.oneincsystems.com/api/Transaction/UpdateTransactionMetadata

UpdateTransactionMetadataRequest

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction id

integer No
ClientReferenceData

Client reference data

ClientReferenceData No
AuthenticationKey

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": 99991,
  "ClientReferenceData": {
    "ClientReferenceData1": "1234",
    "ClientReferenceData2": null,
    "ClientReferenceData3": "test address",
    "ClientReferenceData4": "additional info",
    "ClientReferenceData5": null
  },
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <UpdateTransactionMetadataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <ClientReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
    <d2p1:ClientReferenceData1>1234</d2p1:ClientReferenceData1>
    <d2p1:ClientReferenceData2 i:nil="true" />
    <d2p1:ClientReferenceData3>test address</d2p1:ClientReferenceData3>
    <d2p1:ClientReferenceData4>additional info</d2p1:ClientReferenceData4>
    <d2p1:ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <TransactionId>99991</TransactionId>
</UpdateTransactionMetadataRequest>

Response Information

UpdateTransactionMetadataResponse

NameDescriptionTypeRequired*Additional information
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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",
  "Message": "Success"
}
<UpdateTransactionMetadataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
</UpdateTransactionMetadataResponse>

POST api/Transaction/GetTransactionsByCustomerAndClientRefData

This operation provides a detailed information about all transactions that match customer id. You have to provide a specific time frame to limit your search.

MethodEndpoint
GetTransactionsByCustomerAndClientRefData https://stgapiprocessone.oneincsystems.com/api/Transaction/GetTransactionsByCustomerAndClientRefData

GetTransactionsByCustomerAndClientRefDataRequest

NameDescriptionTypeRequired*Additional information
CustomerId

External Customer id

string No
StartDate

Transaction start date

date No
EndDate

Transaction end date

date No
TransactionTypes

Transaction types

Collection of TransactionType No
TransactionStatuses

Transaction statuses

Collection of TransactionStatus No
ClientReferenceData

Client reference data

ClientReferenceData No

Required (when CustomerID is empty)

Limit

Transactions limit (how many items return)

integer No
Offset

Transaction offset (rows to skip before starting to return rows)

integer No
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "CustomerId": "sample string 1",
  "StartDate": "2020-10-27T06:34:02",
  "EndDate": "2020-10-27T06:34:02",
  "TransactionTypes": [
    0,
    0
  ],
  "TransactionStatuses": [
    0,
    0
  ],
  "ClientReferenceData": {
    "ClientReferenceData1": "sample string 1",
    "ClientReferenceData2": "sample string 2",
    "ClientReferenceData3": "sample string 3",
    "ClientReferenceData4": "sample string 4",
    "ClientReferenceData5": "sample string 5"
  },
  "Limit": 1,
  "Offset": 1,
  "AuthenticationKey": "sample string 2"
}
                                
                                 <GetTransactionsByCustomerAndClientRefDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 2</AuthenticationKey>
  <ClientReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.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>
  <CustomerId>sample string 1</CustomerId>
  <EndDate>2020-10-27T06:34:02.4021187-07:00</EndDate>
  <Limit>1</Limit>
  <Offset>1</Offset>
  <StartDate>2020-10-27T06:34:02.4021187-07:00</StartDate>
  <TransactionStatuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.Enums">
    <d2p1:TransactionStatus>Undefined</d2p1:TransactionStatus>
    <d2p1:TransactionStatus>Undefined</d2p1:TransactionStatus>
  </TransactionStatuses>
  <TransactionTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.Enums">
    <d2p1:TransactionType>Undefined</d2p1:TransactionType>
    <d2p1:TransactionType>Undefined</d2p1:TransactionType>
  </TransactionTypes>
</GetTransactionsByCustomerAndClientRefDataRequest>

Response Information

GetTransactionsByCustomerAndClientRefDataResponse

NameDescriptionTypeRequired*Additional information
Transactions

Collection of transactions

Collection of TransactionInformation No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "Transactions": [
    {
      "TransactionId": "sample string 1",
      "InternalReferenceTransactionId": "sample string 2",
      "OriginalAmount": 3.0,
      "PostedAmount": 4.0,
      "TransactionType": 0,
      "TransactionStatus": 0,
      "PaymentDate": "2020-10-27T06:34:02",
      "TimeZone": "sample string 6",
      "CreditCardType": 0,
      "LastFourDigits": "sample string 7",
      "RoutingNumber": "sample string 8",
      "AccountNumber": "sample string 9",
      "BatchNumber": 10,
      "InstanceName": "sample string 11",
      "CustomerName": "sample string 12",
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "ProcessOneToken": "sample string 13",
      "CreditCardExpirationMonth": 1,
      "CreditCardExpirationYear": 1,
      "BankName": "sample string 14",
      "BankAccountType": 0,
      "ReturnReasonType": 0,
      "ReturnReasonCode": "sample string 15",
      "BaseCardType": 0,
      "AccountGroupCode": "sample string 16",
      "CustomerId": "sample string 17",
      "CheckInformation": {
        "CheckNumber": "sample string 1",
        "CheckStatus": 0,
        "CheckMemo": "sample string 2",
        "ShipToAddress": {
          "Name": "sample string 1",
          "Name2": "sample string 2",
          "Attention": "sample string 3",
          "Address": "sample string 4",
          "Address2": "sample string 5",
          "City": "sample string 6",
          "State": "sample string 7",
          "Zip": "sample string 8",
          "Country": "sample string 9"
        },
        "CheckTrackingNumber": "sample string 3",
        "CheckTrackingUrl": "sample string 4",
        "CheckBatchId": 5,
        "CheckMailDeliveryType": 0,
        "IssuedDate": "2020-10-27T06:34:02",
        "ClearedDate": "2020-10-27T06:34:02",
        "VoidedDate": "2020-10-27T06:34:02"
      }
    },
    {
      "TransactionId": "sample string 1",
      "InternalReferenceTransactionId": "sample string 2",
      "OriginalAmount": 3.0,
      "PostedAmount": 4.0,
      "TransactionType": 0,
      "TransactionStatus": 0,
      "PaymentDate": "2020-10-27T06:34:02",
      "TimeZone": "sample string 6",
      "CreditCardType": 0,
      "LastFourDigits": "sample string 7",
      "RoutingNumber": "sample string 8",
      "AccountNumber": "sample string 9",
      "BatchNumber": 10,
      "InstanceName": "sample string 11",
      "CustomerName": "sample string 12",
      "ClientReferenceData": {
        "ClientReferenceData1": "sample string 1",
        "ClientReferenceData2": "sample string 2",
        "ClientReferenceData3": "sample string 3",
        "ClientReferenceData4": "sample string 4",
        "ClientReferenceData5": "sample string 5"
      },
      "ProcessOneToken": "sample string 13",
      "CreditCardExpirationMonth": 1,
      "CreditCardExpirationYear": 1,
      "BankName": "sample string 14",
      "BankAccountType": 0,
      "ReturnReasonType": 0,
      "ReturnReasonCode": "sample string 15",
      "BaseCardType": 0,
      "AccountGroupCode": "sample string 16",
      "CustomerId": "sample string 17",
      "CheckInformation": {
        "CheckNumber": "sample string 1",
        "CheckStatus": 0,
        "CheckMemo": "sample string 2",
        "ShipToAddress": {
          "Name": "sample string 1",
          "Name2": "sample string 2",
          "Attention": "sample string 3",
          "Address": "sample string 4",
          "Address2": "sample string 5",
          "City": "sample string 6",
          "State": "sample string 7",
          "Zip": "sample string 8",
          "Country": "sample string 9"
        },
        "CheckTrackingNumber": "sample string 3",
        "CheckTrackingUrl": "sample string 4",
        "CheckBatchId": 5,
        "CheckMailDeliveryType": 0,
        "IssuedDate": "2020-10-27T06:34:02",
        "ClearedDate": "2020-10-27T06:34:02",
        "VoidedDate": "2020-10-27T06:34:02"
      }
    }
  ],
  "ResponseCode": "sample string 1",
  "Message": "sample string 2"
}
<GetTransactionsByCustomerAndClientRefDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 2</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 1</ResponseCode>
  <Transactions>
    <TransactionInformation>
      <AccountGroupCode>sample string 16</AccountGroupCode>
      <AccountNumber>sample string 9</AccountNumber>
      <BankAccountType>Undefined</BankAccountType>
      <BankName>sample string 14</BankName>
      <BaseCardType>Undefined</BaseCardType>
      <BatchNumber>10</BatchNumber>
      <CheckInformation>
        <CheckBatchId>5</CheckBatchId>
        <CheckMailDeliveryType>Undefined</CheckMailDeliveryType>
        <CheckMemo>sample string 2</CheckMemo>
        <CheckNumber>sample string 1</CheckNumber>
        <CheckStatus>Undefined</CheckStatus>
        <CheckTrackingNumber>sample string 3</CheckTrackingNumber>
        <CheckTrackingUrl>sample string 4</CheckTrackingUrl>
        <ClearedDate>2020-10-27T06:34:02.43336-07:00</ClearedDate>
        <IssuedDate>2020-10-27T06:34:02.43336-07:00</IssuedDate>
        <ShipToAddress>
          <Address>sample string 4</Address>
          <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>
        <VoidedDate>2020-10-27T06:34:02.43336-07:00</VoidedDate>
      </CheckInformation>
      <ClientReferenceData xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
        <d4p1:ClientReferenceData1>sample string 1</d4p1:ClientReferenceData1>
        <d4p1:ClientReferenceData2>sample string 2</d4p1:ClientReferenceData2>
        <d4p1:ClientReferenceData3>sample string 3</d4p1:ClientReferenceData3>
        <d4p1:ClientReferenceData4>sample string 4</d4p1:ClientReferenceData4>
        <d4p1:ClientReferenceData5>sample string 5</d4p1:ClientReferenceData5>
      </ClientReferenceData>
      <CreditCardExpirationMonth>1</CreditCardExpirationMonth>
      <CreditCardExpirationYear>1</CreditCardExpirationYear>
      <CreditCardType>Undefined</CreditCardType>
      <CustomerId>sample string 17</CustomerId>
      <CustomerName>sample string 12</CustomerName>
      <InstanceName>sample string 11</InstanceName>
      <InternalReferenceTransactionId>sample string 2</InternalReferenceTransactionId>
      <LastFourDigits>sample string 7</LastFourDigits>
      <OriginalAmount>3</OriginalAmount>
      <PaymentDate>2020-10-27T06:34:02.43336-07:00</PaymentDate>
      <PostedAmount>4</PostedAmount>
      <ProcessOneToken>sample string 13</ProcessOneToken>
      <ReturnReasonCode>sample string 15</ReturnReasonCode>
      <ReturnReasonType>Undefined</ReturnReasonType>
      <RoutingNumber>sample string 8</RoutingNumber>
      <TimeZone>sample string 6</TimeZone>
      <TransactionId>sample string 1</TransactionId>
      <TransactionStatus>Undefined</TransactionStatus>
      <TransactionType>Undefined</TransactionType>
    </TransactionInformation>
    <TransactionInformation>
      <AccountGroupCode>sample string 16</AccountGroupCode>
      <AccountNumber>sample string 9</AccountNumber>
      <BankAccountType>Undefined</BankAccountType>
      <BankName>sample string 14</BankName>
      <BaseCardType>Undefined</BaseCardType>
      <BatchNumber>10</BatchNumber>
      <CheckInformation>
        <CheckBatchId>5</CheckBatchId>
        <CheckMailDeliveryType>Undefined</CheckMailDeliveryType>
        <CheckMemo>sample string 2</CheckMemo>
        <CheckNumber>sample string 1</CheckNumber>
        <CheckStatus>Undefined</CheckStatus>
        <CheckTrackingNumber>sample string 3</CheckTrackingNumber>
        <CheckTrackingUrl>sample string 4</CheckTrackingUrl>
        <ClearedDate>2020-10-27T06:34:02.43336-07:00</ClearedDate>
        <IssuedDate>2020-10-27T06:34:02.43336-07:00</IssuedDate>
        <ShipToAddress>
          <Address>sample string 4</Address>
          <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>
        <VoidedDate>2020-10-27T06:34:02.43336-07:00</VoidedDate>
      </CheckInformation>
      <ClientReferenceData xmlns:d4p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
        <d4p1:ClientReferenceData1>sample string 1</d4p1:ClientReferenceData1>
        <d4p1:ClientReferenceData2>sample string 2</d4p1:ClientReferenceData2>
        <d4p1:ClientReferenceData3>sample string 3</d4p1:ClientReferenceData3>
        <d4p1:ClientReferenceData4>sample string 4</d4p1:ClientReferenceData4>
        <d4p1:ClientReferenceData5>sample string 5</d4p1:ClientReferenceData5>
      </ClientReferenceData>
      <CreditCardExpirationMonth>1</CreditCardExpirationMonth>
      <CreditCardExpirationYear>1</CreditCardExpirationYear>
      <CreditCardType>Undefined</CreditCardType>
      <CustomerId>sample string 17</CustomerId>
      <CustomerName>sample string 12</CustomerName>
      <InstanceName>sample string 11</InstanceName>
      <InternalReferenceTransactionId>sample string 2</InternalReferenceTransactionId>
      <LastFourDigits>sample string 7</LastFourDigits>
      <OriginalAmount>3</OriginalAmount>
      <PaymentDate>2020-10-27T06:34:02.43336-07:00</PaymentDate>
      <PostedAmount>4</PostedAmount>
      <ProcessOneToken>sample string 13</ProcessOneToken>
      <ReturnReasonCode>sample string 15</ReturnReasonCode>
      <ReturnReasonType>Undefined</ReturnReasonType>
      <RoutingNumber>sample string 8</RoutingNumber>
      <TimeZone>sample string 6</TimeZone>
      <TransactionId>sample string 1</TransactionId>
      <TransactionStatus>Undefined</TransactionStatus>
      <TransactionType>Undefined</TransactionType>
    </TransactionInformation>
  </Transactions>
</GetTransactionsByCustomerAndClientRefDataResponse>

POST api/Transaction/GetTransactionTotalsByBatchId

This operation provides summarized information about all transactions that match any of the specified BatchId's. In your request, you can provide the BatchID and authentication key to expand or limit the scope of your query.

MethodEndpoint
GetTransactionTotalsByBatchId https://stgapiprocessone.oneincsystems.com/api/Transaction/GetTransactionTotalsByBatchId

GetTransactionTotalsByBatchIdRequest

NameDescriptionTypeRequired*Additional information
QueryAuthenticationKeys

Authentication keys to limit search query

Collection of string Yes
BatchId

A Transaction Batch Id

integer Yes
TransactionTypes

Transaction types

Collection of TransactionType No
TransactionStatuses

Transaction statuses

Collection of TransactionStatus No
AccountGroupCodes

Account Group Codes

Collection of string No
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "QueryAuthenticationKeys": [
    "sample string 1",
    "sample string 2"
  ],
  "BatchId": 1,
  "TransactionTypes": [
    0,
    0
  ],
  "TransactionStatuses": [
    0,
    0
  ],
  "AccountGroupCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "AuthenticationKey": "sample string 1"
}
                                
                                 <GetTransactionTotalsByBatchIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 1</AuthenticationKey>
  <AccountGroupCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AccountGroupCodes>
  <BatchId>1</BatchId>
  <QueryAuthenticationKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </QueryAuthenticationKeys>
  <TransactionStatuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.Enums">
    <d2p1:TransactionStatus>Undefined</d2p1:TransactionStatus>
    <d2p1:TransactionStatus>Undefined</d2p1:TransactionStatus>
  </TransactionStatuses>
  <TransactionTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.Enums">
    <d2p1:TransactionType>Undefined</d2p1:TransactionType>
    <d2p1:TransactionType>Undefined</d2p1:TransactionType>
  </TransactionTypes>
</GetTransactionTotalsByBatchIdRequest>

Response Information

GetTransactionTotalsByBatchIdResponse

NameDescriptionTypeRequired*Additional information
BatchNumber

Transaction Batch Id

integer No
TotalTransactionsCount

Total Number of Transactions

integer No
TotalAmount

Sum up the Amount of Transactions

decimal number No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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,
  "TotalTransactionsCount": 2,
  "TotalAmount": 3.0,
  "ResponseCode": "sample string 4",
  "Message": "sample string 5"
}
<GetTransactionTotalsByBatchIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 5</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 4</ResponseCode>
  <BatchNumber>1</BatchNumber>
  <TotalAmount>3</TotalAmount>
  <TotalTransactionsCount>2</TotalTransactionsCount>
</GetTransactionTotalsByBatchIdResponse>

POST api/Transaction/GetTransactionTotalsByDate

This operation provides a information about a summary of total number of transactions and the sum amount of transactions.

MethodEndpoint
GetTransactionTotalsByDate https://stgapiprocessone.oneincsystems.com/api/Transaction/GetTransactionTotalsByDate

GetTransactionTotalsByDateRequest

NameDescriptionTypeRequired*Additional information
QueryAuthenticationKeys

Authentication keys to limit search query

Collection of string Yes
StartDate

Transaction start date

date Yes
EndDate

Transaction end date

date Yes
TransactionTypes

Transaction types

Collection of TransactionType Yes
TransactionStatuses

Transaction statuses

Collection of TransactionStatus No
AccountGroupCodes

Account Group Codes

Collection of string No
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "QueryAuthenticationKeys": [
    "sample string 1",
    "sample string 2"
  ],
  "StartDate": "2020-10-27T06:34:03",
  "EndDate": "2020-10-27T06:34:03",
  "TransactionTypes": [
    0,
    0
  ],
  "TransactionStatuses": [
    0,
    0
  ],
  "AccountGroupCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "AuthenticationKey": "sample string 1"
}
                                
                                 <GetTransactionTotalsByDateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 1</AuthenticationKey>
  <AccountGroupCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AccountGroupCodes>
  <EndDate>2020-10-27T06:34:03.8169389-07:00</EndDate>
  <QueryAuthenticationKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </QueryAuthenticationKeys>
  <StartDate>2020-10-27T06:34:03.8169389-07:00</StartDate>
  <TransactionStatuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.Enums">
    <d2p1:TransactionStatus>Undefined</d2p1:TransactionStatus>
    <d2p1:TransactionStatus>Undefined</d2p1:TransactionStatus>
  </TransactionStatuses>
  <TransactionTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.Enums">
    <d2p1:TransactionType>Undefined</d2p1:TransactionType>
    <d2p1:TransactionType>Undefined</d2p1:TransactionType>
  </TransactionTypes>
</GetTransactionTotalsByDateRequest>

Response Information

GetTransactionTotalsByDateResponse

NameDescriptionTypeRequired*Additional information
BatchNumber

List of batch numbers

Collection of integer No
StartDate

Transaction start date

date No
EndDate

Transaction end date

date No
TotalTransactionsCount

Total transactions count

integer No
TotalAmount

Total transactions amount

decimal number No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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,
    2
  ],
  "StartDate": "2020-10-27T06:34:03",
  "EndDate": "2020-10-27T06:34:03",
  "TotalTransactionsCount": 3,
  "TotalAmount": 4.0,
  "ResponseCode": "sample string 5",
  "Message": "sample string 6"
}
<GetTransactionTotalsByDateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Transaction">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 6</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 5</ResponseCode>
  <BatchNumber xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BatchNumber>
  <EndDate>2020-10-27T06:34:03.8325606-07:00</EndDate>
  <StartDate>2020-10-27T06:34:03.8325606-07:00</StartDate>
  <TotalAmount>4</TotalAmount>
  <TotalTransactionsCount>3</TotalTransactionsCount>
</GetTransactionTotalsByDateResponse>

Eft

POST api/Eft/Save

This operation tokenizes all the required information about a bank account payment method. Once the bank account information has been tokenized, you no longer have to provide us any sensitive and personal information to debit or credit a bank account, just use the token that is returned by our API.

MethodEndpoint
Save https://stgapiprocessone.oneincsystems.com/api/Eft/Save

SaveEftRequest

NameDescriptionTypeRequired*Additional information
EftDetails

Eft details

EftDetails No
ClientReferenceData

Client reference data

ClientReferenceData No
CallbackId

A callback id associated to save EFT transaction

string No
BypassBankAccountValidation

Bypassing bank account validation

boolean No
CustomerId

A customer id associated with transaction

string No
AccountGroupCode

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

string No
AuthenticationKey

Instance authentication key

string Yes

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

EftDetails

NameDescriptionTypeRequired*Additional information
RoutingNumber

The bank routing number. Must only contain numbers.

string Yes
AccountNumber

Account number. Must contain only numbers.

string Yes
Type

EFT account type - Checking / Savings.

EftAccountType No
CustomerName

Customer name

string Yes
TokenReusability

TokenReusability No

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

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

 
                                
                                 {
  "EftDetails": {
    "RoutingNumber": "123123123",
    "AccountNumber": "123123124",
    "Type": 0,
    "CustomerName": "John Stevens",
    "TokenReusability": 0
  },
  "ClientReferenceData": {
    "ClientReferenceData1": "1234",
    "ClientReferenceData2": "ee47158c-9906-47d6-92dd-452a76266475",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "CallbackId": null,
  "BypassBankAccountValidation": false,
  "CustomerId": null,
  "AccountGroupCode": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <SaveEftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <AccountGroupCode i:nil="true" />
  <BypassBankAccountValidation>false</BypassBankAccountValidation>
  <CallbackId i:nil="true" />
  <ClientReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
    <d2p1:ClientReferenceData1>1234</d2p1:ClientReferenceData1>
    <d2p1:ClientReferenceData2>ee47158c-9906-47d6-92dd-452a76266475</d2p1:ClientReferenceData2>
    <d2p1:ClientReferenceData3>Location</d2p1:ClientReferenceData3>
    <d2p1:ClientReferenceData4 i:nil="true" />
    <d2p1:ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <CustomerId i:nil="true" />
  <EftDetails>
    <AccountNumber>123123124</AccountNumber>
    <CustomerName>John Stevens</CustomerName>
    <RoutingNumber>123123123</RoutingNumber>
    <TokenReusability>Undefined</TokenReusability>
    <Type>Undefined</Type>
  </EftDetails>
</SaveEftRequest>

Response Information

SaveEftResponse

NameDescriptionTypeRequired*Additional information
Token

Saved Eft token

string No
BankName

Bank name

string No
ServerReferenceData

Additional response data

ServerReferenceData No
TimeZone

Short time zone name with daylight saving time suffix

string No
TokenCreationTime

Token creation 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

Message

Response message

string No

Message 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

Operation result description

string No

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

Response Formats

{
  "Token": "83c50e9c-cabc-4980-91eb-2dfe335a3868",
  "BankName": null,
  "ServerReferenceData": null,
  "TimeZone": null,
  "TokenCreationTime": null,
  "ResponseCode": "Success",
  "Message": "Success"
}
<SaveEftResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <BankName i:nil="true" />
  <ServerReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts" i:nil="true" />
  <TimeZone i:nil="true" />
  <Token>83c50e9c-cabc-4980-91eb-2dfe335a3868</Token>
  <TokenCreationTime i:nil="true" />
</SaveEftResponse>

POST api/Eft/Credit

This operation allows to credit a given bank account, which initiates a transfer of money from the merchant to a particular customer bank account. You can either provide a bank account information or use a previously saved token.

MethodEndpoint
Credit https://stgapiprocessone.oneincsystems.com/api/Eft/Credit

CreditEftRequest

NameDescriptionTypeRequired*Additional information
Amount

Amount to charge

decimal number Yes
Token

Saved Eft token

string No
EftDetails

Eft details

EftDetails No

Required, if Token field is not specified

ClientReferenceData

Client reference data

ClientReferenceData No
IsRecurring

Is recurring charge

boolean No
CallbackId

Callback ID

string No
CustomerId

A customer id associated with transaction

string No
AccountGroupCode

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

string No
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "Amount": 100.0,
  "Token": null,
  "EftDetails": {
    "RoutingNumber": "123123123",
    "AccountNumber": "123123124",
    "Type": 0,
    "CustomerName": "John Stevens",
    "TokenReusability": 0
  },
  "ClientReferenceData": {
    "ClientReferenceData1": "1234",
    "ClientReferenceData2": "54a4ba0e-bedb-4538-ba81-99d8cbe7679c",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "IsRecurring": false,
  "CallbackId": null,
  "CustomerId": null,
  "AccountGroupCode": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <CreditEftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <AccountGroupCode i:nil="true" />
  <Amount>100</Amount>
  <CallbackId i:nil="true" />
  <ClientReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
    <d2p1:ClientReferenceData1>1234</d2p1:ClientReferenceData1>
    <d2p1:ClientReferenceData2>54a4ba0e-bedb-4538-ba81-99d8cbe7679c</d2p1:ClientReferenceData2>
    <d2p1:ClientReferenceData3>Location</d2p1:ClientReferenceData3>
    <d2p1:ClientReferenceData4 i:nil="true" />
    <d2p1:ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <CustomerId i:nil="true" />
  <EftDetails>
    <AccountNumber>123123124</AccountNumber>
    <CustomerName>John Stevens</CustomerName>
    <RoutingNumber>123123123</RoutingNumber>
    <TokenReusability>Undefined</TokenReusability>
    <Type>Undefined</Type>
  </EftDetails>
  <IsRecurring>false</IsRecurring>
  <Token i:nil="true" />
</CreditEftRequest>

Response Information

CreditEftResponse

NameDescriptionTypeRequired*Additional information
BankName

Bank name

string No
TransactionId

Transaction ID

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

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "BankName": "Bank name",
  "TransactionId": "f3fb81a2-d7b5-47f5-b652-078b2c70ea8f",
  "TransactionDate": "2020-10-27T06:34:05",
  "TimeZone": "PDT",
  "BatchNumber": 0,
  "ResponseCode": "Success",
  "Message": "Success"
}
<CreditEftResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <BankName>Bank name</BankName>
  <BatchNumber>0</BatchNumber>
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2020-10-27T06:34:05</TransactionDate>
  <TransactionId>f3fb81a2-d7b5-47f5-b652-078b2c70ea8f</TransactionId>
</CreditEftResponse>

POST api/Eft/Debit

This operation allows debiting a given bank account, which initiates a transfer of money from a particular customer bank account to the merchant. You can either provide a bank account information or use a previously saved token.

MethodEndpoint
Debit https://stgapiprocessone.oneincsystems.com/api/Eft/Debit

DebitEftRequest

NameDescriptionTypeRequired*Additional information
Save

Enables to save and tokenize eft information

boolean No
ChargeFee

Should we charge with fee

boolean No
ConvenienceFeeType

Customizable convenience fee type that is matched with different types of transactions

string No
BypassBankAccountValidation

Bypassing bank account validation

boolean No
TransactionOrigination

Establishes transaction origination to define Standard Entry Class (SEC) code type for Automated Clearing House (ACH) File

TransactionOrigination No
Amount

Amount to charge

decimal number Yes
Token

Saved Eft token

string No
EftDetails

Eft details

EftDetails No

Required, if Token field is not specified

ClientReferenceData

Client reference data

ClientReferenceData No
IsRecurring

Is recurring charge

boolean No
CallbackId

Callback ID

string No
CustomerId

A customer id associated with transaction

string No
AccountGroupCode

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

string No
AuthenticationKey

Instance authentication key

string Yes

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

TransactionOrigination

Possible enumeration values:

NameValueDescription
Undefined

0

Transaction Origination is undefined

WEB

1

Reoccurring payment, means authorization was provided over the internet

PPD

2

Prearranged Payment and Deposit Entry

Request Formats

 
                                
                                 {
  "Save": false,
  "ChargeFee": false,
  "ConvenienceFeeType": null,
  "BypassBankAccountValidation": false,
  "TransactionOrigination": null,
  "Amount": 100.0,
  "Token": null,
  "EftDetails": {
    "RoutingNumber": "123123123",
    "AccountNumber": "123123124",
    "Type": 0,
    "CustomerName": "John Stevens",
    "TokenReusability": 0
  },
  "ClientReferenceData": {
    "ClientReferenceData1": "1234",
    "ClientReferenceData2": "fc2bf631-9d08-4264-acf0-2044e30448c1",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "IsRecurring": false,
  "CallbackId": null,
  "CustomerId": null,
  "AccountGroupCode": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <DebitEftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <AccountGroupCode i:nil="true" />
  <Amount>100</Amount>
  <CallbackId i:nil="true" />
  <ClientReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
    <d2p1:ClientReferenceData1>1234</d2p1:ClientReferenceData1>
    <d2p1:ClientReferenceData2>fc2bf631-9d08-4264-acf0-2044e30448c1</d2p1:ClientReferenceData2>
    <d2p1:ClientReferenceData3>Location</d2p1:ClientReferenceData3>
    <d2p1:ClientReferenceData4 i:nil="true" />
    <d2p1:ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <CustomerId i:nil="true" />
  <EftDetails>
    <AccountNumber>123123124</AccountNumber>
    <CustomerName>John Stevens</CustomerName>
    <RoutingNumber>123123123</RoutingNumber>
    <TokenReusability>Undefined</TokenReusability>
    <Type>Undefined</Type>
  </EftDetails>
  <IsRecurring>false</IsRecurring>
  <Token i:nil="true" />
  <BypassBankAccountValidation>false</BypassBankAccountValidation>
  <ChargeFee>false</ChargeFee>
  <ConvenienceFeeType i:nil="true" />
  <Save>false</Save>
  <TransactionOrigination i:nil="true" />
</DebitEftRequest>

Response Information

DebitEftResponse

NameDescriptionTypeRequired*Additional information
Token

ProcessOne payment token

string No
ServerReferenceData

Additional response data

ServerReferenceData No
PostedAmount

Transaction Posted Amount

decimal number No
BankName

Bank name

string No
TransactionId

Transaction ID

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

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "Token": null,
  "ServerReferenceData": null,
  "PostedAmount": 0.0,
  "BankName": "Bank name",
  "TransactionId": "99991",
  "TransactionDate": "2020-10-27T06:34:05",
  "TimeZone": "PDT",
  "BatchNumber": 0,
  "ResponseCode": "Success",
  "Message": "Success"
}
<DebitEftResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <BankName>Bank name</BankName>
  <BatchNumber>0</BatchNumber>
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2020-10-27T06:34:05</TransactionDate>
  <TransactionId>99991</TransactionId>
  <PostedAmount>0</PostedAmount>
  <ServerReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts" i:nil="true" />
  <Token i:nil="true" />
</DebitEftResponse>

POST api/Eft/Void

This operation provides a way to void or cancel a previously made EFT payment that has not been fully processed yet. If a payment was already processed, a refund operation is required. You have to provide the transaction id of a transaction that you want to void. You can include a callback id if you prefer to get the information about a void transaction record by the callback id.

MethodEndpoint
Void https://stgapiprocessone.oneincsystems.com/api/Eft/Void

VoidEftRequest

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction ID

string Yes
CallbackId

Callback ID

string No
AuthenticationKey

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": "99991",
  "CallbackId": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <VoidEftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <CallbackId i:nil="true" />
  <TransactionId>99991</TransactionId>
</VoidEftRequest>

Response Information

VoidEftResponse

NameDescriptionTypeRequired*Additional information
TransactionId

string No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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": null,
  "ResponseCode": "Success",
  "Message": "Success"
}
<VoidEftResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <TransactionId i:nil="true" />
</VoidEftResponse>

POST api/Eft/Refund

This operation provides a way to refund a previously made EFT payment that has been fully processed. To initiate a refund, call this API operation and provide a valid transaction id. You can include a callback id if you prefer to get the information about the refund transaction record by the callback id. Note: As payment transactions cannot be refunded until after they have been settled, if the batch has not yet closed for the transaction id in the refund request, the system will automatically Void the payment.

MethodEndpoint
Refund https://stgapiprocessone.oneincsystems.com/api/Eft/Refund

RefundEftRequest

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction ID to refund

string Yes
CallbackId

CallBack ID

string No
PartialRefundAmount

Amount to refund

decimal number No
AuthenticationKey

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": "99991",
  "CallbackId": null,
  "PartialRefundAmount": 10.0,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <RefundEftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <CallbackId i:nil="true" />
  <PartialRefundAmount>10</PartialRefundAmount>
  <TransactionId>99991</TransactionId>
</RefundEftRequest>

Response Information

RefundEftResponse

NameDescriptionTypeRequired*Additional information
TransactionId

Transaction ID

string No
BatchNumber

integer No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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": null,
  "BatchNumber": 0,
  "ResponseCode": "Success",
  "Message": "Success"
}
<RefundEftResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <BatchNumber>0</BatchNumber>
  <TransactionId i:nil="true" />
</RefundEftResponse>

POST api/Eft/VerifyBankAccount

This operation provides a way to verify the validity of a bank account information. Verification of bank account ensures that our customers have valid bank information before authorizing payments. This also prevents users from inputting incorrect bank account number.

MethodEndpoint
VerifyBankAccount https://stgapiprocessone.oneincsystems.com/api/Eft/VerifyBankAccount

VerifyBankAccountRequest

NameDescriptionTypeRequired*Additional information
EftDetails

EFT details

EftDetails No
Token

Saved Eft Token

string No
ClientReferenceData

Client reference data

ClientReferenceData No
CustomerId

A customer id associated with transaction

string No
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "EftDetails": {
    "RoutingNumber": "122199983",
    "AccountNumber": "92361077941",
    "Type": 0,
    "CustomerName": "John Stevens",
    "TokenReusability": 0
  },
  "Token": null,
  "ClientReferenceData": {
    "ClientReferenceData1": "1234",
    "ClientReferenceData2": "20ff1106-59ff-4567-ab20-8ca93a935e20",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "CustomerId": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <VerifyBankAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <ClientReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
    <d2p1:ClientReferenceData1>1234</d2p1:ClientReferenceData1>
    <d2p1:ClientReferenceData2>20ff1106-59ff-4567-ab20-8ca93a935e20</d2p1:ClientReferenceData2>
    <d2p1:ClientReferenceData3>Location</d2p1:ClientReferenceData3>
    <d2p1:ClientReferenceData4 i:nil="true" />
    <d2p1:ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <CustomerId i:nil="true" />
  <EftDetails>
    <AccountNumber>92361077941</AccountNumber>
    <CustomerName>John Stevens</CustomerName>
    <RoutingNumber>122199983</RoutingNumber>
    <TokenReusability>Undefined</TokenReusability>
    <Type>Undefined</Type>
  </EftDetails>
  <Token i:nil="true" />
</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

Message

Response message

string No

Message 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

{
  "ServerReferenceData": null,
  "ResponseCode": "Success",
  "Message": "Success"
}
<VerifyBankAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <ServerReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts" i:nil="true" />
</VerifyBankAccountResponse>

POST api/Eft/GetBankData

This operation provides information about the bank that is associated with the provided routing number. If a non-existing routing number is provided in the request, the API will respond with an appropriate error message.

MethodEndpoint
GetBankData https://stgapiprocessone.oneincsystems.com/api/Eft/GetBankData

GetBankDataRequest

NameDescriptionTypeRequired*Additional information
RoutingNumber

The bank routing number. Must only contain numbers.

string Yes
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "RoutingNumber": "123123123",
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <GetBankDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Authentication Key</AuthenticationKey>
  <RoutingNumber>123123123</RoutingNumber>
</GetBankDataRequest>

Response Information

GetBankDataResponse

NameDescriptionTypeRequired*Additional information
Description

Description

string No
BankName

Name of Bank based of Routing Number.

string No
BankAddress

Bank Institution Address.

string No
BankCity

City Name of Bank Institution.

string No
BankState

State of Bank.

string No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "Description": null,
  "BankName": "Test Bank",
  "BankAddress": "test address",
  "BankCity": "Test city",
  "BankState": "State",
  "ResponseCode": "Success",
  "Message": "Success"
}
<GetBankDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">Success</ResponseCode>
  <BankAddress>test address</BankAddress>
  <BankCity>Test city</BankCity>
  <BankName>Test Bank</BankName>
  <BankState>State</BankState>
  <Description i:nil="true" />
</GetBankDataResponse>

POST api/Eft/GetConvenienceFee

This operation returns the EFT convenience fee amount that corresponds to the specified fee type and dollar amount. If fee type is not provided, the API will return the default convenience fee type for your merchant. Convenience fee types vary from merchant to merchant and have to be addressed during contract negotiation.

MethodEndpoint
GetConvenienceFee https://stgapiprocessone.oneincsystems.com/api/Eft/GetConvenienceFee

ConvenienceFeeRequest

NameDescriptionTypeRequired*Additional information
Amount

Charge amount

decimal number No
ConvenienceFeeType

Convenience fee type

string No
IsRecurring

Is recurring Convenience Fee

boolean No
AuthenticationKey

Instance authentication key

string Yes

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

Request Formats

 
                                
                                 {
  "Amount": 1.0,
  "ConvenienceFeeType": "sample string 1",
  "IsRecurring": true,
  "AuthenticationKey": "sample string 3"
}
                                
                                 <ConvenienceFeeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 3</AuthenticationKey>
  <Amount>1</Amount>
  <ConvenienceFeeType>sample string 1</ConvenienceFeeType>
  <IsRecurring>true</IsRecurring>
</ConvenienceFeeRequest>

Response Information

ConvenienceFeeResponse

NameDescriptionTypeRequired*Additional information
ConvenienceFee

Convenience fee

decimal number No
CalculationType

Fee calculation type for current fee tier

string No
FlatRate

Flat rate for fee tier, applicable for CalculationType = FlatRate

decimal number No
Percent

Percent rate for fee tier, applicable for CalculationType = Percent

decimal number No
MinimumAmount

Minimum fee amount, applicable for CalculationType = Percent

decimal number No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "ConvenienceFee": 1.0,
  "CalculationType": "sample string 2",
  "FlatRate": 1.0,
  "Percent": 1.0,
  "MinimumAmount": 1.0,
  "ResponseCode": "sample string 3",
  "Message": "sample string 4"
}
<ConvenienceFeeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 4</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 3</ResponseCode>
  <CalculationType>sample string 2</CalculationType>
  <ConvenienceFee>1</ConvenienceFee>
  <FlatRate>1</FlatRate>
  <MinimumAmount>1</MinimumAmount>
  <Percent>1</Percent>
</ConvenienceFeeResponse>

POST api/Eft/ProcessPreNote

This operation allows processing of PreNotes used to verify Bank Accounts. You can either provide a bank account information or use a previously saved token. The transaction may be a Pre-Note Debit/Credit Type and apply to Checking or Savings Account.

MethodEndpoint
ProcessPreNote https://stgapiprocessone.oneincsystems.com/api/Eft/ProcessPreNote

ProcessPreNoteRequest

NameDescriptionTypeRequired*Additional information
EftDetails

Eft details

EftDetails No

Required, if Token field is not specified

PreNoteTransactionType

Pre-Note Credit or Debit.

PreNoteType No
Save

Enables to save and tokenize eft information

boolean No
TransactionOrigination

Establishes transaction origination to define Standard Entry Class (SEC) code type for Automated Clearing House (ACH) File

TransactionOrigination No
Token

Saved Eft token

string No
ClientReferenceData

Client reference data

ClientReferenceData No
CallbackId

Callback ID

string No
CustomerId

A customer id associated with transaction

string No
AccountGroupCode

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

string No
AuthenticationKey

Instance authentication key

string Yes

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

PreNoteType

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

PreNoteDebitBankAccount

1

PreNote Debit Bank Account

PreNoteCreditBankAccount

2

PreNote Credit Bank Account

Request Formats

 
                                
                                 {
  "EftDetails": {
    "RoutingNumber": "sample string 1",
    "AccountNumber": "sample string 2",
    "Type": 0,
    "CustomerName": "sample string 4",
    "TokenReusability": 0
  },
  "PreNoteTransactionType": 0,
  "Save": true,
  "TransactionOrigination": 0,
  "Token": "sample string 2",
  "ClientReferenceData": {
    "ClientReferenceData1": "sample string 1",
    "ClientReferenceData2": "sample string 2",
    "ClientReferenceData3": "sample string 3",
    "ClientReferenceData4": "sample string 4",
    "ClientReferenceData5": "sample string 5"
  },
  "CallbackId": "sample string 3",
  "CustomerId": "sample string 4",
  "AccountGroupCode": "sample string 5",
  "AuthenticationKey": "sample string 6"
}
                                
                                 <ProcessPreNoteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <AuthenticationKey xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 6</AuthenticationKey>
  <AccountGroupCode>sample string 5</AccountGroupCode>
  <CallbackId>sample string 3</CallbackId>
  <ClientReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.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>
  <CustomerId>sample string 4</CustomerId>
  <EftDetails>
    <AccountNumber>sample string 2</AccountNumber>
    <CustomerName>sample string 4</CustomerName>
    <RoutingNumber>sample string 1</RoutingNumber>
    <TokenReusability>Undefined</TokenReusability>
    <Type>Undefined</Type>
  </EftDetails>
  <PreNoteTransactionType>Undefined</PreNoteTransactionType>
  <Save>true</Save>
  <Token>sample string 2</Token>
  <TransactionOrigination>Undefined</TransactionOrigination>
</ProcessPreNoteRequest>

Response Information

ProcessPreNoteResponse

NameDescriptionTypeRequired*Additional information
Token

ProcessOne payment token

string No
ServerReferenceData

Additional response data

ServerReferenceData No
BankName

Bank name

string No
TransactionId

Transaction ID

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

string No

ResponseCode should be used for programmatic handling of the response.

See Response Code Definitions

Message

Response message

string No

Message 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

{
  "Token": "sample string 1",
  "ServerReferenceData": {
    "ServerReferenceData1": "sample string 1"
  },
  "BankName": "sample string 2",
  "TransactionId": "sample string 3",
  "TransactionDate": "2020-10-27T06:34:09",
  "TimeZone": "sample string 4",
  "BatchNumber": 5,
  "ResponseCode": "sample string 6",
  "Message": "sample string 7"
}
<ProcessPreNoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts.Eft">
  <Message xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 7</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">sample string 6</ResponseCode>
  <BankName>sample string 2</BankName>
  <BatchNumber>5</BatchNumber>
  <TimeZone>sample string 4</TimeZone>
  <TransactionDate>2020-10-27T06:34:09</TransactionDate>
  <TransactionId>sample string 3</TransactionId>
  <ServerReferenceData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OneInc.ProcessOne.RestApi.Contracts.DataContracts">
    <d2p1:VerifyBankAccountDescription>sample string 1</d2p1:VerifyBankAccountDescription>
  </ServerReferenceData>
  <Token>sample string 1</Token>
</ProcessPreNoteResponse>

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
MerchantDisabled Your Merchant account is disabled. All
IncorrectValidationValue The CVV2 code is invalid. ChargeCreditCard | ChargeCreditCardNoFee
AvsVerificationFailed AVS failed. ChargeCreditCard | ChargeCreditCardNoFee
IncorrectTransactionId Indicates that the transactionID that you are sending for a refund or void is not a valid transaction or cannot be found. GetTokenInfo | RefundCreditCard | RefundEFT | UpdateCreditCard | UpdateTransactionMetadata | VoidCreditCard | VoidEFT
InvalidCardNumber This is an invalid card number. Can also indicate that this is a closed account. ChargeCreditCard | ChargeCreditCardNoFee | SaveCreditCard | VerifyCreditCard
CardExpired The Card is Expired. ChargeCreditCard | ChargeCreditCardNoFee | SaveCreditCard | VerifyCreditCard
MaxAllowablePaymentsExceeded Maximum Allowable payments exceeded for policy or account. ChargeCreditCard | ChargeCreditCardNoFee | DebitEFT | DebitEFTWithFee
CardTypeNotAccepted The card type provided is not supported. ChargeCreditCard | ChargeCreditCardNoFee | SaveCreditCard | VerifyCreditCard
Declined The transaction was declined by the issuing bank. ChargeCreditCard | ChargeCreditCardNoFee | SaveCreditCard | VerifyCreditCard
Call Indicates that the merchant should call the issuing bank. It is likely fraud. ChargeCreditCard | ChargeCreditCardNoFee | SaveCreditCard | VerifyCreditCard
GatewayInternalError This generic error can happen for different reasons. The error description will contain more detailed information as to the core of the problem. All
InvalidRoutingNumber You have sent in an invalid Routing Number. GetBankData | CreditEFT | DebitEFT | DebitEFTWithFee | SaveEFT | VerifyBankAccount
InvalidAccountNumber You have sent in an invalid Account Number. CreditEFT | DebitEFT | DebitEFTWithFee | SaveEFT | VerifyBankAccount
BlockedBankAccount This bank account has been blocked due to past failed payments. DebitEFT | DebitEFTWithFee | SaveEFT
InvalidEFTAmount Amount must be greater than $0. CreditEFT | DebitEFT | DebitEFTWithFee | GetEftConvenienceFee
EFTCustomerNameMissing When processing an EFT, you must supply the customer name or you will receive this error. CreditEFT | DebitEFT | DebitEFTWithFee | SaveEFT
CreditCardCustomerNameMissing When saving a credit card you must provide the customer name. ChargeCreditCard | ChargeCreditCardNoFee | SaveCreditCard | VerifyCreditCard
ACHTransactionFailed Returned when an error returns for processing EFTDebit transactions. CreditEFT | DebitEFT | DebitEFTWithFee
CreditCardVoidFailed The voiding of the credit card transaction has failed. VoidCreditCard
CreditCardVoidFailed The voiding of the credit card transaction has failed. VoidCreditCard
BatchHasBeenClosed This error message is returned when you attempt to void a transaction when the batch has already been closed. VoidCreditCard | VoidEFT
OverMaximumPayment Payment Amount has exceeded maximum allowed. ChargeCreditCard | ChargeCreditCardNoFee | CreditEFT | DebitEFT | DebitEFTWithFee
InvalidCreditCardAmount You have sent in an invalid amount for credit card transaction. Usually occurs when sending in a zero dollar amount. ChargeCreditCard | ChargeCreditCardNoFee | GetCreditCardConvenienceFeeAmount | RefundCreditCard
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. ChargeCreditCard | ChargeCreditCardNoFee | CreditEFT | DebitEFT | DebitEFTWithFee | RefundCreditCard
InvalidZipcode An invalid zip code was passed. ChargeCreditCard | ChargeCreditCardNoFee | SaveCreditCard | UpdateCreditCard | VerifyCreditCard
InvalidExpirationDate An invalid expiration date was passed. ChargeCreditCard | ChargeCreditCardNoFee | SaveCreditCard | UpdateCreditCard | VerifyCreditCard
UnableToRefundTransaction Transaction has already been refunded. RefundCreditCard | RefundEFT
PartialRefundIsNotAllowed Your merchant is not setup to process partial refunds. Please reach out to the support team if you would like this feature enabled. RefundCreditCard
InvalidPartialRefundAmount An attempt was made to refund more than the original payment. RefundCreditCard
BatchHasNotBeenClosed You have attempted to refund a payment but the batch has not closed. You should void payment instead. RefundCreditCard
NoProcessorResponse An attempt to authorize a card through the card network has timed out. You should try again. All
OperationNotSupportedByGateway This error may occur when trying to execute operation with incorrect settings. VerifyCreditCard
OperationNotSupportedByMerchant This error may occur when trying to execute operation which is currently disabled for merchant. VerifyBankAccount, VerifyCreditCard