Gift card transactions

Manage gift cards from beginning to end. Activate, redeem, and check the balance on gift cards, right from the payment terminal.

Supported transactions

Payment Terminal Application supports the following gift card transactions:

Redemption
Issuance
Activation
Balance Inquiry
Redemption Authorization
Redemption Completion
Void
Force Redemption
Force Issuance
Force Activation
Deactivation
Reactivation

Transaction request fields

The presence of each field in a gift card transaction request or response is mandatory, optional, conditional, or present:

Mandatory fields are required to be present.

Optional fields are not required and depend on the transaction context.

Conditional fields are required to support a specific feature or scenario.

Present fields are included by default in a response.

Gift card transaction type

Redemption

Use type GC_REDEMPTION to redeem a gift card payment.

Redemption transactions are always authorized online and, based on your configuration, support tips and partial redemptions.

Properties of a gift card redemption transaction
Item	Description
Operation name displayed on a terminal	Redemption
Operation name displayed on a receipt	REDEMPTION
Merchant is requested to supply the following data	Password, Invoice number, Table number, Clerk or Server, Gift card transaction reference, Cash out
Cardholder is requested to supply the following data	Card, tip, signature
ISO transaction message	1200
Can the operation be autoreversed?	Yes
Does the operation use data supplied by the Cardholder?	Yes
Merchant copy of the receipt?	Yes
Cardholder copy of the reciept?	Yes
Is the receipt stored as “last receipt”?	Yes
Can the receipt have a signature line?	Yes

Request fields

Request fields for redemption
Field	Description	Presence
operation	Contains the value `Transaction`	Mandatory
type	Defines the transaction type of the gift card request. Must contain `GC_REDEMPTION`	Mandatory
requestedAmount	The numeric amount for your request. No other characters are permitted. The amount value contains two implied decimal places. For example, the value 50000 represents $500.00 and the value 500 represents $5.00.	Mandatory
reference	A POS-generated reference number. If you do not provide a value, Payment Terminal Application generates this value internally. Maximum of 12 alphanumeric characters.	Optional
invoice	The invoice number associated with the transaction. Maximum of 6 numeric characters.	Optional
customer	The customer number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
ticket	The ticket number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
purchase	The purchase number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
order	The order number associated to the transaction. Maximum of 9 alphanumeric characters.	Optional
tipAmount	If you provide a tipAmount, Payment Terminal Application does not prompt for tip during the transaction flow.	Optional
duplicateCheck	If you send a value of 1, Payment Terminal Application checks the last performed transaction for a matching card number and amount. If the previous transaction matches, Payment Terminal Application returns as error. Valid values: 0 = ignore duplicates 1 = check duplicates	Optional
printReceipt	This field applies only to receipts printed by the payment terminal device or an attached printer. If you do not send this field, Payment Terminal Application does not print a receipt. Valid values: 0 = do not print receipt (default) 1 = print receipt (if supported)	Optional
cashOutInd	Indicates your request to cash out the remaining balance of the gift card. Valid values: 0 = do not request cash out. 1 = request cash out.	Optional
giftReference	This field is an additional optional reference number on gift card transactions. When present, giftReference is included in host messages and printed on receipts. Maximum of 15 alphanumeric characters.	Optional
paymentType	Provides information on the payment method used to support a gift card transaction. Valid values: 0 = cash 1 = credit card 2 = debit card 3 = complimentary	Optional

Issuance

Use type GC_ISSUANCE to issue or add value to a gift card.

Issuance operations are always performed online.

Properties of a gift card issuance transaction
Item	Description
Operation name displayed on a terminal	Issuance
Operation name displayed on a receipt	ISSUANCE / MULTIPLE ISSUANCE
Merchant is requested to supply the following data	Password, Clerk/Server, Gift card transaction reference.
Cardholder is requested to supply the following data	Card(s)
ISO transaction message	1200
Can the operation be autoreversed?	Yes
Does the operation use data supplied by the Cardholder?	Yes
Merchant copy of the receipt?	Yes
Cardholder copy of the reciept?	Yes
Is the receipt stored as “last receipt”?	Yes
Can the receipt have a signature line?	No

Request fields

