Velocity Developer Resources
API Docs
Payment Service Provider Guidelines
The following destination service provider guidelines are available to assist software companies during application testing and certification.
| Affirmative ACH | First Data Nashville Host Capture BCP |
| Chase Orbital Salem Host Capture BCP | WorldPay Host Capture BCP |
| Chase Orbital Tampa Host Capture BCP | Tsys Sierra Terminal Capture BCP |
| Chase Orbital Retail Host Capture BCP | GETI/Sage ECK |
| Chase Tampa Direct Terminal Capture BCP | GETI/Sage SVA |
| First Data BuyPass Host Capture BCP | Valuetec SVA |
Affirmative ACH
Service Overview
The Affirmative ACH Service provides an electronic payment processing solution via the Automated Clearing House (ACH) Network—an electronic network for processing financial transactions in the United States.
| Electronic Checking (ECK) Support | Automated Clearing House (ACH) Note: The Affirmative ACH Now Adaptor supports the BillingTree ACH Gateway Service. |
| Supported Industries | eCommerce, Retail, and MOTO |
| Certification Testing | ACH Test Data |
Supported Features
The table below lists the payment industries and ACH payment features supported by the Affirmative ACH Service.
| Industry | Support | Integration Notes |
| eCommerce | ||
| Retail | ||
| Restaurant | ||
| MOTO | ||
| Check Processing Supported Features | ||
| Electronic Check Acceptance | ||
| Customer-Not-Present | ||
| QueryAccount (Account Verification) | ||
| Check Guarantee | ||
| Automated Clearing House (ACH) | ||
| Cash Concentration or Disbursement (CCD) | Used for Credit or PIN Debit transactions. | |
| Prearranged Payment and Deposit (PPD) | Used for Credit or PIN Debit transactions. | |
| Back Office Conversion (BOC) | Used for PIN Debit transactions only. | |
| Telephone Initiated Entry (TEL) | Used for PIN Debit transactions only. | |
| Internet Initiated Entry (WEB) | Used for PIN Debit transactions only. | |
Requirements
Details associated with each supported feature listed above are provided below.
- Individual check transactions are submitted as needed using Authorize.
- Supported SEC Codes include:
- Cash Concentration or Disbursement (CCD) – This transaction can be either a credit or a debit and is used where funds are distributed or consolidated between corporate entities. This is the transaction type that is best suited in a B2B environment or for corporations with multiple levels of hierarchy who want to do funds “sweeping” among their banks and companies.
- Prearranged Payment and Deposit (PPD) – In both a debit and credit PPD transaction an existing relationship must be established to move funds to or from a bank account. A typical credit PPD transaction is used for direct deposit of payroll, interest payments, investment dividends etc. In a preauthorized or prearranged debit transaction, a consumer grants the company authority to initiate periodic charges to his or her account as bills become due. This works particularly well with recurring payments where the amount of the transactions does not vary or only have small variation. Obvious examples are insurance premiums, mortgage payments, and utility payments.
- Back Office Conversion (BOC) – This transaction type enables businesses to accept eligible paper checks at the point of sale or at a manned bill- payment location and then convert those checks into ACH debits. The conversion of the checks takes place in the merchant’s “back office”, a separate processing site, or even by a third party service provider in a separate location. There are some restrictions regarding the types of checks and dollar amounts that can be accepted but these restrictions rarely affect standard retail merchants.
- Telephone Initiated Entry (TEL) – This transaction type is used for the creation of a single debit transaction to a consumer’s bank account after that consumer has given oral authorization for the transaction via the telephone. In this case the consumer and the merchant must either (a) have an existing relationship or (b) the transaction/new relationship must be initiated by the consumer.
- Internet Initiated Entry (WEB) – This transaction type is used for the creation of a debit entries (can be single use or recurring) to a consumer’s account after that consumer has given authorization via an internet acceptance method. There are strict requirements regarding the necessary language for security procedures and obligations.
- QueryAccount validates an ABA/Account Number against the Accuity Verification Service. (Must be set up by Affirmative Technologies Support before it will be functional). Affirmative does not verify funds availability, and does not accept amount as an input value. Affirmative accepts the routing and account numbers and returns an indicator as to whether the account is ACH capable, and modified account or routing numbers to use for check processing, if present.
- If ElectronicCheckingTransactionResponse.ACHCapable = “false”, the account/routing number cannot be used for electronic ACH processing and must be processed with a paper check. If a modified account or routing number is returned, those numbers should be used for the check transaction. This is useful for verifying the information before running the charge, such as during the initial setup of a recurring payment.
- Check transactions that have not been committed can be voided using Undo.
- CaptureAll is used to notify Affirmative that the submitted check transactions are ready to be processed. All checks submitted (but not voided since the last CaptureAll) will be processed. There is no selective processing.
- ACH does not provide confirmation of money moved. The system provides confirmation that money was sent to the ACH Network. The money is assumed moved unless returned within 48 hours from the settlement date (Monday originations will return Tuesday and Wednesday, and in rare cases, as late as Thursday). Chargebacks can be returned up to 60 days from receiver’s bank statement (total of 90 days).
- The successful CaptureAll response reports the number of transactions submitted and the hashed total of those transactions. The ElectronicCheckingCaptureResponse.ServiceTransactionId returned is the batch number.
- The ACH gateway does not require that a customer close their batches manually. However, some customers prefer to close their batches manually at the end of each business day, while other customers prefer to have the ACH gateway perform auto-close of batches. Software company applications may execute the web service method, AchNowProcessTransactions, which will close the batch and start the transaction’s processing.
- The nightly cutoff for closing a batch is 5:00PM CST. Merchants who close their batches manually should allocate at least 15 minutes of extra time in case the ACH gateway is busy (end-of-month, end-of-quarter, or both). Merchants who accidentally submit a batch and wish to have it stopped from being submitted to the ACH Network should call Affirmative’s Client Service as soon as possible so that the batch’s progress can be intercepted.
- Merchants can submit multiple batches throughout the day. Some merchants close their current batch at mid-day and again in the evening. The downside is that if the merchant is running an ACH gateway report such as Transactions By Batch or Batch Summaries, they may have to run the report multiple times to locate all of their transactions.
- When the merchant goes through their Client Services ACH gateway training session, they are asked if they want the auto-close batch feature disabled or if they wish to change the time of the closure.
Performing a CommitBatch (Sandbox environment)
- The CaptureAll response from Affirmative ACH will have the total transaction count and the total hashed amount of all checks processed since the last CaptureAll. The Sandbox environment cannot duplicate this behavior at this time. Sandbox will always return a count of 1 and a randomly generated amount that will not match the amount of the checks submitted. Software company applications will receive a response that has the necessary elements, but the count and total amount will not match the actual checks submitted.
Credentials
- Username and password credentials are required for all transactions using the unmanaged addendum (Addendum.Unmanaged):
<UserId>UserID</UserId>
<Password>Password</Password>
Chase Orbital HC Integration Requirements
This guide provides software developers with the specific integration requirements for the following Chase Orbital Host Capture (HC) services:
- Salem Platform
- Tampa Platform
- Retail Platform
Global Orbital Requirements
The following requirements apply to the Salem, Tampa, and Retail platforms.
End-of-Day Processing
- For the Restaurant industry type, merchants are required to send a CaptureAll request at the end of the day or when they reach 2400 transactions.
- At Chase Orbital, the file transmission of deposits begins at approximately 5:00AM EST. This is subject to change without notice and should not impact any merchant(s). Any batches closed before 5:00AM EST will process in the current days’ business. Any batch received after 5:00AM EST will not process until the next business day.
Transaction Retry Limits
- For any transaction where the host responds with a “please retry” message, the POS must limit the number of retries at three (3). After the third authorization attempt, another form of payment must be requested.
Chase Orbital Salem HC
Service Overview
| Platform Type | Host Capture |
| Bankcard Processing (BCP) Support | Credit |
| Supported Industries | eCommerce and MOTO |
| Certification Testing | Trigger Values and Response Codes |
| Merchant Activation | Chase Orbital HC Requirements |
Supported Features
| Industry | Support | Integration Notes |
| eCommerce | ||
| Retail | ||
| Restaurant | ||
| MOTO | ||
| Bankcard Transaction Classes | ||
| Credit | Supported industries are eCommerce and MOTO. | |
| PIN Debit | ||
| PIN-less Debit | ||
| Bankcard Transaction Types (Credit) | ||
| Adjust (Incremental) | ||
| Adjust (Reversal) | ||
| Authorize (Pre-Authorization) | ||
| AuthorizeAndCapture (Authorization) | ||
| Capture (Pre-Auth Completion) | ||
| CaptureAll (Batch Release) | ||
| CaptureAll/CaptureSelective (Batch) | ||
| QueryAccount (Balance Inquiry) | ||
| ReturnById/ReturnUnlinked (Return) |
|
|
| Undo (Void) | ||
| Verify (Non-Capture, AVS only) | ||
| Bankcard Transaction Features | ||
| Address Verification Service (AVS) | Refer to General Guidelines > Address Verification Service (AVS) | |
| Balance Inquiry (Prepaid Credit Cards) | ||
| Canadian Currency | ||
| Card Verification Data (CVD) | Refer to General Guidelines > Card Verification Data (CVD) | |
| Cardholder Activated Transactions | ||
| Contactless Cards | ||
| Convenience Fees | ||
| Credit Cash Back (Discover only) | ||
| Deferred Payments | ||
| IIAS (Supports FSA for Health Care) | ||
| Installment Payments | Refer to General Guidelines > Installment Payments | |
| Level 2 Data |
CWS API Data Elements: BankcardTransactionDataPro, Level2Data, Tax, TaxExempt |
|
| Level 3 Data |
CWS API Data Elements: BankcardTransactionDataPro, Level2Data, LineItemDetail |
|
| MasterCard SecureCode (MCSC) | Refer to General Guidelines > MasterCard SecureCode | |
| Partial Approvals | Refer to General Guidelines > Partial Approvals | |
| PIN-less Debit | ||
| QuasiCash Indicator | ||
| Recurring Payments | Refer to General Guidelines > Recurring Payments | |
| Soft Descriptors | Soft Descriptor data is passed using the BankcardTransactionData.AlternativeMerchantData data element. | |
| Verified-by-Visa (VbV) | Refer to General Guidelines > Verified-by-Visa | |
Chase Orbital Tampa HC
Service Overview
| Platform Type | Host Capture |
| Bankcard Processing (BCP) Support | Credit |
| Supported Industries | eCommerce and MOTO |
| Certification Testing | Trigger Values and Response Codes |
| Merchant Activation | Chase Orbital HC Requirements |
Supported Features
| Industry | Support | Integration Notes |
| eCommerce | ||
| Retail | ||
| Restaurant | ||
| MOTO | ||
| Bankcard Transaction Classes | ||
| Credit | Supported industries are eCommerce and MOTO. | |
| PIN Debit | ||
| PIN-less Debit | ||
| Bankcard Transaction Types (Credit) | ||
| Adjust (Incremental) | ||
| Adjust (Reversal) | ||
| Authorize (Pre-Authorization) | ||
| AuthorizeAndCapture (Authorization) | ||
| Capture (Pre-Auth Completion) | ||
| CaptureAll (Batch Release) | ||
| CaptureAll/CaptureSelective (Batch) | ||
| QueryAccount (Balance Inquiry) | ||
| ReturnById/ReturnUnlinked (Return) |
|
|
| Undo (Void) | ||
| Verify (Non-Capture, AVS only) | ||
| Bankcard Transaction Features | ||
| Address Verification Service (AVS) | Refer to General Guidelines > Address Verification Service (AVS) | |
| Balance Inquiry (Prepaid Credit Cards) | ||
| Canadian Currency | ||
| Card Verification Data (CVD) | Refer to General Guidelines > Card Verification Data (CVD) | |
| Cardholder Activated Transactions | ||
| Contactless Cards | ||
| Convenience Fees | ||
| Credit Cash Back (Discover only) | ||
| Deferred Payments | ||
| IIAS (Supports FSA for Health Care) | ||
| Installment Payments | Refer to General Guidelines > Installment Payments | |
| Level 2 Data |
CWS API Data Elements: BankcardTransactionDataPro, Level2Data, Tax, TaxExempt |
|
| Level 3 Data |
CWS API Data Elements: BankcardTransactionDataPro, Level2Data, LineItemDetail |
|
| MasterCard SecureCode (MCSC) | Refer to General Guidelines > MasterCard SecureCode | |
| Partial Approvals | Refer to General Guidelines > Partial Approvals | |
| QuasiCash Indicator | ||
| Recurring Payments | Refer to General Guidelines > Recurring Payments | |
| Soft Descriptors | ||
| Verified-by-Visa (VbV) | Refer to General Guidelines > Verified-by-Visa | |
Chase Orbital Retail HC
Service Overview
| Platform Type | Host Capture |
| Bankcard Processing (BCP) Support | Credit |
| Supported Industries | Retail |
| Certification Testing | Trigger Values and Response Codes |
| Merchant Activation | Chase Orbital HC Requirements |
Supported Features
| Industry | Support | Integration Notes |
| eCommerce | ||
| Retail | ||
| Restaurant | ||
| MOTO | ||
| Bankcard Transaction Classes | ||
| Credit |
|
|
| PIN Debit | ||
| PIN-less Debit | ||
| Bankcard Transaction Types (Credit) | ||
| Adjust (Incremental) | ||
| Adjust (Reversal) | ||
| Authorize (Pre-Authorization) | ||
| AuthorizeAndCapture (Authorization) | ||
| Capture (Pre-Auth Completion) | ||
| CaptureAll (Batch Release) | ||
| CaptureAll/CaptureSelective (Batch) | ||
| QueryAccount (Balance Inquiry) | ||
| ReturnById/ReturnUnlinked (Return) |
|
|
| Undo (Void) | ||
| Verify (Non-Capture, AVS only) | ||
| Bankcard Transaction Features | ||
| Address Verification Service (AVS) | Refer to General Guidelines > Address Verification Service (AVS) | |
| Balance Inquiry (Prepaid Credit Cards) | ||
| Canadian Currency | ||
| Card Verification Data (CVD) | Refer to General Guidelines > Card Verification Data (CVD) | |
| Cardholder Activated Transactions | ||
| Contactless Cards | ||
| Convenience Fees | ||
| Credit Cash Back (Discover only) | ||
| Deferred Payments | ||
| IIAS (Supports FSA for Health Care) | ||
| Installment Payments | ||
| Level 2 Data |
CWS API Data Elements: BankcardTransactionDataPro, Level2Data, Tax, TaxExempt |
|
| Level 3 Data | ||
| MasterCard SecureCode (MCSC) | ||
| Partial Approvals | ||
| PIN-less Debit | ||
| QuasiCash Indicator | ||
| Recurring Payments | Refer to General Guidelines > Recurring Payments | |
| Soft Descriptors | ||
| Verified-by-Visa (VbV) | ||
Chase Tampa Direct TC
Service Overview
| Platform Type | Terminal Capture |
| Bankcard Processing (BCP) Support | Credit, PIN Debit |
| Supported Industries | eCommerce, Retail, Restaurant, and MOTO |
| Certification Testing | Trigger Values and Response Codes |
| Merchant Activation | Chase Tampa Direct TC Requirements |
Functional Changes
- BankcardTransactionResponse.StatusCode will now contain the response code, not the words “Error” or “Approved”.
- BankcardTransactionResponse.StatusMessage has been updated to show whether an approval is full or partial and whether or not the credit card is prepaid.
- BankcardTransaction.BankcardTransactionData.OrderId is now sent to Chase in the POS Retrieval Reference Number field. This data was previously adaptor generated.
Supported Features
| Industry | Support | Integration Notes |
| eCommerce | ||
| Retail | ||
| Restaurant | ||
| MOTO | ||
| Bankcard Transaction Classes | ||
| Credit |
|
|
| PIN Debit |
CWS API Data Elements: BankcardTransaction, BankcardTenderData, CardSecurityData |
|
| PIN-less Debit | ||
| Bankcard Transaction Types (Credit) | ||
| Adjust (Incremental) | Adjust (Incremental) are offline transactions. | |
| Adjust (Reversal) | Adjust (Reversal) are online transactions. | |
| Authorize (Pre-Authorization) | ||
| AuthorizeAndCapture (Authorization) | ||
| Capture (Pre-Auth Completion) | ||
| CaptureAll (Batch Release) | ||
| CaptureAll/CaptureSelective (Batch) | CaptureAll will no longer query the Chase host for PIN Debit totals and compare them to the batch totals. Merchants will no longer be required to have a host capture set up with Chase unless they are processing PIN Debit transactions. | |
| QueryAccount (Balance Inquiry) |
|
|
| ReturnById/ReturnUnlinked (Return) | ||
| Undo (Void) | Undo negative amount adjustments (Reversals) are now online transactions. | |
| Verify (Non-Capture, AVS only) | Verify supports zero dollar authorization amounts.
Refer to General Guidelines > Address Verification for more information. |
|
| Bankcard Transaction Features | ||
| Address Verification Service (AVS) | Refer to General Guidelines > Address Verification Service (AVS) | |
| Balance Inquiry (Prepaid Credit Cards) | Refer to General Guidelines > Balance Inquiry | |
| Canadian Currency | ||
| Card Verification Data (CVD) | Refer to General Guidelines > Card Verification Data (CVD) | |
| Cardholder Activated Transactions | Refer to General Guidelines > Cardholder Activated Transactions | |
| Contactless Cards |
CWS API Data Elements: ApplicationData, BankcardTransactionDataDefaults |
|
| Convenience Fees | ||
| Credit Cash Back (Discover only) | ||
| Deferred Payments | ||
| IIAS (Supports FSA for Health Care) | Refer to General Guidelines > IIAS and Healthcare Card Processing | |
| Installment Payments | Refer to General Guidelines > Installment Payments | |
| Level 2 Data |
CWS API Data Elements: BankcardTransactionDataPro, Level2Data, Tax, TaxExempt |
|
| Level 3 Data | ||
| MasterCard SecureCode (MCSC) | Refer to General Guidelines > MasterCard SecureCode | |
| Partial Approvals | Refer to General Guidelines > Partial Approvals | |
| PIN-less Debit | ||
| QuasiCash Indicator | ||
| Recurring Payments | Refer to General Guidelines > Recurring Payments | |
| Soft Descriptors | ||
| Verified-by-Visa (VbV) | Refer to General Guidelines > Verified-by-Visa | |
| Bankcard Transaction Types (PIN Debit) | ||
| AuthorizeAndCapture (Authorization) | ||
| QueryAccount (Balance Inquiry) | ||
| ReturnUnlinked (Return) |
|
|
| Undo (Void) |
|
|
| Scrip Devices | ||
Miscellaneous Requirements
End-of-Day Processing
- Merchants are required to send a CaptureAll request at the end of each business day or when they reach 2400 transactions. Up to 2400 transactions can be in a single batch upload.
- At Chase Paymentech, the file transmission of deposits begins at approximately 5:00AM EST. This is subject to change without notice and should not impact any merchant(s). Any batches closed before 5:00AM EST will process in the current days’ business. Any batch received after 5:00AM EST will not process until the next business day.
Transaction Retry Limits
- For any transaction where the host responds with a “please retry” message, the POS must limit the number of retries at three (3). After the third authorization attempt, another form of payment must be requested.
Private Label Cards
The following private label cards are supported. Merchants must be approved to support these cards during their account setup with Chase Paymentech.
- In Good Taste
- Club Card
- Smarte Carte
- TCRS Consumer Card
- RAI
- Sears PL
First Data BuyPass HC
Service Overview
| Platform Type | Host Capture |
| Bankcard Processing (BCP) Support | Credit, PIN Debit, PIN-less Debit |
| Supported Industries | eCommerce, Retail, and MOTO |
| Certification Testing | Trigger Values and Response Codes |
| Merchant Activation | First Data BuyPass HC Requirements |
Supported Features
| Industry | Support | Integration Notes |
| eCommerce | ||
| Retail | ||
| Restaurant | Restaurant is not supported due to FDC’s inability to support tips or adjustments. Restaurant transactions should be processed as Retail. | |
| MOTO | ||
| Bankcard Transaction Classes | ||
| Credit |
|
|
| PIN Debit |
CWS API Data Elements: BankcardTransaction, BankcardTenderData, CardSecurityData |
|
| PIN-less Debit |
CWS API Data Elements: BankcardTransactionDataPro, PINlessDebitData, PayeeData |
|
| Bankcard Transaction Types (Credit) | ||
| Adjust (Incremental) | ||
| Adjust (Reversal) | ||
| Authorize (Pre-Authorization) | ||
| AuthorizeAndCapture (Authorization) | ||
| Capture (Pre-Auth Completion) | ||
| CaptureAll (Batch Release) | ||
| CaptureAll/CaptureSelective (Batch) | ||
| QueryAccount (Balance Inquiry) |
|
|
| ReturnById/ReturnUnlinked (Return) | ||
| Undo (Void) | ||
| Verify (Non-Capture, AVS only) | ||
| Bankcard Transaction Features | ||
| Address Verification Service (AVS) | Refer to General Guidelines > Address Verification Service (AVS) | |
| Balance Inquiry (Prepaid Credit Cards) | Refer to General Guidelines > Balance Inquiry | |
| Canadian Currency | ||
| Card Verification Data (CVD) | Refer to General Guidelines > Card Verification Data (CVD) | |
| Cardholder Activated Transactions | Refer to General Guidelines > Cardholder Activated Transactions | |
| Contactless Cards |
CWS API Data Elements: ApplicationData, BankcardTransactionDataDefaults, CardData |
|
| Convenience Fees | ||
| Credit Cash Back (Discover only) | ||
| Deferred Payments | Refer to General Guidelines > Deferred Payments | |
| IIAS (Supports FSA for Health Care) | Refer to General Guidelines > IIAS and Healthcare Card Processing | |
| Installment Payments | Refer to General Guidelines > Installment Payments | |
| Level 2 Data | ||
| Level 3 Data | ||
| MasterCard SecureCode (MCSC) | Refer to General Guidelines > MasterCard SecureCode | |
| Partial Approvals | Refer to General Guidelines > Partial Approvals | |
| QuasiCash Indicator | ||
| Recurring Payments | Refer to General Guidelines > Recurring Payments | |
| Soft Descriptors |
CWS API Data Elements: BankcardTransaction, BankcardTransactionData, AlternativeMerchantData, AddressInfo |
|
| Verified-by-Visa (VbV) | Refer to General Guidelines > Verified-by-Visa | |
| Bankcard Transaction Types (PIN Debit) | ||
| AuthorizeAndCapture (Authorization) | ||
| QueryAccount (Balance Inquiry) | ||
| ReturnUnlinked (Return) | Returns should be processed as cash refunds or store credit. | |
| Undo (Void) | Undo transactions require BankcardTransaction.BankcardTenderData.CardData.PAN.
CWS API Data Elements: BankcardTransaction, BankcardTenderData, CardData |
|
| Scrip Devices | Supported for PIN Debit transactions only. | |
Miscellaneous Requirements
End-of-Day Processing
- FDC BuyPass processes transactions on a merchant store day basis. Each of a merchant’s stores must have an “end-of-day” at least once every 24 hours. To facilitate this, BuyPass establishes a default end-of-day for each store. At that time, BuyPass ends the store’s day, and moves data and/or funds based on the default end-of-day. The default end-of-day is 2:00PM EST.
First Data Nashville HC
Service Overview
The merchant must retrieve the On-line Debit Bin from FDMS. The On-line Debit BIN file is available to merchants every day. The various debit networks send updates to FDMS at different times during the week. FDMS updates the file on a daily basis. The On-line Debit BIN is received/retrieved on a weekly basis. The On-line Debit Bin File will be used to identify which cards can be submitted as PIN-less Debit transactions.
| Platform Type | Host Capture |
| Bankcard Processing (BCP) Support | Credit, PIN Debit, PIN-less Debit |
| Supported Industries | eCommerce, Retail, Restaurant, and MOTO |
| Certification Testing | Trigger Values and Response Codes |
| Merchant Activation | First Data Nashville HC Requirements |
Supported Features
| Industry | Support | Integration Notes |
| eCommerce | ||
| Retail | ||
| Restaurant | ||
| MOTO | ||
| Bankcard Transaction Classes | ||
| Credit |
|
|
| PIN Debit |
CWS API Data Elements: BankcardTransaction, BankcardTenderData, CardSecurityData |
|
| PIN-less Debit |
CWS API Data Elements: BankcardTransactionDataPro, PINlessDebitData, PayeeData |
|
| Bankcard Transaction Types (Credit) | ||
| Adjust (Incremental) | ||
| Adjust (Reversal) | ||
| Authorize (Pre-Authorization) | ||
| AuthorizeAndCapture (Authorization) | ||
| Capture (Pre-Auth Completion) | ||
| CaptureAll (Batch Release) | ||
| CaptureAll/CaptureSelective (Batch) | ||
| QueryAccount (Balance Inquiry) | Support for credit card balance inquiry or available credit prior to the initiation of a purchase transaction. | |
| ReturnById/ReturnUnlinked (Return) | ||
| Undo (Void) | ||
| Verify (Non-Capture, AVS only) | ||
| Bankcard Transaction Features | ||
| Address Verification Service (AVS) | Refer to General Guidelines > Address Verification Service (AVS) | |
| Balance Inquiry (Prepaid Credit Cards) | Refer to General Guidelines > Balance Inquiry | |
| Canadian Currency | ||
| Card Verification Data (CVD) | Refer to General Guidelines > Card Verification Data (CVD) | |
| Cardholder Activated Transactions | Refer to General Guidelines > Cardholder Activated Transactions | |
| Contactless Cards |
CWS API Data Elements: ApplicationData, BankcardTransactionDataDefaults, CardData |
|
| Convenience Fees | ||
| Credit Cash Back (Discover only) | ||
| Deferred Payments | Refer to General Guidelines > Deferred Payments | |
| IIAS (Supports FSA for Health Care) | Refer to General Guidelines > IIAS and Healthcare Card Processing | |
| Installment Payments | Refer to General Guidelines > Installment Payments | |
| Level 2 Data | ||
| Level 3 Data | ||
| MasterCard SecureCode (MCSC) | Refer to General Guidelines > MasterCard SecureCode | |
| Partial Approvals | Refer to General Guidelines > Partial Approvals | |
| QuasiCash Indicator | ||
| Recurring Payments | Refer to General Guidelines > Recurring Payments | |
| Soft Descriptors |
CWS API Data Elements: BankcardTransaction, BankcardTransactionData, AlternativeMerchantData, AddressInfo |
|
| Verified-by-Visa (VbV) | Refer to General Guidelines > Verified-by-Visa | |
| Bankcard Transaction Types (PIN Debit) | ||
| AuthorizeAndCapture (Authorization) | ||
| QueryAccount (Balance Inquiry) | ||
| ReturnUnlinked (Return) | Returns should be processed as cash refunds or store credit. | |
| Undo (Void) |
CWS API Data Elements: BankcardTransaction, BankcardTenderData, CardData, CardSecurityData |
|
| Scrip Devices | Supported for PIN Debit transactions only. | |
WorldPay HC
Service Overview
| Platform Type | Host Capture |
| Bankcard Processing (BCP) Support | Credit, PIN Debit |
| Supported Industries | eCommerce, Retail, Restaurant, and MOTO |
| Certification Testing | Generic BCP Trigger Values and Response Codes |
| Merchant Activation | WorldPay HC Requirements |
Supported Features
| Industry | Support | Integration Notes |
| eCommerce | ||
| Retail | ||
| Restaurant | ||
| MOTO | ||
| Bankcard Transaction Classes | ||
| Credit | Supported industries are eCommerce, Retail, Restaurant, and MOTO. | |
| PIN Debit | ||
| PIN-less Debit | ||
| Bankcard Transaction Types (Credit) | ||
| Adjust (Incremental) | ||
| Adjust (Reversal) | ||
| Authorize (Pre-Authorization) | ||
| AuthorizeAndCapture (Authorization) | ||
| Capture (Pre-Auth Completion) | ||
| CaptureAll (Batch Release) | ||
| CaptureAll/CaptureSelective (Batch) | ||
| QueryAccount (Balance Inquiry) | ||
| ReturnById/ReturnUnlinked (Return) | ||
| Undo (Void) | ||
| Verify (Non-Capture, AVS only) | ||
| Bankcard Transaction Features | ||
| Address Verification Service (AVS) | Refer to General Guidelines > Address Verification Service (AVS) | |
| Balance Inquiry (Prepaid Credit Cards) | ||
| Canadian Currency | ||
| Card Verification Data (CVD) | Refer to General Guidelines > Card Verification Data (CVD) | |
| Cardholder Activated Transactions | ||
| Contactless Cards | ||
| Convenience Fees | ||
| Credit Cash Back (Discover only) | ||
| Deferred Payments | ||
| IIAS (Supports FSA for Health Care) | ||
| Installment Payments | ||
| Level 2 Data | ||
| Level 3 Data | ||
| MasterCard SecureCode (MCSC) | Refer to General Guidelines > MasterCard SecureCode | |
| Partial Approvals | ||
| QuasiCash Indicator | ||
| Recurring Payments | Refer to General Guidelines > Recurring Payments | |
| Soft Descriptors | ||
| Verified-by-Visa (VbV) | Refer to General Guidelines > Verified-by-Visa | |
| Bankcard Transaction Types (PIN Debit) | ||
| AuthorizeAndCapture (Authorization) | ||
| QueryAccount (Balance Inquiry) | ||
| ReturnUnlinked (Return) | ||
| Undo (Void) | ||
| Scrip Devices | ||
Miscellaneous Requirements
Credentials
- Username and password credentials are required for all transactions using the unmanaged addendum (Addendum.Unmanaged):
<UserId>UserID</UserId>
<Password>Password</Password>
Tsys Sierra TC
Service Overview
| Platform Type | Terminal Capture |
| Bankcard Processing (BCP) Support | Credit, PIN Debit |
| Supported Industries | eCommerce, Retail, Restaurant, and MOTO |
| Certification Testing | Generic BCP Trigger Values and Response Codes |
| Merchant Activation | Tsys Sierra TC Requirements |
Supported Features
| Industry | Support | Integration Notes |
| eCommerce | ||
| Retail | ||
| Restaurant | ||
| MOTO | ||
| Bankcard Transaction Classes | ||
| Credit | ||
| PIN Debit | ||
| PIN-less Debit | ||
| Bankcard Transaction Types (Credit) | ||
| Adjust (Incremental) | ||
| Adjust (Reversal) | ||
| Authorize (Pre-Authorization) | ||
| AuthorizeAndCapture (Authorization) | ||
| Capture (Pre-Auth Completion) | ||
| CaptureAll (Batch Release) | ||
| CaptureAll/CaptureSelective (Batch) | ||
| QueryAccount (Balance Inquiry) | ||
| ReturnById/ReturnUnlinked (Return) | ||
| Undo (Void) | ||
| Verify (Non-Capture, AVS only) | ||
| Bankcard Transaction Features | ||
| Address Verification Service (AVS) | Refer to General Guidelines > Address Verification Service (AVS) | |
| Balance Inquiry (Prepaid Credit Cards) | ||
| Canadian Currency | ||
| Card Verification Data (CVD) | Refer to General Guidelines > Card Verification Data (CVD) | |
| Cardholder Activated Transactions | ||
| Contactless Cards | ||
| Convenience Fees | ||
| Credit Cash Back (Discover only) | ||
| Deferred Payments | ||
| IIAS (Supports FSA for Health Care) | ||
| Installment Payments | Refer to General Guidelines > Installment Payments | |
| Level 2 Data | ||
| Level 3 Data | ||
| MasterCard SecureCode (MCSC) | ||
| Partial Approvals | ||
| QuasiCash Indicator | ||
| Recurring Payments | Refer to General Guidelines > Recurring Payments | |
| Soft Descriptors | ||
| Verified-by-Visa (VbV) | ||
| Bankcard Transaction Types (PIN Debit) | ||
| AuthorizeAndCapture (Authorization) | ||
| QueryAccount (Balance Inquiry) | ||
| ReturnUnlinked (Return) | ||
| Undo (Void) | ||
| Scrip Devices | ||
GETI/Sage
Service Overview
The GETI/Sage Service provides an electronic payment processing solution via the Automated Clearing House (ACH) Network—an electronic network for processing financial transactions in the United States.
| Electronic Checking (ECK) Support | Automated Clearing House (ACH) |
| Supported Industries | Retail |
Supported Features
The table below lists the payment industries and ACH payment features supported by the GETI/Sage Service.
| Industry | Support | Integration Notes |
| eCommerce | – | |
| Retail | ||
| Restaurant | ||
| MOTO | ||
| Check Processing Supported Features | ||
| Electronic Check Acceptance | ||
| Customer-Not-Present | ||
| QueryAccount (Account Verification) | x | |
| Check Guarantee | ||
| Automated Clearing House (ACH) | x | |
| Cash Concentration or Disbursement (CCD) | Used for Credit | |
| Prearranged Payment and Deposit (PPD) | Used for Credit or Debit | |
| Back Office Conversion (BOC) | Used for Credit or Debit | |
| Telephone Initiated Entry (TEL) | Used for Credit or Debit | |
| Internet Initiated Entry (WEB) | Used for Credit or Debit. | |
| Point-of-Purchase Entry (POP) | Used for Credit or Debit. | |
Requirements
Details associated with each supported feature listed above are provided below.
- Individual check transactions are submitted as needed using Authorize.
- Supported SEC Codes include:
- Cash Concentration or Disbursement (CCD) – A prearranged payment and deposit entry is either a standing or single entry authorization where the funds are transferred to or from a business account.
- Prearranged Payment and Deposit (PPD) – A prearranged payment and deposit entry is either a standing or single entry authorization where the funds are transferred to or from a consumers account.
- Telephone Initiated Entry (TEL) – A telephone initiated entry is a payment for goods or services made with a single entry debit with oral authorization obtained from the consumer via the telephone.
- Internet Initiated Entry (WEB) – An internet initiated entry is a method of payment for goods or services made via the internet.
- Point-of-Purchase Entry (POP) – The Point-of-Purchase method of payment is for purchases made for goods or services in person by the consumer. These are non-recurring debit entries. A check reading device must be used to capture the routing number, account number, and check number from the source document (check). The source document cannot be previously used for any prior POP entry, and the source document must be voided and returned to the customer at the point-of-purchase. In addition a signed receipt must be obtained at the point-of-purchase and retained for 2 years from the settlement date. The “Authorization Requirements” section in the Authorization Gateway Specification document contains additional information on the receipt requirements.
- Check 21 (C21) – Although not an SEC Code C21 is used to denote Check 21 transactions. Check 21 requires a check reading device capture the routing number, account number, and check number from the source document (Check) as well as capture images of both the front and back of the source document.
GETI/Sage SVA
Service Overview
Platform Type Gift Card / Loyalty
Supported Features
Industry Support eCommerce Retail Restaurant MOTO Manage Account Transaction Types Activate Activate eCertificate Transfer Status Redeem Reload Balance Inquiry Void Manage Account By ID Transaction Types Activate Status Reload Balance Transfer Void <UserId>UserID</UserId>
<Password>Password</Password>
Valuetec SVA
Service Overview
Platform Type Gift Card / Loyalty
Supported Features
Industry Support eCommerce Retail Restaurant MOTO Manage Account Transaction Types Activate Redeem Reload Balance Inquiry Void Deactivate Manage Account By ID Transaction Types Activate Reload Void Deactivate Credentials
<UserId>UserID</UserId>
<Password>Password</Password>
Global HC
Service Overview
Platform Type Host Capture Bankcard Processing (BCP) Support Credit, PIN Debit Supported Industries eCommerce, Retail, Restaurant, and MOTO Certification Testing Generic BCP Trigger Values and Response Codes Merchant Activation Global East Requirements Supported Features
Industry Support Integration Notes eCommerce Retail Restaurant MOTO Bankcard Transaction Classes Credit PIN Debit PIN-less Debit MOTO Only Bankcard Transaction Types (Credit) Adjust (Incremental) Adjust (Reversal) Authorize (Pre-Authorization) AuthorizeAndCapture (Authorization) Capture (Pre-Auth Completion) CaptureAll (Batch) CaptureSelective (Batch) QueryAccount (Balance Inquiry) EBT Only ReturnById/ReturnUnlinked (Return) Undo (Void) Verify (Non-Capture, AVS only) Bankcard Transaction Features Address Verification Service (AVS) Refer to General Guidelines > Address Verification Service (AVS) Balance Inquiry (Prepaid Credit Cards) Canadian Currency Card Verification Data (CVD) Refer to General Guidelines > Card Verification Data (CVD) Cardholder Activated Transactions Contactless Cards Convenience Fees Credit Cash Back (Discover only) Deferred Payments IIAS (Supports FSA for Health Care) Installment Payments Level 2 Data Level 3 Data MasterCard SecureCode (MCSC) Refer to General Guidelines > MasterCard SecureCode Partial Approvals QuasiCash Indicator Recurring Payments Refer to General Guidelines > Recurring Payments Soft Descriptors Verified-by-Visa (VbV) Refer to General Guidelines > Verified-by-Visa EBT Purchase (Food Stamp/Cash Benefits) Restaurant/Retail Only EBT Return (Food Stamp/Cash Benefits) Restaurant/Retail Only EBT Balance Inquiry (Food Stamp/Cash Benefits) Restaurant/Retail Only EBT Food Stamps Voucher Clear Restaurant/Retail Only Bankcard Transaction Types (PIN Debit) AuthorizeAndCapture (Authorization) QueryAccount (Balance Inquiry) EBT only ReturnUnlinked (Return) Undo (Void) Scrip Devices
Global TC
Service Overview
Platform Type Terminal Capture Bankcard Processing (BCP) Support Credit, PIN Debit Supported Industries eCommerce, Retail, Restaurant, and MOTO Certification Testing Generic BCP Trigger Values and Response Codes Merchant Activation Global East Requirements Supported Features
Industry Support Integration Notes eCommerce Retail Restaurant MOTO Bankcard Transaction Classes Credit PIN Debit PIN-less Debit Bankcard Transaction Types (Credit) Adjust (Incremental) Adjust (Reversal) Authorize (Pre-Authorization) AuthorizeAndCapture (Authorization) Capture (Pre-Auth Completion) CaptureAll (Batch) CaptureSelective (Batch) QueryAccount (Balance Inquiry) EBT Only ReturnById/ReturnUnlinked (Return) Undo (Void) Verify (Non-Capture, AVS only) Bankcard Transaction Features Address Verification Service (AVS) Refer to General Guidelines > Address Verification Service (AVS) Balance Inquiry (Prepaid Credit Cards) Canadian Currency Card Verification Data (CVD) Refer to General Guidelines > Card Verification Data (CVD) Cardholder Activated Transactions Contactless Cards Convenience Fees Credit Cash Back (Discover only) Deferred Payments IIAS (Supports FSA for Health Care) Installment Payments Refer to General Guidelines > Installment Payments Level 2 Data Level 3 Data MasterCard SecureCode (MCSC) Partial Approvals QuasiCash Indicator Recurring Payments Refer to General Guidelines > Recurring Payments Soft Descriptors Verified-by-Visa (VbV) EBT Purchase (Food Stamp/Cash Benefits) Restaurant/Retail Only EBT Return (Food Stamp/Cash Benefits) Restaurant/Retail Only EBT Balance Inquiry (Food Stamp/Cash Benefits) Restaurant/Retail Only EBT Food Stamps Voucher Clear Restaurant/Retail Only Bankcard Transaction Types (PIN Debit) AuthorizeAndCapture (Authorization) QueryAccount (Balance Inquiry) EBT Only ReturnUnlinked (Return) Undo (Void) Scrip Devices Updated: June 5, 2017
Need Help?
SUBMIT A DEVELOPER SUPPORT REQUEST
Agent or a merchant? Contact NAB support at 866.485.8999 EXT 2341
Support
Sales
