Activate or Load Gift Card

Overview

The activate and load command lets you activate a gift card and specify the amount to load onto it. When this command is used, it initiates the process of activating and funding the card based on the totalAmount provided in the request.

You can also use this command to activate fixed-amount gift cards. In that case, the card will be activated for a preset value, regardless of the totalAmount specified. If you would like to use fixed-amount gift cards then visit the Gift and Loyalty.

Activate Load Command

Request Structure

Element	Type	Description	Size	Required
apiVersion	String	API version number	V20	Required
istConfigCode	String	Moneris provided integration configuration code	V25	Required
dataId	String	Merchant defined unique identifier for the data object	V50	Required
dataTimestamp	String	Date and time of the request (YYYY-MM-DD HH:MM:SS)	F19	Required
data	Object	Object that contains all transaction requests	-	-
request	Array	Contains data applicable to transaction request	-	-
orderId	String	Order ID from Purchase	V50	Optional
idempotencyKey	String	Unique transaction identifier to avoid duplicate request	V50	Required
linkId	String	Id used to group related transactions	V50	Optional
terminalId	String	Destination Terminal ID	F8	Optional
userName	String	Unique identifier for clerk / user	V30	Optional
customIdData	String	Custom field	V50	Optional
action	String	"activate"	V50	Required
cardNumber	String	Track 2 details described in ISO 7813 or Manual Entry	V200	Optional
cvc	String	Card Verification Code	V10	Optional
totalAmount	String	Total transaction amount	V10	Required
progressStatus	String	If value is set to "True", terminal will return progress to POS Note: This feature is only available on Direct Integration	V5	Optional

Request example

{
   "apiVersion":"3.0",
   "istConfigCode":"example_istConfigCode",
   "dataId":"example_dataId",
   "dataTimestamp":"1969-12-31 23:59:59",
   "data":{
      "request":[
         {
            "orderId":"example_orderId",
            "idempotencyKey":"example_idempotencyKey",
            "totalAmount":"example_totalAmount",
            "action":"activate"
         }
      ]
   }
}

Element	Type	Description	Size	Required
apiVersion	String	API version number	V20	Required
apiToken	String	Moneris assigned identifier	V50	Optional
storeId	String	Store ID of requestor	V50	Required
istConfigCode	String	Moneris provided integration configuration code	V25	Required
postBackUrl	String	This field is required for postback and combined integration	V2000	Conditional
polling	String	This field is required for combined integration	V5	Conditional
dataId	String	Merchant defined unique identifier for the data object	V50	Required
dataTimestamp	String	Date and time of the request (YYYY-MM-DD HH:MM:SS)	F19	Required
data	Object	Object that contains all transaction requests	-	-
request	Array	Contains data applicable to transaction request	-	-
orderId	String	Order ID from Purchase	V50	Required
idempotencyKey	String	Unique transaction identifier to avoid duplicate request	V50	Required
linkId	String	Id used to group related transactions	V50	Optional
terminalId	String	Destination TerminalID	F8	Required
userName	String	Unique identifier for clerk / user	V30	Optional
customIdData	String	Custom field	V50	Optional
action	String	"activate"	V50	Required
cardNumber	String	Track 2 details described in ISO 7813 or Manual Entry	V200	Optional
cvc	String	Card Verification Code	V10	Optional
totalAmount	String	Total transaction amount	V9	Required

Request example

{
   "apiVersion":"3.0",
   "apiToken":"example_apiToken",
   "storeId":"example_storeId",
   "istConfigCode":"example_istConfigCode",
   "polling":"true",
   "postBackUrl":"https://example.client.url",
   "dataId":"example_dataId",
   "dataTimestamp":"1969-12-31 23:59:59",
   "data":{
      "request":[
         {
            "terminalId":"example_terminalId",
            "orderId":"example_orderId",
            "totalAmount":"example_totalAmount",
            "idempotencyKey":"example_idempotencyKey",
            "action":"activate"
         }
      ]
   }
}

Response Structure

Element	Type	Description	Size	Required
apiVersion	String	API version number	V20	Required
statusCode	String	Status code for the overall transaction request	V4	Required
status	String	Description of the statusCode	V4	Required
dataId	String	Merchant defined unique identifier for the data object	V50	Required
dataTimestamp	String	Date and time of the request (YYYY-MM-DD HH:MM:SS)	F19	Required
data	Object	Object that contains all transaction requests	-	-
response	Array	Contains data applicable to transaction request	-	-
orderId	String	A unique identifier for this request	V50	Required
transactionId	String	Unique identifier for this request	V50	Required
idempotencyKey	String	Unique transaction identifier to avoid duplicate request	V50	Required
linkId	String	Id used to group related transactions	V50	Optional
action	String	"activate"	V50	Required
statusCode	String	Status code for individual request	V4	Required
status	String	Description of the individual statusCode	V50	Required
balance	String	Balance in Account	V9	Conditional
loadedAmount	String	Loaded amount	V9	Conditional
tenderType	String	Payment Type: Credit, Debit, Gift etc	V50	Conditional
cardType	String	Card Type: V, M, P, AX etc	V2	Conditional
cardName	String	Card Name: Visa, MasterCard, Interac, Amex etc	V25	Conditional
cardStatus	String	-	V10	Conditional
responseCode	String	Moneris Host Response Code	V3	Conditional
iso	String	ISO response Code	V2	Conditional
authCode	String	Authorization code returned from the issuing institution.	V8	Conditional
maskedPan	String	Masked Primary Account Number (PAN)	V21	Conditional
completed	String	"true" or "false"	V5	Required
receipt	String	Financial receipt data sent using ISO-8895-1 encoding	V4000	Conditional
receiptChoice	String	The choices of how the receipt is being returned to the cardholder at the time of transaction. Valid values include: PRINT (Default Option), EMAIL, SMS, NONE.	V10	Conditional
terminalId	String	Destination Terminal ID	F8	Required
totalAmount	String	Echo of the Total transaction amount from the request	V9	Required