Request fields for issuance
Field	Description	Presence
operation	Contains the value `Transaction`	Mandatory
type	Defines the transaction type of the gift card request. Must contain `GC_ISSUANCE`	Mandatory
requestedAmount	The numeric amount for your request. No other characters are permitted. The amount value contains two implied decimal places. For example, the value 50000 represents $500.00 and the value 500 represents $5.00.	Mandatory
reference	A POS-generated reference number. If you do not provide a value, Payment Terminal Application generates this value internally. Maximum of 12 alphanumeric characters.	Optional
invoice	The invoice number associated with the transaction. Maximum of 6 numeric characters.	Optional
customer	The customer number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
ticket	The ticket number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
purchase	The purchase number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
order	The order number associated to the transaction. Maximum of 9 alphanumeric characters.	Optional
printReceipt	This field applies only to receipts printed by the payment terminal device or an attached printer. If you do not send this field, Payment Terminal Application does not print a receipt. Valid values: 0 = do not print receipt (default) 1 = print receipt (if supported)	Optional
giftReference	This field is an additional optional reference number on gift card transactions. When present, giftReference is included in host messages and printed on receipts. Maximum of 15 alphanumeric characters.	Optional
paymentType	Provides information on the payment method used to support a gift card transaction. Valid values: 0 = cash 1 = credit card 2 = debit card 3 = complimentary	Optional

Activation

Use type GC_ACTIVATION to activate a new gift card.

Properties of a gift card activation transaction
Item	Description
Operation name displayed on a terminal	Activation
Operation name displayed on a receipt	ACTIVATION / MULTIPLE ACTIVATION
Merchant is requested to supply the following data	Password, Clerk/Server, Gift card transaction reference.
Cardholder is requested to supply the following data	Card(s)
ISO transaction message	1200
Can the operation be autoreversed?	Yes
Does the operation use data supplied by the Cardholder?	Yes
Merchant copy of the receipt?	Yes
Cardholder copy of the reciept?	Yes
Is the receipt stored as “last receipt”?	Yes
Can the receipt have a signature line?	No

Request fields

Request fields for activation
Field	Description	Presence
operation	Contains the value `Transaction`	Mandatory
type	Defines the transaction type of the gift card request. Must contain `GC_ACTIVATION`	Mandatory
requestedAmount	The numeric amount for your request. No other characters are permitted. The amount value contains two implied decimal places. For example, the value 50000 represents $500.00 and the value 500 represents $5.00.	Mandatory
reference	A POS-generated reference number. If you do not provide a value, Payment Terminal Application generates this value internally. Maximum of 12 alphanumeric characters.	Optional
invoice	The invoice number associated with the transaction. Maximum of 6 numeric characters.	Optional
customer	The customer number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
ticket	The ticket number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
purchase	The purchase number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
order	The order number associated to the transaction. Maximum of 9 alphanumeric characters.	Optional
printReceipt	This field applies only to receipts printed by the payment terminal device or an attached printer. If you do not send this field, Payment Terminal Application does not print a receipt. Valid values: 0 = do not print receipt (default) 1 = print receipt (if supported)	Optional
giftReference	This field is an additional optional reference number on gift card transactions. When present, giftReference is included in host messages and printed on receipts. Maximum of 15 alphanumeric characters.	Optional
paymentType	Provides information on the payment method used to support a gift card transaction. Valid values: 0 = cash 1 = credit card 2 = debit card 3 = complimentary	Optional

Balance Inquiry

Use type GC_BALANCE_INQUIRY to perform a balance inquiry and verify the remaining balance on a gift card.

Balance Inquiry transactions are always authorized online.

Properties of a gift card balance inquiry transaction
Item	Description
Operation name displayed on a terminal	Balance Inquiry
Operation name displayed on a receipt	BALANCE INQUIRY
Merchant is requested to supply the following data	Password, Clerk/Server.
Cardholder is requested to supply the following data	Card
ISO transaction message	1100
Can the operation be autoreversed?	No
Does the operation use data supplied by the Cardholder?	Yes
Merchant copy of the receipt?	No
Cardholder copy of the reciept?	Yes
Is the receipt stored as “last receipt”?	Yes
Can the receipt have a signature line?	No

