In-Person Payments

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

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

{
"MessageHeader": {
"MessageClass": "SERVICE",
"MessageCategory": "BALANCEINQUIRY",
"MessageType": "REQUEST",
"ServiceID": "1234",
"SaleID": "1992",
"POIID": "275-106-109"
},
"BalanceInquiryRequest": {
    "PaymentAccountReq": {
            "AccountType": "EBT"
        }
}
}

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

{
    "MessageHeader": {
        "MessageClass": "SERVICE",
        "MessageCategory": "BALANCEINQUIRY",
        "MessageType": "RESPONSE",
        "ServiceID": "1234",
        "SaleID": "1992",
        "POIID": "275-106-109"
    },
    "BalanceInquiryResponse": {
        "Response": {
            "Result": "SUCCESS",
            "ErrorCondition": null,
            "AdditionalResponse": "Transaction Success"
        },
        "PaymentAccountStatus": {
            "PaymentInstrumentData": {
                "PaymentInstrumentType": null,
                "CardData": {
                    "PaymentBrand": "EBT",
                    "MaskedPAN": null,
                    "PaymentAccountRef": null,
                    "EntryMode": "MAGSTRIPE",
                    "CardCountryCode": null,
                    "ProtectedCardData": null,
                    "SensitiveCardData": {
                        "PAN": "999999******0005",
                        "CardSeqNumb": null,
                        "ExpiryDate": "12/25",
                        "TrackData": null
                    },
                    "AllowedProduct": null
                },
                "MobileData": null,
                "StoredValueAccountID": null
            },
            "Currency": null,
            "CurrentBalance": "0.0",
            "PaymentAcquirerData": {
                "AcquirerID": null,
                "MerchantID": null,
                "AcquirerPOIID": null,
                "AcquirerTransactionID": null,
                "ApprovalCode": "DEMO0003"
            },
            "VF_FsAvailableBalance": "400.0",
            "VF_CbAvailableBalance": "600.0"
        },
        "LoyaltyAccountStatus": null,
        "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:56:04\n\n\n                  DEMO                  \n\nClient ID: 14959200010001               \n\n\n                BALANCE                 \n\nFood Stamps                     EBT     \n************0005                        \nEntry Method: Swipe                     \n\n\nAppr Code: DEMO0003                     \nTransaction ID: ej4q9i                  \nPayment Type: EBT                       \nResult:CAPTURED                         \nApproved Amount:USD $0.00               \nInvoice: ej4q9i                         \nResponse: APPROVED                      \nApproved: Online                        \n\n\nAvail Balance:     $           5.00     \n\n        Available Balance:              \nFood Stamps        $         400.00     \nCash Benefit       $         600.00     \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:56:04\n\n\n                  DEMO                  \n\nClient ID: 14959200010001               \n\n\n                BALANCE                 \n\nFood Stamps                     EBT     \n************0005                        \nEntry Method: Swipe                     \n\n\nAppr Code: DEMO0003                     \nTransaction ID: ej4q9i                  \nPayment Type: EBT                       \nResult:CAPTURED                         \nApproved Amount:USD $0.00               \nInvoice: ej4q9i                         \nResponse: APPROVED                      \nApproved: Online                        \n\n\nAvail Balance:     $           5.00     \n\n        Available Balance:              \nFood Stamps        $         400.00     \nCash Benefit       $         600.00     \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:56:04</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\">                BALANCE                 </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Food Stamps                     EBT     </div><div class=\"transactionLine\">************0005                        </div><div class=\"transactionLine\">Entry Method: Swipe                     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Appr Code: DEMO0003                     </div><div class=\"transactionLine\">Transaction ID: ej4q9i                  </div><div class=\"transactionLine\">Payment Type: EBT                       </div><div class=\"transactionLine\">Result:CAPTURED                         </div><div class=\"transactionLine\">Approved Amount:USD $0.00               </div><div class=\"transactionLine\">Invoice: ej4q9i                         </div><div class=\"transactionLine\">Response: APPROVED                      </div><div class=\"transactionLine\">Approved: Online                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Avail Balance:     $           5.00     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">        Available Balance:              </div><div class=\"transactionLine\">Food Stamps        $         400.00     </div><div class=\"transactionLine\">Cash Benefit       $         600.00     </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:56:04</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\">                BALANCE                 </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Food Stamps                     EBT     </div><div class=\"transactionLine\">************0005                        </div><div class=\"transactionLine\">Entry Method: Swipe                     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Appr Code: DEMO0003                     </div><div class=\"transactionLine\">Transaction ID: ej4q9i                  </div><div class=\"transactionLine\">Payment Type: EBT                       </div><div class=\"transactionLine\">Result:CAPTURED                         </div><div class=\"transactionLine\">Approved Amount:USD $0.00               </div><div class=\"transactionLine\">Invoice: ej4q9i                         </div><div class=\"transactionLine\">Response: APPROVED                      </div><div class=\"transactionLine\">Approved: Online                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Avail Balance:     $           5.00     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">        Available Balance:              </div><div class=\"transactionLine\">Food Stamps        $         400.00     </div><div class=\"transactionLine\">Cash Benefit       $         600.00     </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:56:04</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\">                BALANCE                 </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Food Stamps                     EBT     </div><div class=\"transactionLine\">************0005                        </div><div class=\"transactionLine\">Entry Method: Swipe                     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Appr Code: DEMO0003                     </div><div class=\"transactionLine\">Transaction ID: ej4q9i                  </div><div class=\"transactionLine\">Payment Type: EBT                       </div><div class=\"transactionLine\">Result:CAPTURED                         </div><div class=\"transactionLine\">Approved Amount:USD $0.00               </div><div class=\"transactionLine\">Invoice: ej4q9i                         </div><div class=\"transactionLine\">Response: APPROVED                      </div><div class=\"transactionLine\">Approved: Online                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Avail Balance:     $           5.00     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">        Available Balance:              </div><div class=\"transactionLine\">Food Stamps        $         400.00     </div><div class=\"transactionLine\">Cash Benefit       $         600.00     </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:56:04</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\">                BALANCE                 </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Food Stamps                     EBT     </div><div class=\"transactionLine\">************0005                        </div><div class=\"transactionLine\">Entry Method: Swipe                     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Appr Code: DEMO0003                     </div><div class=\"transactionLine\">Transaction ID: ej4q9i                  </div><div class=\"transactionLine\">Payment Type: EBT                       </div><div class=\"transactionLine\">Result:CAPTURED                         </div><div class=\"transactionLine\">Approved Amount:USD $0.00               </div><div class=\"transactionLine\">Invoice: ej4q9i                         </div><div class=\"transactionLine\">Response: APPROVED                      </div><div class=\"transactionLine\">Approved: Online                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Avail Balance:     $           5.00     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">        Available Balance:              </div><div class=\"transactionLine\">Food Stamps        $         400.00     </div><div class=\"transactionLine\">Cash Benefit       $         600.00     </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
                }
            }
        ]
    }
}