In-Person Payments

Gift card - Activation - V2

Last updated: 18-Jan-2024
Download as PDF

This API is used to initiate storedValue requests specifying the following details:

Request Details Values
Method POST
URL https://{ENVIRONMENT}/oidc/poscloud/nexo/v2/storedValue
Authorization https://verifone.cloud/docs/in-store-payments/integration-set-terminal#step-3__003a__00a0setting-up-basic-auth-in-postman  

Headers:

     Content-Type

     x-terminal-simulator 

     x-site-entity-id   

     

     Authorization

 

application/json

true

Entity ID of child to be passed in case parent token is used while calling this API.

"user-uid:api" key pair encoded in base64. See the Obtaining API Keys guide for more information.
Body > Raw See the request example below.

Check the POS Cloud API reference for more details on the required parameters.

Required parameters Description
MessageHeader Object
MessageHeader.MessageClass "SERVICE"
MessageHeader.MessageCategory

"STOREDVALUE"
MessageHeader.MessageType "REQUEST"
MessageHeader.ServiceID String
MessageHeader.SaleID String
MessageHeader.POIID String
StoredValueRequest Object
StoredValueRequest.SaleData Object
StoredValueRequest.StoredValueData Array of objects
StoredValueRequest.StoredValueTransactionType String
StoredValueRequest.StoredValueAccountType String
StoredValueRequest.EntryMode String
StoredValueRequest.IdentificationType String
StoredValueRequest.StoredValueID String

 

{
"MessageHeader": {
"MessageClass": "SERVICE",
"MessageCategory": "STOREDVALUE",
"MessageType": "REQUEST",
"ServiceID": "1234",
"SaleID": "1992",
"POIID": "275-106-109"
},
"StoredValueRequest": {
"SaleData": {
"OperatorID": "string",
"SaleTransactionID": {
"TransactionID": "1234",
"TimeStamp": "2021-09-13T10:11:11.586Z"
},
"SaleReferenceID": "string",
"SaleTerminalData": {},
"CustomerOrderReq": null,
"SaleToPOIData": null,
"SaleToAcquirerData": null
},
"CustomerLanguage": "string",
"StoredValueData": [
{
"StoredValueProvider": "string",
"StoredValueTransactionType": "ACTIVATE",
"StoredValueAccountID": {
"StoredValueAccountType": "GIFTCARD",
"StoredValueProvider": "string",
"OwnerName": "string",
"ExpiryDate": "string",
"EntryMode": "RFID",
"IdentificationType": "PAN",
"StoredValueID": "string"
},
"OriginalPOITransaction": {
"poiid": "string",
"SaleID": "string",
"POIID": "string",
"POITransactionID": {
"TransactionID": "string",
"TimeStamp": "2021-09-13T10:11:11.586Z"
}
},
"ProductCode": "string",
"EanUpc": "string",
"ItemAmount": "11",
"Currency": "USD"
}
]
}
}

Based on the response from the terminal, the POS Cloud will send back the response:

{
    "MessageHeader": {
        "MessageClass": "SERVICE",
        "MessageCategory": "STOREDVALUE",
        "MessageType": "RESPONSE",
        "ServiceID": "1234",
        "SaleID": "1992",
        "POIID": "275-106-109"
    },
    "StoredValueResponse": {
        "Response": {
            "Result": "SUCCESS",
            "ErrorCondition": null,
            "AdditionalResponse": "Transaction Success"
        },
        "SaleData": {
            "OperatorID": null,
            "SaleTransactionID": {
                "TransactionID": "1234",
                "TimeStamp": "2021-09-13T10:11:11.586Z"
            },
            "TokenRequestedType": null,
            "SaleReferenceID": null,
            "SaleTerminalData": null,
            "CustomerOrderReq": null,
            "SaleToPOIData": null,
            "SaleToAcquirerData": null,
            "VF_SaleNote": null
        },
        "POIData": {
            "POITransactionID": {
                "TransactionID": "1234",
                "TimeStamp": "2021-09-13T10:11:11.586Z"
            },
            "POIReconciliationID": null
        },
        "StoredValueResult": [
            {
                "StoredValueTransactionType": "ACTIVATE",
                "ProductCode": "string",
                "ItemAmount": "11",
                "EanUpc": "string",
                "Currency": "USD",
                "StoredValueAccountStatus": {
                    "StoredValueAccountID": {
                        "StoredValueAccountType": "GIFTCARD",
                        "StoredValueProvider": null,
                        "OwnerName": null,
                        "ExpiryDate": "01/25",
                        "EntryMode": "MAGSTRIPE",
                        "IdentificationType": "PAN",
                        "StoredValueID": null
                    },
                    "CurrentBalance": "0.0"
                },
                "HostTransactionID": null,
                "VF_PaymentHostData": {
                    "ApprovalCode": "DEMO0003"
                }
            }
        ],
        "PaymentReceipt": [
            {
                "DocumentQualifier": "SALERECEIPT",
                "IntegratedPrintFlag": null,
                "RequiredSignatureFlag": null,
                "OutputContent": {
                    "OutputFormat": "TEXT",
                    "PredefinedContent": null,
                    "OutputText": [
                        {
                            "Text": "        Verifone Vantiv EMV Test        \n\n             123 ABC Street             \n          ALPHARETTA, GA 30022          \n\n\n09/16/23                        06:50:23\n\n\n                  DEMO                  \n\nClient ID: 14959200010001               \n\n\n               Activation               \n\n************3029                   GIFT \nEntry Method: Swipe                     \n\nAppr Code: DEMO0003                     \nTransaction ID: 1234                    \nPayment Type: GIFT                      \nCardholder: FIRSTDATA/TEST              \nInvoice: 1234                           \nResult:CAPTURED                         \nApproved Amount:USD $11.00              \nResponse: APPROVED                      \nApproved: Online                        \n\nTotal:           USD  $           11.00 \n\n\n\n\n\n             Merchant Copy              \n\n\n\n@#        Verifone Vantiv EMV Test        \n\n             123 ABC Street             \n          ALPHARETTA, GA 30022          \n\n\n09/16/23                        06:50:23\n\n\n                  DEMO                  \n\nClient ID: 14959200010001               \n\n\n               Activation               \n\n************3029                   GIFT \nEntry Method: Swipe                     \n\nAppr Code: DEMO0003                     \nTransaction ID: 1234                    \nPayment Type: GIFT                      \nCardholder: FIRSTDATA/TEST              \nInvoice: 1234                           \nResult:CAPTURED                         \nApproved Amount:USD $11.00              \nResponse: APPROVED                      \nApproved: Online                        \n\nTotal:           USD  $           11.00 \n\n\n\n\n\n\n\n             Customer Copy              \n\n\n\n",
                            "CharacterSet": null,
                            "Font": null,
                            "StartRow": null,
                            "StartColumn": null,
                            "Color": null,
                            "CharacterWidth": null,
                            "CharacterHeight": null,
                            "CharacterStyle": null,
                            "Alignment": null,
                            "EndOfLineFlag": null
                        }
                    ],
                    "OutputXHTML": null,
                    "OutputBarcode": null
                }
            },
            {
                "DocumentQualifier": "SALERECEIPT",
                "IntegratedPrintFlag": null,
                "RequiredSignatureFlag": null,
                "OutputContent": {
                    "OutputFormat": "XHTML",
                    "PredefinedContent": null,
                    "OutputText": null,
                    "OutputXHTML": "<!DOCTYPE html><html><head><title>Receipt</title><style>body { background-color: white; }div { display: block; }</style></head>\n<body>\n<!-- Version 1 -->\n<!-- Business information start --><!-- Empty -->\n<!-- Business information end -->\n<!-- Before greeting start --><!-- Empty -->\n<!-- Before greeting end -->\n<!-- Greeting start --><!-- Empty -->\n<!-- Greeting end -->\n<!-- After greeting start --><!-- Empty -->\n<!-- After greeting end -->\n<!-- Cashier name start --><!-- Empty -->\n<!-- Cashier name end -->\n<!-- Before transaction start --><!-- Empty -->\n<!-- Before transaction end -->\n<!-- Transaction information start --><div id=\"transactionInformation\"><div class=\"transactionLine\">        Verifone Vantiv EMV Test        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">             123 ABC Street             </div><div class=\"transactionLine\">          ALPHARETTA, GA 30022          </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">09/16/23                        06:50:23</div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">                  DEMO                  </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Client ID: 14959200010001               </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">               Activation               </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">************3029                   GIFT </div><div class=\"transactionLine\">Entry Method: Swipe                     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Appr Code: DEMO0003                     </div><div class=\"transactionLine\">Transaction ID: 1234                    </div><div class=\"transactionLine\">Payment Type: GIFT                      </div><div class=\"transactionLine\">Cardholder: FIRSTDATA/TEST              </div><div class=\"transactionLine\">Invoice: 1234                           </div><div class=\"transactionLine\">Result:CAPTURED                         </div><div class=\"transactionLine\">Approved Amount:USD $11.00              </div><div class=\"transactionLine\">Response: APPROVED                      </div><div class=\"transactionLine\">Approved: Online                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Total:           USD  $           11.00 </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">             Merchant Copy              </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div></div><!-- Transaction information end -->\n<!-- After transaction start --><!-- Empty -->\n<!-- After transaction end -->\n<!-- Online URL start --><!-- Empty -->\n<!-- Online URL end -->\n<!-- Before custom footer start --><!-- Empty -->\n<!-- Before custom footer end -->\n<!-- Custom footer start --><!-- Empty -->\n<!-- Custom footer end -->\n<!-- After custom footer start --><!-- Empty -->\n<!-- After custom footer end -->\n<!-- Footer start --><!-- Empty -->\n<!-- Footer end -->\n</body>\n</html>@#<!DOCTYPE html><html><head><title>Receipt</title><style>body { background-color: white; }div { display: block; }</style></head>\n<body>\n<!-- Version 1 -->\n<!-- Business information start --><!-- Empty -->\n<!-- Business information end -->\n<!-- Before greeting start --><!-- Empty -->\n<!-- Before greeting end -->\n<!-- Greeting start --><!-- Empty -->\n<!-- Greeting end -->\n<!-- After greeting start --><!-- Empty -->\n<!-- After greeting end -->\n<!-- Cashier name start --><!-- Empty -->\n<!-- Cashier name end -->\n<!-- Before transaction start --><!-- Empty -->\n<!-- Before transaction end -->\n<!-- Transaction information start --><div id=\"transactionInformation\"><div class=\"transactionLine\">        Verifone Vantiv EMV Test        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">             123 ABC Street             </div><div class=\"transactionLine\">          ALPHARETTA, GA 30022          </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">09/16/23                        06:50:23</div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">                  DEMO                  </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Client ID: 14959200010001               </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">               Activation               </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">************3029                   GIFT </div><div class=\"transactionLine\">Entry Method: Swipe                     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Appr Code: DEMO0003                     </div><div class=\"transactionLine\">Transaction ID: 1234                    </div><div class=\"transactionLine\">Payment Type: GIFT                      </div><div class=\"transactionLine\">Cardholder: FIRSTDATA/TEST              </div><div class=\"transactionLine\">Invoice: 1234                           </div><div class=\"transactionLine\">Result:CAPTURED                         </div><div class=\"transactionLine\">Approved Amount:USD $11.00              </div><div class=\"transactionLine\">Response: APPROVED                      </div><div class=\"transactionLine\">Approved: Online                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Total:           USD  $           11.00 </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">             Customer Copy              </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div></div><!-- Transaction information end -->\n<!-- After transaction start --><!-- Empty -->\n<!-- After transaction end -->\n<!-- Online URL start --><!-- Empty -->\n<!-- Online URL end -->\n<!-- Before custom footer start --><!-- Empty -->\n<!-- Before custom footer end -->\n<!-- Custom footer start --><!-- Empty -->\n<!-- Custom footer end -->\n<!-- After custom footer start --><!-- Empty -->\n<!-- After custom footer end -->\n<!-- Footer start --><!-- Empty -->\n<!-- Footer end -->\n</body>\n</html>",
                    "OutputBarcode": null
                }
            },
            {
                "DocumentQualifier": "SALERECEIPT",
                "IntegratedPrintFlag": null,
                "RequiredSignatureFlag": null,
                "OutputContent": {
                    "OutputFormat": "XHTML",
                    "PredefinedContent": null,
                    "OutputText": null,
                    "OutputXHTML": "<div id=\"transactionInformation\"><div class=\"transactionLine\">        Verifone Vantiv EMV Test        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">             123 ABC Street             </div><div class=\"transactionLine\">          ALPHARETTA, GA 30022          </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">09/16/23                        06:50:23</div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">                  DEMO                  </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Client ID: 14959200010001               </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">               Activation               </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">************3029                   GIFT </div><div class=\"transactionLine\">Entry Method: Swipe                     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Appr Code: DEMO0003                     </div><div class=\"transactionLine\">Transaction ID: 1234                    </div><div class=\"transactionLine\">Payment Type: GIFT                      </div><div class=\"transactionLine\">Cardholder: FIRSTDATA/TEST              </div><div class=\"transactionLine\">Invoice: 1234                           </div><div class=\"transactionLine\">Result:CAPTURED                         </div><div class=\"transactionLine\">Approved Amount:USD $11.00              </div><div class=\"transactionLine\">Response: APPROVED                      </div><div class=\"transactionLine\">Approved: Online                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Total:           USD  $           11.00 </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">             Merchant Copy              </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div></div>@#<div id=\"transactionInformation\"><div class=\"transactionLine\">        Verifone Vantiv EMV Test        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">             123 ABC Street             </div><div class=\"transactionLine\">          ALPHARETTA, GA 30022          </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">09/16/23                        06:50:23</div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">                  DEMO                  </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Client ID: 14959200010001               </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">               Activation               </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">************3029                   GIFT </div><div class=\"transactionLine\">Entry Method: Swipe                     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Appr Code: DEMO0003                     </div><div class=\"transactionLine\">Transaction ID: 1234                    </div><div class=\"transactionLine\">Payment Type: GIFT                      </div><div class=\"transactionLine\">Cardholder: FIRSTDATA/TEST              </div><div class=\"transactionLine\">Invoice: 1234                           </div><div class=\"transactionLine\">Result:CAPTURED                         </div><div class=\"transactionLine\">Approved Amount:USD $11.00              </div><div class=\"transactionLine\">Response: APPROVED                      </div><div class=\"transactionLine\">Approved: Online                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Total:           USD  $           11.00 </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">             Customer Copy              </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div></div>",
                    "OutputBarcode": null
                }
            }
        ]
    }
}
Rate this article:

Need help?

Do you have a question? If you didn’t find the answer you are looking for in our documentation, you can contact our Support teams for more information. If you have a technical issue or question, please contact us. We are happy to help.

Get in touch

Not yet a Verifone customer?

We’ll help you choose the right payment solution for your business, wherever you want to sell, in-person or online. Our team of experts will happily discuss your needs.

Contact sales Get Started
Verifone logo