Request fields

Request fields for balance inquiry
Field	Description	Presence
operation	Contains the value `Transaction`	Mandatory
type	Defines the transaction type of the gift card request. Must contain `GC_BALANCE_INQUIRY`	Mandatory
reference	A POS-generated reference number. If you do not provide a value, Payment Terminal Application generates this value internally. Maximum of 12 alphanumeric characters.	Optional
printReceipt	This field applies only to receipts printed by the payment terminal device or an attached printer. If you do not send this field, Payment Terminal Application does not print a receipt. Valid values: 0 = do not print receipt (default) 1 = print receipt (if supported)	Optional

Redemption Authorization

Use type GC_AUTHORIZATION to authorize and place an initial hold on a gift card.

Redemption Authorization transactions are always authorized online..

Properties of a gift card redemption authorization transaction
Item	Description
Operation name displayed on a terminal	Redemption Authorization
Operation name displayed on a receipt	REDEMPTION AUTHORIZATION
Merchant is requested to supply the following data	Password, Invoice Number, Clerk/Server, Gift card transaction reference.
Cardholder is requested to supply the following data	Card
ISO transaction message	1100
Can the operation be autoreversed?	Yes
Does the operation use data supplied by the Cardholder?	Yes
Merchant copy of the receipt?	Yes
Cardholder copy of the reciept?	Yes
Is the receipt stored as “last receipt”?	Yes
Can the receipt have a signature line?	No

Request fields

Request fields for redemption authorization
Field	Description	Presence
operation	Contains the value `Transaction`	Mandatory
type	Defines the transaction type of the gift card request. Must contain `GC_AUTHORIZATION`	Mandatory
requestedAmount	The numeric amount for your request. No other characters are permitted. The amount value contains two implied decimal places. For example, the value 50000 represents $500.00 and the value 500 represents $5.00.	Mandatory
reference	A POS-generated reference number. If you do not provide a value, Payment Terminal Application generates this value internally. Maximum of 12 alphanumeric characters.	Optional
invoice	The invoice number associated with the transaction. Maximum of 6 numeric characters.	Optional
customer	The customer number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
ticket	The ticket number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
purchase	The purchase number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
order	The order number associated to the transaction. Maximum of 9 alphanumeric characters.	Optional
duplicateCheck	If you send a value of 1, Payment Terminal Application checks the last performed transaction for a matching card number and amount. If the previous transaction matches, Payment Terminal Application returns as error. Valid values: 0 = ignore duplicates 1 = check duplicates	Optional
printReceipt	This field applies only to receipts printed by the payment terminal device or an attached printer. If you do not send this field, Payment Terminal Application does not print a receipt. Valid values: 0 = do not print receipt (default) 1 = print receipt (if supported)	Optional
paymentType	Provides information on the payment method used to support a gift card transaction. Valid values: 0 = cash 1 = credit card 2 = debit card 3 = complimentary	Optional

Redemption Completion

Use type GC_COMPLETION to complete an approved Redemption Authorization, capturing the full amount previously authorized. Redemption Completion transactions are always authorized online.

Properties of a gift card redemption completion transaction
Item	Description
Operation name displayed on a terminal	Redemption Completion
Operation name displayed on a receipt	REDEMPTION COMPLETION
Merchant is requested to supply the following data	Password, Invoice Number, Clerk/Server, Gift card transaction reference.
Cardholder is requested to supply the following data	Card
ISO transaction message	1200
Can the operation be autoreversed?	Yes
Does the operation use data supplied by the Cardholder?	Yes
Merchant copy of the receipt?	Yes
Cardholder copy of the reciept?	Yes
Is the receipt stored as “last receipt”?	Yes
Can the receipt have a signature line?	No

Request fields