Response example

{
   "apiVersion":"3.0",
   "statusCode":"example_statusCode",
   "status":"example_status",
   "dataId":"example_dataId",
   "dataTimestamp":"1969-12-31 23:59:59",
   "data":{
      "response":[
         {
            "orderId":"example_orderId",
            "transactionId":"example_transactionId",
            "statusCode":"example_statusCode",
            "status":"example_status",
            "idempotencyKey":"example_idempotencyKey",
            "completed":"true",
            "responseCode":"example_responseCode",
            "iso":"example_iso",
            "loadedAmount":"example_approvedAmount",
            "totalAmount":"example_totalAmount",
            "tenderType":"example_tenderType",
            "cardType":"example_cardType",
            "sequenceNum":"example_sequenceNum",
            "realTimeUniqueId":"example_realTimeUniqueId",
            "authCode":"example_authCode",
            "maskedPan":"example_maskedPan",
            "action":"activate",
            "receipt":"example_receipt",
            "receiptChoice":"PRINT",
            "terminalId":"example_terminalId"
         }
      ]
   }
}

Element	Type	Description	Size	Required
receipt	Object	Contains the response data message	-	-
apiVersion	String	API version number	V20	Required
statusCode	String	Status code for the overall transaction request	V4	Required
status	String	Description of the statusCode	V4	Required
dataId	String	Merchant defined unique identifier for the data object	V50	Required
dataTimestamp	String	Date and time of the request (YYYY-MM-DD HH:MM:SS)	F19	Required
data	Object	Object that contains all transaction requests	-	-
response	Array	Contains data applicable to transaction request	-	-
orderId	String	Unique identifier for this request	V50	Required
transactionId	String	Unique identifier for this request	V50	Required
idempotencyKey	String	Unique transaction identifier to avoid duplicate request	V50	Required
linkId	String	Id used to group related transactions	V50	Optional
action	String	"activate"	V50	Required
statusCode	String	Status code for individual request	V4	Required
status	String	Description of the individual statusCode	V50	Required
balance	String	Balance in Account	V9	Conditional
loadedAmount	String	Loaded amount	V9	Conditional
tenderType	String	Payment Type: Credit, Debit, Gift etc	V50	Conditional
cardType	String	Card Type: V, M, P, AX etc	V2	Conditional
cardName	String	Card Name: Visa, MasterCard, Interac, Amex etc	V25	Conditional
cardStatus	String	-	V10	Conditional
realTimeUniqueId	String	Real Time Moneris Transaction Unique Identifier	F15	Conditional
responseCode	String	Moneris Host Response Code	V3	Conditional
iso	String	ISO response Code	V2	Conditional
authCode	String	Authorization code returned from the issuing institution.	V8	Conditional
formFactor	String	EMV Specific Data	F2	Conditional
maskedPan	String	Masked Primary Account Number (PAN)	V21	Conditional
completed	String	"true" or "false"	V5	Required
receipt	String	Financial receipt data sent using ISO-8895-1 encoding	V4000	Conditional
receiptChoice	String	The choices of how the receipt is being returned to the cardholder at the time of transaction. Valid values include: PRINT (Default Option), EMAIL, SMS, NONE.	V10	Conditional
terminalId	String	Destination Terminal ID	F8	Required
cloudTicket	String	This is the unique reference id of the cloud request	V100	Required
totalAmount	String	Echo of the Total transaction amount from the request	V9	Required

Response example

{
   "receipt":{
      "apiVersion":"3.0",
      "statusCode":"example_statusCode",
      "status":"example_status",
      "dataId":"example_dataId",
      "dataTimestamp":"1969-12-31 23:59:59",
      "data":{
         "response":[
            {
               "orderId":"example_orderId",
               "transactionId":"example_transactionId",
               "statusCode":"example_statusCode",
               "status":"example_status",
               "idempotencyKey":"example_idempotencyKey",
               "completed":"true",
               "responseCode":"example_responseCode",
               "iso":"example_iso",
               "approvedAmount":"example_approvedAmount",
               "tenderType":"example_tenderType",
               "cardType":"example_cardType",
               "sequenceNum":"example_sequenceNum",
               "realTimeUniqueId":"example_realTimeUniqueId",
               "authCode":"example_authCode",
               "formFactor":"example_formFactor",
               "maskedPan":"example_maskedPan",
               "action":"activate",
               "receipt":"example_receipt",
               "receiptChoice":"PRINT",
               "terminalId":"example_terminalId",
               "cloudTicket":"example_cloudTicket"
            }
         ]
      }
   }
}

Errors

If your response contains errors, visit the Errors page for a detailed description of each one.

Updated 3 days ago

Did this page help you?