Elavon downloads and stores cookies on your device when you visit our website. We use these cookies to better understand and improve your browsing experience by identifying most visited pages, personalising content, and measuring site performance.

Essential cookies enable core functionality such as page navigation and access to secure areas. The website cannot function properly without these cookies; they can only be disabled by changing your browser preferences.

Performance cookies help us to improve our website by collecting and reporting information on its usage (for example, which of our pages are most frequently visited).

Cookie Settings

Elavon Financial Services DAC. Registered in Ireland – Number 418442.
Registered Office: Block F1, Cherrywood Business Park, Dublin 18, D18 W2X7, Ireland.
Elavon Financial Services DAC, trading as Elavon Merchant Services, is regulated by the Central Bank of Ireland.
 
Elavon Financial Services DAC. Registered in Ireland with Companies Registration Office. The liability of the member is limited. United Kingdom branch registered in England and Wales under the number BR022122.
Elavon Financial Services DAC, trading as Elavon Merchant Services, is a credit institution authorised and regulated by the Central Bank of Ireland.  Authorised by the Prudential Regulation Authority.  Subject to regulation by the Financial Conduct Authority and limited regulation by the Prudential Regulation Authority.  Details about the extent of our regulation by the Prudential Regulation Authority are available from us on request.

**0001 (Transaction Type)**
- Description: Required. Refer to the Transaction Matrix. 
- Length: 2 
- Data Type: Numeric

**0007 (Reference Number)**
- Description: Unique reference number to transaction. 
**Important**: Elavon does not recommend padding the Reference Number field (Field 0007) with leading zeros. Should you choose to do so, be sure to store the value in your system as a String instead of an Integer. This will eliminate any potential discrepancies in how this field is presented in two-part transactions, and the chance of downgrades or fees is greatly reduced. 
- Length: 7 
- Data Type: Numeric

**0011 (User-Defined Field)**
- Description: Conditional. Required for SVS virtual cards only.  Value = VIRTUAL 
- Length: 80
- Data Type: Alphanumeric

**0017 (Cash Back)**
- Description: Conditional. Amount of cash back included in the amount Field 0002. Required for SVS virtual cards only.  
- Length: 1 - 14
- Data Type: cents

**0018 (Debit PIN Block)**
- Description: Conditional. Required for SVS virtual cards only. Value = 1234
- Length: 16
- Data Type: alphanumeric
 
**0036 (Transaction Identifier)** 
- Description: Conditional. Contains the unique tracking number assigned by the credit card issuing bank. Third-Party Processor Interface specific.
- Length: 1 - 15
- Data Type: alphanumeric

**0043 (System Trace Audit Number)**
- Description: Conditional. A host assigned reference number used for tracking purposes. When returned, must be printed on receipt.
- Length: 6
- Data Type: numeric

**0060 (Unique Device ID)** 
- Description: Required. Must be stored and displayed and may be used for settlement. Used to identify the source lane or terminal through which a transaction is processed.
- Length: 1 - 8
- Data Type: numeric

**0115 (Transaction Qualifier)**
- Description: Required. Identified type of account used. Gift and Stored Value Card = 050. Refer to the Transaction Matrix.
- Length: 3
- Data Type: numeric

**0117 (Stored Value Function)** 
- Description: Required. Indicates Stored value transaction function.
Valid Values are: 
    - 1 = Activate 
    - 2 = Issue 
    - 3 = Reload 
    - 4 = Return
    - 5 = Redeem 
    - 6 = Redeem with cash back
    - 7 = Prior Auth 
- Length: 1
- Data Type: numeric

**0128 (CPS Original Authorization Amount)** 
- Description: Conditional. Valid format: 0.00 – 99999.99
- Length: 1 - 14
- Data Type: cents
 
**0130 (CPS Total Authorized Amount)**
- Description: Conditional. Approved Amount. Valid format: 0.00 – 99999.99
- Length: 1 - 14
- Data Type: cents

