Gift and Stored Value Card API Fields

FieldNameLength
Type
Description
0001Transaction Type2
numeric
Required. Refer to the Transaction Matrix.
0007Reference Number7
numeric
Unique reference number to transaction. <noteStyle>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.</noteStyle>
0011User-Defined Field80
alphanumeric
Conditional. Required for SVS virtual cards only. Value = VIRTUAL
0017Cash Back1-14
cents
Conditional. Amount of cash back included in the amount Field 0002. Required for SVS virtual cards only.
0018Debit PIN Block16
alphanumeric
Conditional. Required for SVS virtual cards only. Value = 1234
0036Transaction Identifier1-15
alphanumeric
Conditional. Contains the unique tracking number assigned by the credit card issuing bank. Third Party Processor Interface- specific.
0043System Trace Audit Number6
numeric
Conditional. A host assigned reference number used for tracking purposes. When returned, must be printed on receipt.
0060Unique Device ID1-8
numeric
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.
0115Transaction Qualifier3
numeric
Required. Identified type of account used. Gift and Stored Value Card = 050. Refer to the Transaction Matrix.
0117Stored Value Function1
numeric
Required. Indicates Stored value transaction function:
1 = Activate
2 = Issue
3 = Reload
4 = Return
5 = Redeem
6 = Redeem w/ cash back
7 = Prior Auth
0128CPS Original Authorization Amount1-14
cents
Conditional. Valid format: 0.00 – 99999.99
0130CPS Total Authorized Amount1-14
cents
Conditional. Approved Amount. Valid format: 0.00 – 99999.99
0201Tip Amount1-14
cents
Conditional. Amount of Tip Valid format: 0.00 – 9999.99. Third Party Processor Interface-specific.
0632Account Balance1-14
cents
Conditional. New Account Balance. Valid format: 0.00 – 99999.99. Third Party Processor Interface- specific.
0645Previous Balance11
numeric
Conditional. Previous balance on card. Third Party Processor Interface- specific.
1035Total Number of Cards2
numeric
Conditional. Total number of cards being issued at one time. Third Party Processor Interface- specific.
1036Sequence Number of Card2
numeric
Conditional. Determines sequence numbers when multiple cards are issued. Third Party Processor Interface- specific.

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

TransactionTran Type (API 0001)Debit PIN Block* (API 0018)Transaction Qualifier (API 0115)Stored Value Function (API 0117)Tip Amount (API 0201)
Authorization Only01050N/A
Close Card020503
Redemption020505
Redemption Virtual0212340505
Redemption (Cash Back/Cash Out/Unload)020506
Tip020505$$$$$$.$$
IVR Authorized Redemption070507
Prior Auth/Unlock070507
Card Activation090501
Issue Card090502
Issue Virtual Card090502
Reload/Recharge090503
Return090504
Void Redemption110505
Void Redemption (Cash/Cash Back/Unload)110506
Void Prior Auth/Unlock/IVR Auth110507
Local Batch Close13N/A
Local Batch Inquiry14N/A
Void Activation/Deactivate170501
Void Card Issue170502
Void Reload/Recharge170503
Void Return170504
Balance Inquiry24050N/A

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