The documentation below outlines every method available through the Express StoreCard API and the input fields necessary to post a request. For additional details on any specific enumeration values, feel free to reference the Express Interface Specification Express Interface API v2.8.4
GiftCardActivate
Activate a gift card
Input Fields
Name | Class | Required | Description |
ApplicationID | Application | Required | Unique application identifier |
ApplicationName | Application | Required | Name of application |
ApplicationVersion | Application | Required | Version of application |
AccountID | Credentials | Required | Unique account identifier |
AccountToken | Credentials | Required | Token used for authentication |
AcceptorID | Credentials | Required | Merchant ID |
TransactionAmount | Transaction | Required | Gift card activation amount |
ClerkNumber | Transaction | Optional | Clerk number |
ShiftID | Transaction | Optional | Shift ID |
ReferenceNumber | Transaction | Optional | Unique value assigned by the transaction sender |
TicketNumber | Transaction | Optional | Unique numeric value assigned by the transaction sender |
MarketCode | Transaction | Required | Market Code |
PartialApprovedFlag | Transaction | Required | Partial approval flag (Boolean) (Required for gift card support) |
TerminalID | Terminal | Required | Unique terminal identifier. For First Data/ValueLink, ensure TerminalID submitted matches First Data/ValueLink configuration. |
CardPresentCode | Terminal | Required | Card Present Code |
CardholderPresentCode | Terminal | Required | Cardholder Present Code |
CardInputCode | Terminal | Required | Card Input Code |
CVVPresenceCode | Terminal | Required | Card Verification Value Presence Code |
TerminalCapabilityCode | Terminal | Required | Terminal Capability Code |
TerminalEnvironmentCode | Terminal | Required | Terminal Environment Code |
MotoECICode | Terminal | Required | Mail Order Telephone Order Electronic Indicator Code |
TerminalEncryptionFormat | Terminal | Optional | Terminal encryption format from integrated encryption device |
TerminalSerialNumber | Terminal | Optional | Terminal serial number from integrated encryption device |
StoreCardID | Terminal | Required | StoreCard Unique Identifier |
StoreCardPassword | Terminal | Required | Password used to authenticate to StoreCard services |
Track1Data | Card | Conditional 1 | Track 1 data |
Track2Data | Card | Conditional 1 | Track 2 data |
CardNumber | Card | Conditional 1 | Account number on card |
ExpirationMonth | Card | Conditional 1 | Expiration month |
ExpirationYear | Card | Conditional 1 | Expiration year |
CVV | Card | Conditional | Gift card verification value |
GiftCardSecurityCode | Card | Conditional | Gift card security code |
EncryptedTrack2Data | Card | Conditional 1 | Encrypted Track 2 Data from integrated encryption device |
EncryptedTrack1Data | Card | Conditional 1 | Encrypted Track 1 Data from integrated encryption device |
EncryptedCardData | Card | Conditional 1 | Encrypted Card Data (keyed) from integrated encryption device |
MagneprintData | Card | Conditional 1 | Encrypted Magneprint Data from integrated encryption device |
CardDataKeySerialNumber | Card | Conditional 1 | Card Data Key Serial Number from integrated encryption device |
EncryptedFormat | Card | Optional | Encryption format from integrated encryption device |
FootNote : 1 | Only one of the following field groups needs to be included: CardNumber / ExpirationMonth / ExpirationYear, Track2Data, Track1Data, EncryptedTrack2Data, EncryptedTrack1Data, EncryptedCardData or MagneprintData. | ||
Output Fields
Name | Class | Returned | Description |
ExpressResponseCode | Response | Returned | Express Response Code. |
ExpressResponseMessage | Response | Returned | Express Response Message. |
HostResponseCode | Response | Returned | Host Response Code. |
ExpressTransactionDate | Response | Returned | Express transaction date formatted [YYYYMMDD] |
ExpressTransactionTime | Response | Returned | Express transaction time formatted [HHMMSS] |
ExpressTransactionTimezone | Response | Returned | Express transaction UTC time zone |
CardLogo | Response.Card | Returned | Payment brand |
SecondaryCardNumber | Response.Card | Returned for ValueLink | Embossed card number |
TransactionID | Response.Transaction | Returned | Unique transaction identifier |
ApprovalNumber | Response.Transaction | Returned | Approval number assigned by issuer |
ReferenceNumber | Response.Transaction | Conditional Returns input value if supplied | Unique batch item identifier |
AcquirerData | Response.Transaction | Returned | The Acquirer Reference Data |
ProcessorName | Response.Transaction | Returned | Name of processor |
TransactionStatus | Response.Transaction | Returned | Description of status/state of transaction |
TransactionStatusCode | Response.Transaction | Returned | Status/State of transaction |
HostTransactionID | Response.Transaction | Returned | Host transaction identifier |
ApprovedAmount | Response.Transaction | Returned | Approved amount |
BalanceAmount | Response.Transaction | Returned | Gift card balance amount |
BalanceCurrencyCode | Response.Transaction | Returned | Gift card currency code |
GiftCardSale
Redeem a gift card
Input Fields
Name | Class | Required | Description |
ApplicationID | Application | Required | Unique application identifier |
ApplicationName | Application | Required | Name of application |
ApplicationVersion | Application | Required | Version of application |
AccountID | Credentials | Required | Unique account identifier |
AccountToken | Credentials | Required | Token used for authentication |
AcceptorID | Credentials | Required | Merchant ID |
TransactionAmount | Transaction | Required | Transaction amount |
ClerkNumber | Transaction | Optional | Clerk number |
ShiftID | Transaction | Optional | Shift ID |
ReferenceNumber | Transaction | Optional | Unique value assigned by the transaction sender |
TicketNumber | Transaction | Optional | Unique numeric value assigned by the transaction sender |
MarketCode | Transaction | Required | Market Code |
PartialApprovedFlag | Transaction | Required | Partial approval flag (Boolean) (Required for gift card support) |
TerminalID | Terminal | Required | Unique terminal identifier. For First Data/ValueLink, ensure TerminalID submitted matches First Data/ValueLink configuration. |
CardPresentCode | Terminal | Required | Card Present Code |
CardholderPresentCode | Terminal | Required | Cardholder Present Code |
CardInputCode | Terminal | Required | Card Input Code |
CVVPresenceCode | Terminal | Required | Card Verification Value Presence Code |
TerminalCapabilityCode | Terminal | Required | Terminal Capability Code |
TerminalEnvironmentCode | Terminal | Required | Terminal Environment Code |
MotoECICode | Terminal | Required | Mail Order Telephone Order Electronic Indicator Code |
TerminalEncryptionFormat | Terminal | Optional | Terminal encryption format from integrated encryption device |
TerminalSerialNumber | Terminal | Optional | Terminal serial number from integrated encryption device |
StoreCardID | Terminal | Required | StoreCard Unique Identifier |
StoreCardPassword | Terminal | Required | Password used to authenticate to StoreCard services. |
Track1Data | Card | Conditional 1 | Track 1 data |
Track2Data | Card | Conditional 1 | Track 2 data |
CardNumber | Card | Conditional 1 | Account number on card |
ExpirationMonth | Card | Conditional 1 | Expiration month |
ExpirationYear | Card | Conditional 1 | Expiration year |
CVV | Card | Conditional | Gift card verification value |
GiftCardSecurityCode | Card | Conditional | Gift card security code |
EncryptedTrack2Data | Card | Conditional 1 | Encrypted Track 2 Data from integrated encryption device |
EncryptedTrack1Data | Card | Conditional 1 | Encrypted Track 1 Data from integrated encryption device |
EncryptedCardData | Card | Conditional 1 | Encrypted Card Data (keyed) from integrated encryption device |
MagneprintData | Card | Conditional 1 | Encrypted Magneprint Data from integrated encryption device |
CardDataKeySerialNumber | Card | Conditional 1 | Card Data Key Serial Number from integrated encryption device |
EncryptedFormat | Card | Optional | Encryption format from integrated encryption device |
Footnote: 1 | Only one of the following field groups needs to be included: CardNumber / ExpirationMonth / ExpirationYear, Track2Data, Track1Data, EncryptedTrack2Data, EncryptedTrack1Data, EncryptedCardData or MagneprintData. | ||
Output Fields
Name | Class | Returned | Description |
ExpressResponseCode | Response | Returned | Express Response Code. |
ExpressResponseMessage | Response | Returned | Express Response Message. |
HostResponseCode | Response | Returned | Host Response Code. |
ExpressTransactionDate | Response | Returned | Express transaction date formatted [YYYYMMDD] |
ExpressTransactionTime | Response | Returned | Express transaction time formatted [HHMMSS] |
ExpressTransactionTimezone | Response | Returned | Express transaction UTC time zone |
CardLogo | Response.Card | Returned | Payment brand |
SecondaryCardNumber | Response.Card | Returned for ValueLink | Embossed card number |
TransactionID | Response.Transaction | Returned | Unique transaction identifier |
ApprovalNumber | Response.Transaction | Returned | Approval number assigned by issuer |
ReferenceNumber | Response.Transaction | Conditional Returns input value if supplied | Unique batch item identifier |
AcquirerData | Response.Transaction | Returned | The Acquirer Reference Data |
ProcessorName | Response.Transaction | Returned | Name of processor |
TransactionStatus | Response.Transaction | Returned | Description of status/state of transaction |
TransactionStatusCode | Response.Transaction | Returned | Status/State of transaction |
HostTransactionID | Response.Transaction | Returned | Host transaction identifier |
ApprovedAmount | Response.Transaction | Returned | Approved amount |
BalanceAmount | Response.Transaction | Returned | Gift card balance amount |
BalanceCurrencyCode | Response.Transaction | Returned | Gift card currency code |
GiftCardBalanceInquiry
Check the balance of a gift card
Input Fields
Name | Class | Required | Description |
ApplicationID | Application | Required | Unique application identifier |
ApplicationName | Application | Required | Name of application |
ApplicationVersion | Application | Required | Version of application |
AccountID | Credentials | Required | Unique account identifier |
AccountToken | Credentials | Required | Token used for authentication |
AcceptorID | Credentials | Required | Merchant ID |
TransactionAmount | Transaction | Required | Transaction amount (should be 0.00 for balance inquiry) |
ClerkNumber | Transaction | Optional | Clerk number |
ShiftID | Transaction | Optional | Shift ID |
ReferenceNumber | Transaction | Optional | Unique value assigned by the transaction sender |
TicketNumber | Transaction | Optional | Unique numeric value assigned by the transaction sender |
MarketCode | Transaction | Required | Market Code |
PartialApprovedFlag | Transaction | Required | Partial approval flag (Boolean) (Required for gift card support) |
TerminalID | Terminal | Required | Unique terminal identifier. For First Data/ValueLink, ensure TerminalID submitted matches First Data/ValueLink configuration. |
CardPresentCode | Terminal | Required | Card Present Code |
CardholderPresentCode | Terminal | Required | Cardholder Present Code |
CardInputCode | Terminal | Required | Card Input Code |
CVVPresenceCode | Terminal | Required | Card Verification Value Presence Code |
TerminalCapabilityCode | Terminal | Required | Terminal Capability Code |
TerminalEnvironmentCode | Terminal | Required | Terminal Environment Code |
MotoECICode | Terminal | Required | Mail Order Telephone Order Electronic Indicator Code |
TerminalEncryptionFormat | Terminal | Optional | Terminal encryption format from integrated encryption device |
TerminalSerialNumber | Terminal | Optional | Terminal serial number from integrated encryption device |
StoreCardID | Terminal | Required | StoreCard Unique Identifier |
StoreCardPassword | Terminal | Required | Password used to authenticate to StoreCard services. |
Track1Data | Card | Conditional 1 | Track 1 data |
Track2Data | Card | Conditional 1 | Track 2 data |
CardNumber | Card | Conditional 1 | Account number on card |
ExpirationMonth | Card | Conditional 1 | Expiration month |
ExpirationYear | Card | Conditional 1 | Expiration year |
CVV | Card | Conditional | Gift card verification value |
GiftCardSecurityCode | Card | Conditional | Gift card security code |
EncryptedTrack2Data | Card | Conditional 1 | Encrypted Track 2 Data from integrated encryption device |
EncryptedTrack1Data | Card | Conditional 1 | Encrypted Track 1 Data from integrated encryption device |
EncryptedCardData | Card | Conditional 1 | Encrypted Card Data (keyed) from integrated encryption device |
MagneprintData | Card | Conditional 1 | Encrypted Magneprint Data from integrated encryption device |
CardDataKeySerialNumber | Card | Conditional 1 | Card Data Key Serial Number from integrated encryption device |
EncryptedFormat | Card | Optional | Encryption format from integrated encryption device |
Footnote: 1 | Only one of the following field groups needs to be included: CardNumber / ExpirationMonth / ExpirationYear, Track2Data, Track1Data, EncryptedTrack2Data, EncryptedTrack1Data, EncryptedCardData or MagneprintData. | ||
Output Fields
Name | Class | Returned | Description |
ExpressResponseCode | Response | Returned | Express Response Code. |
ExpressResponseMessage | Response | Returned | Express Response Message. |
HostResponseCode | Response | Returned | Host Response Code. |
ExpressTransactionDate | Response | Returned | Express transaction date formatted [YYYYMMDD] |
ExpressTransactionTime | Response | Returned | Express transaction time formatted [HHMMSS] |
ExpressTransactionTimezone | Response | Returned | Express transaction UTC time zone |
CardLogo | Response.Card | Returned | Payment brand |
SecondaryCardNumber | Response.Card | Returned for ValueLink | Embossed card number |
TransactionID | Response.Transaction | Returned | Unique transaction identifier |
ApprovalNumber | Response.Transaction | Returned | Approval number assigned by issuer |
ReferenceNumber | Response.Transaction | Conditional Returns input value if supplied | Unique batch item identifier |
AcquirerData | Response.Transaction | Returned | The Acquirer Reference Data |
ProcessorName | Response.Transaction | Returned | Name of processor |
TransactionStatus | Response.Transaction | Returned | Description of status/state of transaction |
TransactionStatusCode | Response.Transaction | Returned | Status/State of transaction |
ApprovedAmount | Response.Transaction | Returned | Approved amount |
BalanceAmount | Response.Transaction | Returned | Gift card balance amount |
BalanceCurrencyCode | Response.Transaction | Returned | Gift card currency code |
GiftCardReturn
Refund a gift card (linked to a prior transaction). Refund amount can be up to the original Sale or Completion amount
Input Fields
Name | Class | Required | Description |
ApplicationID | Application | Required | Unique application identifier |
ApplicationName | Application | Required | Name of application |
ApplicationVersion | Application | Required | Version of application |
AccountID | Credentials | Required | Unique account identifier |
AccountToken | Credentials | Required | Token used for authentication |
AcceptorID | Credentials | Required | Merchant ID |
TransactionID | Transaction | Required | Original TransactionID |
TransactionAmount | Transaction | Required | Transaction amount |
ClerkNumber | Transaction | Optional | Clerk number |
ShiftID | Transaction | Optional | Shift ID |
ReferenceNumber | Transaction | Optional | Unique value assigned by the transaction sender |
TicketNumber | Transaction | Optional | Unique numeric value assigned by the transaction sender |
MarketCode | Transaction | Required | Market Code |
PartialApprovedFlag | Transaction | Required | Partial approval flag (Boolean) (Required for gift card support) |
TerminalID | Terminal | Required | Unique terminal identifier. For First Data/ValueLink, ensure TerminalID submitted matches First Data/ValueLink configuration. |
CardPresentCode | Terminal | Required | Card Present Code |
CardholderPresentCode | Terminal | Required | Cardholder Present Code |
CardInputCode | Terminal | Required | Card Input Code |
CVVPresenceCode | Terminal | Required | Card Verification Value Presence Code |
TerminalCapabilityCode | Terminal | Required | Terminal Capability Code |
TerminalEnvironmentCode | Terminal | Required | Terminal Environment Code |
MotoECICode | Terminal | Required | Mail Order Telephone Order Electronic Indicator Code |
TerminalEncryptionFormat | Terminal | Optional | Terminal encryption format from integrated encryption device |
TerminalSerialNumber | Terminal | Optional | Terminal serial number from integrated encryption device |
StoreCardID | Terminal | Required | StoreCard Unique Identifier |
StoreCardPassword | Terminal | Required | Password used to authenticate to StoreCard services. |
CVV | Card | Conditional | Gift card verification value |
GiftCardSecurityCode | Card | Conditional | Gift card security code |
EncryptedFormat | Card | Optional | Encryption format from integrated encryption device |
Footnote: 1 | Only one of the following field groups needs to be included: CardNumber / ExpirationMonth / ExpirationYear, Track2Data, Track1Data, EncryptedTrack2Data, EncryptedTrack1Data, EncryptedCardData or MagneprintData. | ||
Output Fields
Name | Class | Returned | Description |
ExpressResponseCode | Response | Returned | Express Response Code. |
ExpressResponseMessage | Response | Returned | Express Response Message. |
HostResponseCode | Response | Returned | Host Response Code. |
ExpressTransactionDate | Response | Returned | Express transaction date formatted [YYYYMMDD] |
ExpressTransactionTime | Response | Returned | Express transaction time formatted [HHMMSS] |
ExpressTransactionTimezone | Response | Returned | Express transaction UTC time zone |
CardLogo | Response.Card | Returned | Payment brand |
SecondaryCardNumber | Response.Card | Returned for ValueLink | Embossed card number |
TransactionID | Response.Transaction | Returned | Unique transaction identifier |
ApprovalNumber | Response.Transaction | Returned | Approval number assigned by issuer |
ReferenceNumber | Response.Transaction | Conditional Returns input value if supplied | Unique batch item identifier |
AcquirerData | Response.Transaction | Returned | The Acquirer Reference Data |
ProcessorName | Response.Transaction | Returned | Name of processor |
TransactionStatus | Response.Transaction | Returned | Description of status/state of transaction |
TransactionStatusCode | Response.Transaction | Returned | Status/State of transaction |
HostTransactionID | Response.Transaction | Returned | Host transaction identifier |
ApprovedAmount | Response.Transaction | Returned | Approved amount |
BalanceAmount | Response.Transaction | Returned | Gift card balance amount |
BalanceCurrencyCode | Response.Transaction | Returned | Gift card currency code |
GiftCardCredit
Refund a gift card (not linked to a prior transaction)
Input Fields
Name | Class | Required | Description |
ApplicationID | Application | Required | Unique application identifier |
ApplicationName | Application | Required | Name of application |
ApplicationVersion | Application | Required | Version of application |
AccountID | Credentials | Required | Unique account identifier |
AccountToken | Credentials | Required | Token used for authentication |
AcceptorID | Credentials | Required | Merchant ID |
TransactionAmount | Transaction | Required | Transaction amount |
ClerkNumber | Transaction | Optional | Clerk number |
ShiftID | Transaction | Optional | Shift ID |
ReferenceNumber | Transaction | Optional | Unique value assigned by the transaction sender |
TicketNumber | Transaction | Optional | Unique numeric value assigned by the transaction sender |
MarketCode | Transaction | Required | Market Code |
PartialApprovedFlag | Transaction | Required | Partial approval flag (Boolean) (Required for gift card support) |
TerminalID | Terminal | Required | Unique terminal identifier. For First Data/ValueLink, ensure TerminalID submitted matches First Data/ValueLink configuration. |
CardPresentCode | Terminal | Required | Card Present Code |
CardholderPresentCode | Terminal | Required | Cardholder Present Code |
CardInputCode | Terminal | Required | Card Input Code |
CVVPresenceCode | Terminal | Required | Card Verification Value Presence Code |
TerminalCapabilityCode | Terminal | Required | Terminal Capability Code |
TerminalEnvironmentCode | Terminal | Required | Terminal Environment Code |
MotoECICode | Terminal | Required | Mail Order Telephone Order Electronic Indicator Code |
TerminalEncryptionFormat | Terminal | Optional | Terminal encryption format from integrated encryption device |
TerminalSerialNumber | Terminal | Optional | Terminal serial number from integrated encryption device |
StoreCardID | Terminal | Required | StoreCard Unique Identifier |
StoreCardPassword | Terminal | Required | Password used to authenticate to StoreCard services. |
Track1Data | Card | Conditional 1 | Track 1 data |
Track2Data | Card | Conditional 1 | Track 2 data |
CardNumber | Card | Conditional 1 | Account number on card |
ExpirationMonth | Card | Conditional 1 | Expiration month |
ExpirationYear | Card | Conditional 1 | Expiration year |
CVV | Card | Conditional | Gift card verification value |
GiftCardSecurityCode | Card | Conditional | Gift card security code |
EncryptedTrack2Data | Card | Conditional 1 | Encrypted Track 2 Data from integrated encryption device |
EncryptedTrack1Data | Card | Conditional 1 | Encrypted Track 1 Data from integrated encryption device |
EncryptedCardData | Card | Conditional 1 | Encrypted Card Data (keyed) from integrated encryption device |
MagneprintData | Card | Conditional 1 | Encrypted Magneprint Data from integrated encryption device |
CardDataKeySerialNumber | Card | Conditional 1 | Card Data Key Serial Number from integrated encryption device |
EncryptedFormat | Card | Optional | Encryption format from integrated encryption device |
Footnote: 1 | Only one of the following field groups needs to be included: CardNumber / ExpirationMonth / ExpirationYear, Track2Data, Track1Data, EncryptedTrack2Data, EncryptedTrack1Data, EncryptedCardData or MagneprintData. | ||
Output Fields
Name | Class | Returned | Description |
ExpressResponseCode | Response | Returned | Express Response Code. |
ExpressResponseMessage | Response | Returned | Express Response Message. |
HostResponseCode | Response | Returned | Host Response Code. |
ExpressTransactionDate | Response | Returned | Express transaction date formatted [YYYYMMDD] |
ExpressTransactionTime | Response | Returned | Express transaction time formatted [HHMMSS] |
ExpressTransactionTimezone | Response | Returned | Express transaction UTC time zone |
CardLogo | Response.Card | Returned | Payment brand |
SecondaryCardNumber | Response.Card | Returned for ValueLink | Embossed card number |
TransactionID | Response.Transaction | Returned | Unique transaction identifier |
ApprovalNumber | Response.Transaction | Returned | Approval number assigned by issuer |
ReferenceNumber | Response.Transaction | Conditional Returns input value if supplied | Unique batch item identifier |
AcquirerData | Response.Transaction | Returned | The Acquirer Reference Data |
ProcessorName | Response.Transaction | Returned | Name of processor |
TransactionStatus | Response.Transaction | Returned | Description of status/state of transaction |
TransactionStatusCode | Response.Transaction | Returned | Status/State of transaction |
HostTransactionID | Response.Transaction | Returned | Host transaction identifier |
ApprovedAmount | Response.Transaction | Returned | Approved amount |
BalanceAmount | Response.Transaction | Returned | Gift card balance amount |
BalanceCurrencyCode | Response.Transaction | Returned | Gift card currency code |
GiftCardReload
Load additional funds on a gift card
Input Fields
Name | Class | Required | Description |
ApplicationID | Application | Required | Unique application identifier |
ApplicationName | Application | Required | Name of application |
ApplicationVersion | Application | Required | Version of application |
AccountID | Credentials | Required | Unique account identifier |
AccountToken | Credentials | Required | Token used for authentication |
AcceptorID | Credentials | Required | Merchant ID |
TransactionAmount | Transaction | Required | Transaction amount |
ClerkNumber | Transaction | Optional | Clerk number |
ShiftID | Transaction | Optional | Shift ID |
ReferenceNumber | Transaction | Optional | Unique value assigned by the transaction sender |
TicketNumber | Transaction | Optional | Unique numeric value assigned by the transaction sender |
MarketCode | Transaction | Required | Market Code |
PartialApprovedFlag | Transaction | Required | Partial approval flag (Boolean) (Required for gift card support) |
TerminalID | Terminal | Required | Unique terminal identifier. For First Data/ValueLink, ensure TerminalID submitted matches First Data/ValueLink configuration. |
CardPresentCode | Terminal | Required | Card Present Code |
CardholderPresentCode | Terminal | Required | Cardholder Present Code |
CardInputCode | Terminal | Required | Card Input Code |
CVVPresenceCode | Terminal | Required | Card Verification Value Presence Code |
TerminalCapabilityCode | Terminal | Required | Terminal Capability Code |
TerminalEnvironmentCode | Terminal | Required | Terminal Environment Code |
MotoECICode | Terminal | Required | Mail Order Telephone Order Electronic Indicator Code |
TerminalEncryptionFormat | Terminal | Optional | Terminal encryption format from integrated encryption device |
TerminalSerialNumber | Terminal | Optional | Terminal serial number from integrated encryption device |
StoreCardID | Terminal | Required | StoreCard Unique Identifier |
StoreCardPassword | Terminal | Required | Password used to authenticate to StoreCard services. |
Track1Data | Card | Conditional 1 | Track 1 data |
Track2Data | Card | Conditional 1 | Track 2 data |
CardNumber | Card | Conditional 1 | Account number on card |
ExpirationMonth | Card | Conditional 1 | Expiration month |
ExpirationYear | Card | Conditional 1 | Expiration year |
CVV | Card | Conditional | Gift card verification value |
GiftCardSecurityCode | Card | Conditional | Gift card security code |
EncryptedTrack2Data | Card | Conditional 1 | Encrypted Track 2 Data from integrated encryption device |
EncryptedTrack1Data | Card | Conditional 1 | Encrypted Track 1 Data from integrated encryption device |
EncryptedCardData | Card | Conditional 1 | Encrypted Card Data (keyed) from integrated encryption device |
MagneprintData | Card | Conditional 1 | Encrypted Magneprint Data from integrated encryption device |
CardDataKeySerialNumber | Card | Conditional 1 | Card Data Key Serial Number from integrated encryption device |
EncryptedFormat | Card | Optional | Encryption format from integrated encryption device |
Footnote: 1 | Only one of the following field groups needs to be included: CardNumber / ExpirationMonth / ExpirationYear, Track2Data, Track1Data, EncryptedTrack2Data, EncryptedTrack1Data, EncryptedCardData or MagneprintData. | ||
Output Fields
Name | Class | Returned | Description |
ExpressResponseCode | Response | Returned | Express Response Code. |
ExpressResponseMessage | Response | Returned | Express Response Message. |
HostResponseCode | Response | Returned | Host Response Code. |
ExpressTransactionDate | Response | Returned | Express transaction date formatted [YYYYMMDD] |
ExpressTransactionTime | Response | Returned | Express transaction time formatted [HHMMSS] |
ExpressTransactionTimezone | Response | Returned | Express transaction UTC time zone |
CardLogo | Response.Card | Returned | Payment brand |
SecondaryCardNumber | Response.Card | Returned for ValueLink | Embossed card number |
TransactionID | Response.Transaction | Returned | Unique transaction identifier |
ApprovalNumber | Response.Transaction | Returned | Approval number assigned by issuer |
ReferenceNumber | Response.Transaction | Conditional Returns input value if supplied | Unique batch item identifier |
AcquirerData | Response.Transaction | Returned | The Acquirer Reference Data |
ProcessorName | Response.Transaction | Returned | Name of processor |
TransactionStatus | Response.Transaction | Returned | Description of status/state of transaction |
TransactionStatusCode | Response.Transaction | Returned | Status/State of transaction |
HostTransactionID | Response.Transaction | Returned | Host transaction identifier |
ApprovedAmount | Response.Transaction | Returned | Approved amount |
BalanceAmount | Response.Transaction | Returned | Gift card balance amount |
BalanceCurrencyCode | Response.Transaction | Returned | Gift card currency code |
GiftCardReversal
Reverse a gift card transaction (System and Full Reversals)
Input Fields
Name | Class | Required | Description |
ApplicationID | Application | Required | Unique application identifier |
ApplicationName | Application | Required | Name of application |
ApplicationVersion | Application | Required | Version of application |
AccountID | Credentials | Required | Unique account identifier |
AccountToken | Credentials | Required | Token used for authentication |
AcceptorID | Credentials | Required | Merchant ID |
TransactionAmount | Transaction | Required | Transaction amount |
ClerkNumber | Transaction | Optional | Clerk number |
ShiftID | Transaction | Optional | Shift ID |
ReferenceNumber | Transaction | Optional | Unique value assigned by the transaction sender |
TicketNumber | Transaction | Optional | Unique numeric value assigned by the transaction sender |
MarketCode | Transaction | Required | Market Code |
ReversalType | Transaction | Required | Reversal type (0/System or 1/Full) |
TransactionID | Transaction | Conditional | Original TransactionID (Full Reversals only) |
PartialApprovedFlag | Transaction | Required | Partial approval flag (Boolean) (Required for gift card support) |
TerminalID | Terminal | Required | Unique terminal identifier. For First Data/ValueLink, ensure TerminalID submitted matches First Data/ValueLink configuration. |
CardPresentCode | Terminal | Required | Card Present Code |
CardholderPresentCode | Terminal | Required | Cardholder Present Code |
CardInputCode | Terminal | Required | Card Input Code |
CVVPresenceCode | Terminal | Required | Card Verification Value Presence Code |
TerminalCapabilityCode | Terminal | Required | Terminal Capability Code |
TerminalEnvironmentCode | Terminal | Required | Terminal Environment Code |
MotoECICode | Terminal | Required | Mail Order Telephone Order Electronic Indicator Code |
TerminalEncryptionFormat | Terminal | Optional | Terminal encryption format from integrated encryption device |
TerminalSerialNumber | Terminal | Optional | Terminal serial number from integrated encryption device |
StoreCardID | Terminal | Required | StoreCard Unique Identifier |
StoreCardPassword | Terminal | Required | Password used to authenticate to StoreCard services. |
Track1Data | Card | Conditional 1 | Track 1 data (System Reversals only) |
Track2Data | Card | Conditional 1 | Track 2 data (System Reversals only) |
CardNumber | Card | Conditional 1 | Account number on card (System Reversals only) |
ExpirationMonth | Card | Conditional 1 | Expiration month (System Reversals only) |
ExpirationYear | Card | Conditional 1 | Expiration year (System Reversals only) |
CVV | Card | Conditional | Gift card verification value |
GiftCardSecurityCode | Card | Conditional | Gift card security code |
EncryptedTrack2Data | Card | Conditional 1 | Encrypted Track 2 Data from integrated encryption device (System Reversals only) |
EncryptedTrack1Data | Card | Conditional 1 | Encrypted Track 1 Data from integrated encryption device (System Reversals only) |
EncryptedCardData | Card | Conditional 1 | Encrypted Card Data (keyed) from integrated encryption device (System Reversals only) |
MagneprintData | Card | Conditional 1 | Encrypted Magneprint Data from integrated encryption device (System Reversals only) |
CardDataKeySerialNumber | Card | Conditional 1 | Card Data Key Serial Number from integrated encryption device |
EncryptedFormat | Card | Optional | Encryption format from integrated encryption device |
Footnote: 1 | Only one of the following field groups needs to be included: CardNumber / ExpirationMonth / ExpirationYear, Track2Data, Track1Data, EncryptedTrack2Data, EncryptedTrack1Data, EncryptedCardData or MagneprintData. | ||
Output Fields
Name | Class | Returned | Description |
ExpressResponseCode | Response | Returned | Express Response Code. |
ExpressResponseMessage | Response | Returned | Express Response Message. |
HostResponseCode | Response | Returned | Host Response Code. |
ExpressTransactionDate | Response | Returned | Express transaction date formatted [YYYYMMDD] |
ExpressTransactionTime | Response | Returned | Express transaction time formatted [HHMMSS] |
ExpressTransactionTimezone | Response | Returned | Express transaction UTC time zone |
CardLogo | Response.Card | Returned | Payment brand |
SecondaryCardNumber | Response.Card | Returned for ValueLink | Embossed card number |
TransactionID | Response.Transaction | Returned | Unique transaction identifier |
ApprovalNumber | Response.Transaction | Returned | Approval number assigned by issuer |
ReferenceNumber | Response.Transaction | Conditional Returns input value if supplied | Unique batch item identifier |
AcquirerData | Response.Transaction | Returned | The Acquirer Reference Data |
ProcessorName | Response.Transaction | Returned | Name of processor |
TransactionStatus | Response.Transaction | Returned | Description of status/state of transaction |
TransactionStatusCode | Response.Transaction | Returned | Status/State of transaction |
HostTransactionID | Response.Transaction | Returned | Host transaction identifier |
ApprovedAmount | Response.Transaction | Returned | Approved amount |
BalanceAmount | Response.Transaction | Returned | Gift card balance amount |
BalanceCurrencyCode | Response.Transaction | Returned | Gift card currency code |
View Previous: Get Started with StoreCard On Express View Next: Express Gift Card Interface Specification v1.0.5