**0201 (Tip Amount)**
- Description: Conditional. Amount of Tip
Valid format: 0.00 – 9999.99. Third-Party Processor Interface-specific.
- Length: 1 - 14
- Data Type: cents

**0632 (Account Balance)**
- Description: Conditional. New Account Balance.
Valid format: 0.00 – 9999.99. Third Party Processor Interface-specific.
- Length: 1 - 14
- Data Type: cents

**0645 (Previous Balance)**
- Description: Conditional. Previous balance on card. Third Party Processor Interface-specific.
- Length: 11
- Data Type: numeric

**1035 (Total Number of Cards)**
- Description: Conditional. Total number of cards being issued at one time. Third Party Processor Interface-specific.
- Length: 2
- Data Type: numeric

**1036 (Sequence Number of Card)**
- Field Name: 
- Description: Conditional. Determines sequence numbers when multiple cards are issued. Third Party Processor Interface-specific.
- Length: 2
- Data Type: numeric

## Additional Card Information:


::page-heading-list{min-level=3 max-level=3 }


### Declines of Approved Cards

-   INACTIVE CARD - Doing any transaction other than Activate or Issue for a card that is not already active. 

-   INSUFF FUNDS - Redeeming more than available balance allows. 

-   CRD ALRDY ISSUED - Activate or Issue requested on a card that has already been issued. 
 
-   CRD NOT ISSUED - Card Reload transaction used on a card that has not been Issued or Activated.

-   CARD ALRDY USED - Reversal/Cancel transaction attempted on issue gift card after card has been redeemed. 

-   CARD FROZEN - Trying to lock the amount when a lock already exists. 

-   NO RECORDS FOUND - Previous transaction could not be found.

### Approvals

To get an approval, use any card number that is not defined in Demo Card Scenarios. While most requests are approved, logic is performed based on the status and balance of a card which can result in the following declines.

### Account Balance and Open-to-Buy (24)

Transaction Type 24 (Account Balance and Open-to-Buy) is used to obtain the current account balance or open-to-buy amount for an association pre-paid gift card or stored value card. Pre-paid gift cards are not supported by all TPPS. If the TPP does not support this transaction type, a TRANSACTION NOT SUPPORTED error is returned from the application.

It is recommended that the POS application support this transaction type. Refer to the appropriate Third Party Processor Interface guide(s) for additional information on how to determine if this transaction type is supported, and the requirements for the Input Request and Output Response.

### Gift and Stored Value Card Transaction Matrix

**Transaction (Authorization Only)**
- Tran Type (API 0001) = 01
- Debit PIN Block\* (API 0018)   
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = N/A
- Tip Amount (API 0201)

**Tran Type (API 0001)** = Close Card 02
- Debit PIN Block\* (API 0018)  
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 3
- Tip Amount (API 0201)

**Tran Type (API 0001)** = Redemption 02
- Debit PIN Block\* (API 0018)  
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 5
- Tip Amount (API 0201)
 
**Tran Type (API 0001)** = Redemption Virtual 02
- Debit PIN Block\* (API 0018) = 1234
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 5
- Tip Amount (API 0201)

**Tran Type (API 0001)** = (Cash Back/Cash Out/Unload) 02
- Debit PIN Block\* (API 0018)  
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 6
- Tip Amount (API 0201)

**Tran Type (API 0001)** = Tip 02
- Debit PIN Block\* (API 0018)
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 5
- Tip Amount (API 0201) = $$$$$$.$$

**Tran Type (API 0001)** = IVR Authorized Redemption 07 
- Debit PIN Block\* (API 0018)  
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 7
- Tip Amount (API 0201) 

**Tran Type (API 0001)** = Prior Auth/Unlock 07
- Debit PIN Block\* (API 0018)  
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 7
- Tip Amount (API 0201)

**Tran Type (API 0001)** = Card Activation 09
- Debit PIN Block\* (API 0018) 
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 1
- Tip Amount (API 0201)

**Tran Type (API 0001)** = Card Activation 09
- Debit PIN Block\* (API 0018)  
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 1
- Tip Amount (API 0201) 