Request fields for redemption completion
Field	Description	Presence
operation	Contains the value `Transaction`	Mandatory
type	Defines the transaction type of the gift card request. Must contain `GC_COMPLETION`	Mandatory
requestedAmount	The numeric amount for your request. No other characters are permitted. The amount value contains two implied decimal places. For example, the value 50000 represents $500.00 and the value 500 represents $5.00.	Mandatory
reference	A POS-generated reference number. If you do not provide a value, Payment Terminal Application generates this value internally. Maximum of 12 alphanumeric characters.	Optional
invoice	The invoice number associated with the transaction. Maximum of 6 numeric characters.	Optional
customer	The customer number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
ticket	The ticket number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
purchase	The purchase number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
order	The order number associated to the transaction. Maximum of 9 alphanumeric characters.	Optional
originalAuthCode	The authorization code returned in the original authorization. This field is alphanumeric.	Mandatory
duplicateCheck	If you send a value of 1, Payment Terminal Application checks the last performed transaction for a matching card number and amount. If the previous transaction matches, Payment Terminal Application returns as error. Valid values: 0 = ignore duplicates 1 = check duplicates	Optional
printReceipt	This field applies only to receipts printed by the payment terminal device or an attached printer. If you do not send this field, Payment Terminal Application does not print a receipt. Valid values: 0 = do not print receipt (default) 1 = print receipt (if supported)	Optional
paymentType	Provides information on the payment method used to support a gift card transaction. Valid values: 0 = cash 1 = credit card 2 = debit card 3 = complimentary	Optional

Void

Use type GC_VOID to void a previous gift card transaction.

Void transactions are always authorized online and the previous transaction must be in the open batch. Balance Inquiry, Void, Force Redemption, Force Issuance, and Force Activation transactions cannot be voided.

Voids cannot be processed if a subsequent transaction has been processed on the same gift card account.

Properties of a gift card void transaction
Item	Description
Operation name displayed on a terminal	Void
Operation name displayed on a receipt	VOID
Merchant is requested to supply the following data	Password, Clerk/Server.
Cardholder is requested to supply the following data	N/A
ISO transaction message	1400
Can the operation be autoreversed?	No
Does the operation use data supplied by the Cardholder?	Yes
Merchant copy of the receipt?	Yes
Cardholder copy of the reciept?	Yes
Is the receipt stored as “last receipt”?	Yes
Can the receipt have a signature line?	No

Request fields

Request fields for void
Field	Description	Presence
operation	Contains the value `Transaction`	Mandatory
type	Defines the transaction type of the gift card request. Must contain `GC_VOID`	Mandatory
reference	A POS-generated reference number. If you do not provide a value, Payment Terminal Application generates this value internally. Maximum of 12 alphanumeric characters.	Optional
invoice	The invoice number associated with the transaction. Maximum of 6 numeric characters.	Optional
customer	The customer number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
ticket	The ticket number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
purchase	The purchase number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
order	The order number associated to the transaction. Maximum of 9 alphanumeric characters.	Optional
originalAuthCode	The authorization code returned in the original authorization. This field is alphanumeric.	Mandatory
printReceipt	This field applies only to receipts printed by the payment terminal device or an attached printer. If you do not send this field, Payment Terminal Application does not print a receipt. Valid values: 0 = do not print receipt (default) 1 = print receipt (if supported)	Optional
paymentType	Provides information on the payment method used to support a gift card transaction. Valid values: 0 = cash 1 = credit card 2 = debit card 3 = complimentary	Optional

Force Redemption

Use type GC_FORCE_REDEMPTION to capture a gift card redemption transaction that has been authorized over the phone.

Force Redemption transactions are always authorized online and cannot be voided.

Properties of a gift card force redemption transaction
Item	Description
Operation name displayed on a terminal	Force Redemption
Operation name displayed on a receipt	FORCE REDEMPTION
Merchant is requested to supply the following data	Password, Invoice Number, Table Number, Clerk/Server, Gift card transaction reference, authorization code.
Cardholder is requested to supply the following data	Card.
ISO transaction message	1200
Can the operation be autoreversed?	Yes
Does the operation use data supplied by the Cardholder?	Yes
Merchant copy of the receipt?	Yes
Cardholder copy of the reciept?	Yes
Is the receipt stored as “last receipt”?	Yes
Can the receipt have a signature line?	No

Request fields

Request fields for force redemption
Field	Description	Presence
operation	Contains the value `Transaction`	Mandatory
type	Defines the transaction type of the gift card request. Must contain `GC_FORCE_REDEMPTION`	Mandatory
requestedAmount	The numeric amount for your request. No other characters are permitted. The amount value contains two implied decimal places. For example, the value 50000 represents $500.00 and the value 500 represents $5.00.	Mandatory
reference	A POS-generated reference number. If you do not provide a value, Payment Terminal Application generates this value internally. Maximum of 12 alphanumeric characters.	Optional
invoice	The invoice number associated with the transaction. Maximum of 6 numeric characters.	Optional
customer	The customer number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
ticket	The ticket number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
purchase	The purchase number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
order	The order number associated to the transaction. Maximum of 9 alphanumeric characters.	Optional
originalAuthCode	The authorization code returned in the original authorization. This field is alphanumeric.	Mandatory
duplicateCheck	If you send a value of 1, Payment Terminal Application checks the last performed transaction for a matching card number and amount. If the previous transaction matches, Payment Terminal Application returns as error. Valid values: 0 = ignore duplicates 1 = check duplicates	Optional
printReceipt	This field applies only to receipts printed by the payment terminal device or an attached printer. If you do not send this field, Payment Terminal Application does not print a receipt. Valid values: 0 = do not print receipt (default) 1 = print receipt (if supported)	Optional
paymentType	Provides information on the payment method used to support a gift card transaction. Valid values: 0 = cash 1 = credit card 2 = debit card 3 = complimentary	Optional

Force Issuance

Use type GC_FORCE_ISSUANCE to perform a gift card issuance transaction that has been authorized over the phone.

Force Issuance transactions are always authorized online and cannot be voided.

Properties of a gift card force issuance transaction
Item	Description
Operation name displayed on a terminal	Force Issuance
Operation name displayed on a receipt	FORCE ISSUANCE
Merchant is requested to supply the following data	Password, Clerk/Server, Gift card transaction reference, authorization code.
Cardholder is requested to supply the following data	Card
ISO transaction message	1200
Can the operation be autoreversed?	Yes
Does the operation use data supplied by the Cardholder?	Yes
Merchant copy of the receipt?	Yes
Cardholder copy of the reciept?	Yes
Is the receipt stored as “last receipt”?	Yes
Can the receipt have a signature line?	No

Request fields

Request fields for force issuance
Field	Description	Presence
operation	Contains the value `Transaction`	Mandatory
type	Defines the transaction type of the gift card request. Must contain `GC_FORCE_ISSUANCE`	Mandatory
requestedAmount	The numeric amount for your request. No other characters are permitted. The amount value contains two implied decimal places. For example, the value 50000 represents $500.00 and the value 500 represents $5.00.	Mandatory
reference	A POS-generated reference number. If you do not provide a value, Payment Terminal Application generates this value internally. Maximum of 12 alphanumeric characters.	Optional
invoice	The invoice number associated with the transaction. Maximum of 6 numeric characters.	Optional
customer	The customer number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
ticket	The ticket number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
purchase	The purchase number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
order	The order number associated to the transaction. Maximum of 9 alphanumeric characters.	Optional
originalAuthCode	The authorization code returned in the original authorization. This field is alphanumeric.	Mandatory
duplicateCheck	If you send a value of 1, Payment Terminal Application checks the last performed transaction for a matching card number and amount. If the previous transaction matches, Payment Terminal Application returns as error. Valid values: 0 = ignore duplicates 1 = check duplicates	Optional
printReceipt	This field applies only to receipts printed by the payment terminal device or an attached printer. If you do not send this field, Payment Terminal Application does not print a receipt. Valid values: 0 = do not print receipt (default) 1 = print receipt (if supported)	Optional
giftReference	This field is an additional optional reference number on gift card transactions. When present, giftReference is included in host messages and printed on receipts. Maximum of 15 alphanumeric characters.	Optional
paymentType	Provides information on the payment method used to support a gift card transaction. Valid values: 0 = cash 1 = credit card 2 = debit card 3 = complimentary	Optional

Force Activation

Use type GC_FORCE_ACTIVATION to activate a new gift card that has been authorized over the phone.

Force Activation transactions are always authorized online and cannot be voided.