**Tran Type (API 0001)** = Issue Card 09
- Debit PIN Block\* (API 0018)  
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 1
- Tip Amount (API 0201) 

**Tran Type (API 0001)** = Issue Virtual Card 09
- Debit PIN Block\* (API 0018)  
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 2
- Tip Amount (API 0201)  

**Tran Type (API 0001)** = Reload/Recharge 09
- Debit PIN Block\* (API 0018)*  
- Transaction Qualifier (API0115) = 050
- Stored Value Function (API 0117) = 3
- Tip Amount (API 0201) 

**Tran Type (API 0001)** = Return 09
- Debit PIN Block\* (API 0018)  
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 4
- Tip Amount (API 0201)  

**Tran Type (API 0001)** = Void Redemption 11
- Debit PIN Block\* (API 0018) 
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 5
- Tip Amount (API 0201)  

**Tran Type (API 0001)** = Void Redemption 11
- Debit PIN Block\* (API 0018)  
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 5
- Tip Amount (API 0201)   

**Tran Type (API 0001)** = (Cash/Cash Back/Unload) 11
- Debit PIN Block\* (API 0018)  
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 6
- Tip Amount (API 0201)  
 
**Tran Type (API 0001)** = Void Prior Auth/Unlock/IVR Auth 11
- Debit PIN Block\* (API 0018) 
- Transaction Qualifier (API 0115) = 050
- Stored Value Function (API 0117) = 7
- Tip Amount (API 0201) 

**Tran Type (API 0001)** = Local Batch Close 13
- Debit PIN Block\* (API 0018) 
- Transaction Qualifier (API 0115) =  
- Stored Value Function (API 0117) = N/A
- Tip Amount (API 0201)

**Tran Type (API 0001)** = Local Batch Inquiry 14
- Debit PIN Block\* (API 0018)  
- Transaction Qualifier (API 0115)  
- Stored Value Function (API 0117) = N/A
- Tip Amount (API 0201)

**Tran Type (API 0001)** = Void Activation/Deactivate 17
- Debit PIN Block\* (API 0018)  
- Transaction Qualifier (API 0115) =  50
- Stored Value Function (API 0117) = 1
- Tip Amount (API 0201)

**Tran Type (API 0001)** = Void Card Issue 17
- Debit PIN Block\* (API 0018) 
- Transaction Qualifier (API 0115) =  50
- Stored Value Function (API 0117) = 2
- Tip Amount (API 0201)

**Tran Type (API 0001)** = Void Reload/Recharge 17
- Debit PIN Block\* (API 0018)  
- Transaction Qualifier (API 0115) =  50
- Stored Value Function (API 0117) = 3
- Tip Amount (API 0201) 

**Tran Type (API 0001)** = Void Return 17
- Debit PIN Block\* (API 0018) 
- Transaction Qualifier (API 0115) =  50
- Stored Value Function (API 0117) = 4
- Tip Amount (API 0201) 

**Tran Type (API 0001)** = Balance Inquiry 24
- Debit PIN Block\* (API 0018) 
- Transaction Qualifier (API 0115) =  50
- Stored Value Function (API 0117) = N/A
- Tip Amount (API 0201) 

:::::notice{note}
API Field 0018 is used only in conjunction with Virtual Cards.
:::::


Gift card demo mode runs transactions that mimic gift card functionality. For example, any approved card can be redeemed until the amount issued is exhausted. All cards are reset automatically at midnight, Eastern (EST). 



Gift and Stored Value Card API Fields

Alliance Offers

Data as a Service

Invitation to Apply

Accounts

Bank Holidays

Card Activation

Card Controls

Commercial Credit Cards

Credit Card Account Details

Credit Card Accounts Overview

Credit Card Alerts

Credit Card Application Status

Credit Card APRs

Credit Card Disputes - Coming Soon

Credit Card Payments

Credit Card Qualified Offers

Credit Card Statements

Credit Card Transactions

Data Sharing for Marketing Purposes

Digital Wallets