Properties of a gift card force activation transaction
Item	Description
Operation name displayed on a terminal	Force Activation
Operation name displayed on a receipt	FORCE ACTIVATION
Merchant is requested to supply the following data	Password, Clerk/Server, Gift card transaction reference, authorization code.
Cardholder is requested to supply the following data	Card
ISO transaction message	1200
Can the operation be autoreversed?	Yes
Does the operation use data supplied by the Cardholder?	Yes
Merchant copy of the receipt?	Yes
Cardholder copy of the reciept?	Yes
Is the receipt stored as “last receipt”?	Yes
Can the receipt have a signature line?	No

Request fields

Request fields for force activation
Field	Description	Presence
operation	Contains the value `Transaction`	Mandatory
type	Defines the transaction type of the gift card request. Must contain `GC_FORCE_ACTIVATION`	Mandatory
requestedAmount	The numeric amount for your request. No other characters are permitted. The amount value contains two implied decimal places. For example, the value 50000 represents $500.00 and the value 500 represents $5.00.	Mandatory
reference	A POS-generated reference number. If you do not provide a value, Payment Terminal Application generates this value internally. Maximum of 12 alphanumeric characters.	Optional
invoice	The invoice number associated with the transaction. Maximum of 6 numeric characters.	Optional
customer	The customer number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
ticket	The ticket number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
purchase	The purchase number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
order	The order number associated to the transaction. Maximum of 9 alphanumeric characters.	Optional
originalAuthCode	The authorization code returned in the original authorization. This field is alphanumeric.	Mandatory
duplicateCheck	If you send a value of 1, Payment Terminal Application checks the last performed transaction for a matching card number and amount. If the previous transaction matches, Payment Terminal Application returns as error. Valid values: 0 = ignore duplicates 1 = check duplicates	Optional
printReceipt	This field applies only to receipts printed by the payment terminal device or an attached printer. If you do not send this field, Payment Terminal Application does not print a receipt. Valid values: 0 = do not print receipt (default) 1 = print receipt (if supported)	Optional
giftReference	This field is an additional optional reference number on gift card transactions. When present, giftReference is included in host messages and printed on receipts. Maximum of 15 alphanumeric characters.	Optional
paymentType	Provides information on the payment method used to support a gift card transaction. Valid values: 0 = cash 1 = credit card 2 = debit card 3 = complimentary	Optional

Deactivation

Use type GC_DEACTIVATION to deactivate a gift card and cash out the remaining balance.

Deactivation transactions are always authorized online.

Properties of a gift card deactivation transaction
Item	Description
Operation name displayed on a terminal	Deactivation
Operation name displayed on a receipt	DEACTIVATION
Merchant is requested to supply the following data	Password, Clerk/Server, Gift card transaction reference.
Cardholder is requested to supply the following data	Card
ISO transaction message	1200
Can the operation be autoreversed?	Yes
Does the operation use data supplied by the Cardholder?	Yes
Merchant copy of the receipt?	Yes
Cardholder copy of the reciept?	Yes
Is the receipt stored as “last receipt”?	Yes
Can the receipt have a signature line?	No

Request fields

Request fields for deactivation
Field	Description	Presence
operation	Contains the value `Transaction`	Mandatory
type	Defines the transaction type of the gift card request. Must contain `GC_DEACTIVATION`	Mandatory
reference	A POS-generated reference number. If you do not provide a value, Payment Terminal Application generates this value internally. Maximum of 12 alphanumeric characters.	Optional
invoice	The invoice number associated with the transaction. Maximum of 6 numeric characters.	Optional
customer	The customer number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
ticket	The ticket number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
purchase	The purchase number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
order	The order number associated to the transaction. Maximum of 9 alphanumeric characters.	Optional
printReceipt	This field applies only to receipts printed by the payment terminal device or an attached printer. If you do not send this field, Payment Terminal Application does not print a receipt. Valid values: 0 = do not print receipt (default) 1 = print receipt (if supported)	Optional
paymentType	Provides information on the payment method used to support a gift card transaction. Valid values: 0 = cash 1 = credit card 2 = debit card 3 = complimentary	Optional

Reactivation

Use type GC_REACTIVATION to reactivate a gift card that has been deactivated.

Reactivation transactions are always authorized online.

Properties of a gift card reactivation transaction
Item	Description
Operation name displayed on a terminal	Reactivation
Operation name displayed on a receipt	REACTIVATION
Merchant is requested to supply the following data	Password, Clerk/Server, Gift card transaction reference.
Cardholder is requested to supply the following data	Card
ISO transaction message	1200
Can the operation be autoreversed?	Yes
Does the operation use data supplied by the Cardholder?	Yes
Merchant copy of the receipt?	Yes
Cardholder copy of the reciept?	Yes
Is the receipt stored as “last receipt”?	Yes
Can the receipt have a signature line?	No

Request fields

Request fields for reactivation
Field	Description	Presence
operation	Contains the value `Transaction`	Mandatory
type	Defines the transaction type of the gift card request. Must contain `GC_REACTIVATION`	Mandatory
requestedAmount	The numeric amount for your request. No other characters are permitted. The amount value contains two implied decimal places. For example, the value 50000 represents $500.00 and the value 500 represents $5.00.	Mandatory
reference	A POS-generated reference number. If you do not provide a value, Payment Terminal Application generates this value internally. Maximum of 12 alphanumeric characters.	Optional
invoice	The invoice number associated with the transaction. Maximum of 6 numeric characters.	Optional
customer	The customer number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
ticket	The ticket number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
purchase	The purchase number associated with the transaction. Maximum of 8 alphanumeric characters.	Optional
order	The order number associated to the transaction. Maximum of 9 alphanumeric characters.	Optional
duplicateCheck	If you send a value of 1, Payment Terminal Application checks the last performed transaction for a matching card number and amount. If the previous transaction matches, Payment Terminal Application returns as error. Valid values: 0 = ignore duplicates 1 = check duplicates	Optional
printReceipt	This field applies only to receipts printed by the payment terminal device or an attached printer. If you do not send this field, Payment Terminal Application does not print a receipt. Valid values: 0 = do not print receipt (default) 1 = print receipt (if supported)	Optional
giftReference	This field is an additional optional reference number on gift card transactions. When present, giftReference is included in host messages and printed on receipts. Maximum of 15 alphanumeric characters.	Optional
paymentType	Provides information on the payment method used to support a gift card transaction. Valid values: 0 = cash 1 = credit card 2 = debit card 3 = complimentary	Optional

Gift card transaction response

Response fields

When unspecified, the presence of a field applies to all gift card transaction types.