Make a Payment - Coming Soon

Rewards Accelerator

Rewards Automatic Redemption

Rewards: Balance Summary

Rewards Redemption - Coming Soon

Rewards Redemption Accounts

Rewards Redemptions

Rewards Transactions Earned and Redeemed

Travel Notifications

User Profile

3DSecure2

Avvance

CheckoutJs

Commerce SDK

Converge

Disputes Management

Dynamic Currency Conversion

eBoarding

Elavon Cloud Payments Interface

Elavon Payment Gateway

Fusebox

Hosted Payment Page

In Person Payments on Opayo

Leads

Lightbox payment modal

Online Payments on Opayo

Opayo

Opayo Direct

Opayo Forms

Opayo Reporting API

Opayo Server

Opayo Shared API

Payment Method Gateway

Payments Core 365

Simplify

viaconex

XML API

Access Online Transactions

Account Transfers

Account Validation

ACH Originations

Bank Information

Card as a Service

Card as a Service API

Check Payables

Core Banking API

Corporate Account Information

Corporate Credit Cards

Corporate Onboarding

Corporate Statements

Custody

Data Toolbox

Data Toolbox - Accounts

Data Toolbox - Documents

Data Toolbox - Transactions

Disbursements via Zelle®

U.S. Bank Flexible Capital Platform

Freight Payment Customer Profiles

Freight Payment Transactions

Instant Payments

Investment Accounting

Money Movement API

PaySmart

Payee Choice

Payee Token+

Personal Loans

Positive Pay

Push to Card

Receivables

Reference API

RTP® - Real-Time Payments

Tokenized Payments

Treasury Builder

U.S. Bank FBO Account

Virtual Account Reporting

Virtual Card Payments

Voyager Accounts

Voyager Cards

Voyager Drivers

Voyager Transactions

Voyager Vehicles

Wire Transfers

Fusebox Overview

Getting Started

Transaction Flow

API Message Format

Transaction Sequencing

Reconciliation

Settlements

Transaction Types

Authorization Only (01)

Sale Transaction (02)

Prior-Authorized Sale (07)

Return (09)

Void Sale (11)

Batch Close (13)

Batch Create and Inquiry (14)

Void Return (17)

Transaction Inquiry (22)

Full Authorization Reversal (61)

Heartbeat (73)

Incremental Authorization (75)

Partial Authorization Reversal (76)

Concepts

Tokenization

Tokenization introduction

Tokenization API fields

Tokenization scenarios

Example transactions

Error scenarios

Retail

Retail Scenarios

Retail API Fields

Retail Examples

Lodging

Lodging Transactions

Lodging API Fields

Lodging Examples

Credential on File Transactions

Best Practices

Software Conversions

Restaurant

Restaurant Transactions

Restaurant API Fields

Restaurant Examples

Restaurant Credential on File Transactions

Restaurant Receipts

MOTO and eCommerce

eCommerce Transactions

MOTO and eCommerce API Fields

Ecommerce Examples

Direct Marketing Examples

eCommerce Credential on File Transactions

EMV Transactions

Implementation Considerations

Certification

EMV API Fields

EMV Public Cap Keys, Parameters, and Reports

Sample Files

EMV Receipts

EMV Integration Samples

API Based Settlement

Settlement Transactions

API-Based Settlement API Fields

API-Based Settlement Examples

Check Payment

Check Transactions

Check API Fields

Check Payment Examples

DCC Transactions

DCC Transaction Flows

DCC API Fields

DCC Examples

DCC Receipt Requirements

DCC Certification Process

Gift and Stored Value Cards

Gift and Stored Value Card Transactions

Gift and Stored Value Card Examples

Online Debit Transactions

Online Debit API Fields

Online Debit Examples

Private Label Cards

Private Label Transactions

Private Label API Fields

Private Label Examples

Health Savings Account Cards

HSA Support

Fusebox and Simplify HSA Card Support

HSA Card API Fields

Puerto Rico

E4 Support

API Fields

EBT Transactions

IVU Transactions