Gift card response fields
Field	Description	Presence
processorLine1		Conditional
headerLine1		Present
headerLine2		Present
headerLine3		Present
headerLine4		Present
headerLine5		Present
headerLine6		Present
processorLine2		Conditional
terminalID	Terminal ID value configured for your merchant account.	Present
reference	Echo of the POS-generated reference number in the transaction request or, if you do not send a value, the reference number generated by Payment Terminal Application. Maximum of 12 alphanumeric characters.	Present
merchantID	Merchant ID value for your merchant account. Configure the value for this field in parameter BMERCID.	Present
storeID	Store identification.	Present
dateTime	Print the local date and time of the transaction on the receipt. The dateTime value has a custom format of [MM]-[DD]-[YYYY] [hh]:[mm]:[ss]. For example: `12-31-2024 13:59:59`	Present
invoice	Echo of the invoice number in the request. Maximum of 6 numeric characters.	Optional
customer	The customer number associated to the transaction. Maximum of 8 alphanumeric characters.	Optional
ticket	The ticket number associated to the transaction. Maximum of 8 alphanumeric characters.	Optional
purchase	The purchase number associated to the transaction. Maximum of 8 alphanumeric characters.	Optional
operation	Echo of the operation value Transaction	Present
transactionType	Transaction type in printable form. Valid values: `GIFT CARD REDEMPTION` `GIFT CARD ISSUANCE` `GIFT CARD ACTIVATION` `GIFT CARD BALANCE INQUIRY` `GIFT CARD ADD TIP` `GIFT CARD AUHTORIZATION` `GIFT CARD COMPLETION` `GIFT CARD VOID` `GIFT CARD FORCE REDEMPTION` `GIFT CARD FORCE ISSUANCE` `GIFT CARD FORCE ACTIVATION` `GIFT CARD DEACTIVATION` `GIFT CARD REACTIVATION`	Present
account	The account number masked according to PCI and card brand requirements.	Present
cardholderLanguage	The cardholder preferred language according to ISO 639. This field is an alphanumeric 2 character. Example: “en” for English language.	Optional for: Redemption Balance Inquiry Redemption Authorization Redemption Completion Force Redemption
entryMode	Indicates the interface used to capture the card data. Valid values: Manual Swiped Chip_Swiped Chip Contactless COF	Present
requestedAmount	Echo of the amount of the transaction in the request.	Present for: Redemption Issuance Activation Redemption Authorization Redemption Completion Force Redemption Force Issuance Force Activation Reactivation
tipAmount	The tip amount as entered during the transaction. This amount field has the same format as `requestedAmount`.	Optional for: Redemption
totalAmount	The sum of all the amounts in the transaction. This amount field has the same format as `requestedAmount`.	Present for: Redemption Issuance Activation Redemption Authorization Redemption Completion Force Redemption Force Issuance Force Activation Reactivation
dueAmount	If the transaction is partially authorized, this field contains the difference between the totalAmount and the amount approved by the issuer.	Optional for: Redemption
cashOutAmount	Contains the cashout amount returned by the payment host. This amount field has the same format as `requestedAmount`.	Optional for: Redemption
giftReference	Echo of giftReference from your request.	Optional for: Redemption Issuance Activation Force Issuance Force Activation Reactivation
paymentType	Echo of paymentType from your request.	Optional for: Redemption Issuance Activation Redemption Authorization Redemption Completion Void Force Redemption Force Issuance Force Activation Deactivation Reactivation
Cvd2Result	Indicates the verification result of the CVD2 value on a manually entered gift card.	Optional
currency	Contains the currency code expressed according to ISO 4217. Example “USD”.	Present
balance	Contains the account balance provided by the issuer (if available). This amount field has the same format as `requestedAmount`.	Optional
transactionID	Transaction ID number.	Optional
batchNumber	Indicates the current batch number. The number is locally initialized with 0 and is updated by our payment host responses.	Present
batchJulianDay	Indicates the Julian day associated to the batch as informed by the payment host.	Present
traceNumber	Contains the trace number returned by the host for EBT and debit transactions.	Optional
result	The result code from Payment Terminal Application. Refer to the table of result codes for defined values.	Present
approval	Whether the transaction is approved or declined. All errors and cancelations cause this field to contain declined. Use `result,` `responseCode`, or `hostMessage` to determine specific information about the cause of a decline.	Present
errorMessage	The display message from the host containing the description of the transaction decline. Applies to declined transactions.	Optional
hostError	The payment host numeric code for the decline. Only applies to declined transactions. Approved transactions contain 00000.	Optional
authCode	The authorization approval code returned from our payment host. This field only applies to approved transactions and is optional.	Optional
responseCode	The resposne code returned from our payment host. Only present when provided by our payment host.	Optional
cvm	Indicates the cardholder verification method. Present on approved transactions. Valid values: `NO CVM` `Signature` `PIN Verified` `PIN and Signature`	Present for: Redemption Issuance Activation Redemption Authorization Redemption Completion Void Force Redemption Force Issuance Force Activation Deactivation Reactivation
signatureRequired	Indicates if a signature is required. Present on approved transactions. Only present if the signature is required and not electronically captured at the payment terminal device. Valid values: `yes` `no`	Present for: Redemption Issuance Activation Redemption Authorization Redemption Completion Void Force Redemption Force Issuance Force Activation Deactivation Reactivation
footerLine1	Payment card transactions and gift card transactions use different footer lines. Refer to Receipt Parameters for additional information.	Present
footerLine2	Payment card transactions and gift card transactions use different footer lines. Refer to Receipt Parameters for additional information.	Present
footerLine3	Payment card transactions and gift card transactions use different footer lines. Refer to Receipt Parameters for additional information.	Present
demoMode	Indicates if the Payment Terminal Application is running in demo mode. Valid values: `yes` `no`	Present