In-Person Payments

  This API is used to initiate a reversal of a transaction specifying the following details:

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

{
"MessageHeader": {
"poiid": "string",
"MessageClass": "SERVICE",
"MessageCategory": "REVERSAL",
"MessageType": "REQUEST",
"ServiceID": "23211",
"SaleID": "ReversalPOS",
"POIID": "275-051-429"
},
"ReversalRequest": {
"SaleData": {
"OperatorID": "string",
"SaleTransactionID": {
"TransactionID": "112263",
"TimeStamp": "2021-02-25T07:42:12.580Z"
},
"SaleReferenceID": "string",
"SaleTerminalData": {},
"CustomerOrderReq": null,
"SaleToPOIData":"{\"c\":\"198380\",\"m\":\"MC\",\"p\":\"CREDIT\",\"i\":\"100401\",\"r\":\"CAPTURED\",\"rc\":\"4\",\"ts\":\"SUCCESS\"}",
"SaleToAcquirerData": null
},
"OriginalPOITransaction": {
"poiid": "string",
"SaleID": "string",
"POIID": "string",
"POITransactionID": {
"TransactionID": "110431",
"TimeStamp": "2022-12-05T23:32:02Z"
}
},
"ReversalReason": "CUSTCANCEL",
"CustomerOrder": {
"CustomerOrderID": "string",
"StartDate": "2021-02-25T07:42:12.580Z",
"ForecastedAmount": "50.00",
"OpenOrderState": true,
"Currency": "USD",
"AdditionalInformation": "string"
}
}
}

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

{
    "MessageHeader": {
        "MessageClass": "SERVICE",
        "MessageCategory": "REVERSAL",
        "MessageType": "RESPONSE",
        "ServiceID": "23211",
        "SaleID": "ReversalPOS",
        "POIID": "275-051-429"
    },
    "ReversalResponse": {
        "Response": {
            "Result": "SUCCESS",
            "ErrorCondition": null,
            "AdditionalResponse": null
        },
        "OriginalPOITransaction": {
            "SaleID": null,
            "POIID": null,
            "POITransactionID": {
                "TransactionID": "198380",
                "TimeStamp": "2023-09-20T00:12:30Z"
            },
            "ApprovalCode": "OK7822"
        },
        "POIData": {
            "POITransactionID": {
                "TransactionID": "198380",
                "TimeStamp": "2023-09-20T00:12:30Z"
            },
            "POIReconciliationID": null
        },
        "ReversedAmount": "15.0",
        "CustomerOrder": {
            "CustomerOrderID": null,
            "StartDate": null,
            "ForecastedAmount": 15.0,
            "OpenOrderState": true,
            "Currency": null,
            "AdditionalInformation": null
        },
        "PaymentReceipt": [
            {
                "DocumentQualifier": "SALERECEIPT",
                "IntegratedPrintFlag": null,
                "RequiredSignatureFlag": null,
                "OutputContent": {
                    "OutputFormat": "TEXT",
                    "PredefinedContent": null,
                    "OutputText": [
                        {
                            "Text": "          BED BATH BEYOND 1997          \n                  1997                  \n            650 Liberty Ave             \n            UNION, NJ 07083             \n\n09/20/23                        04:42:30\nClient ID: 17345800010001               \nMerchant ID: ********3998               \nTerm ID: 1126076                        \n\n******************VOID******************\n\n************6566                        \nAppr Code: OK7822                       \nPayment Type: CREDIT                    \nResult:VOIDED                           \nInvoice: 100401                         \nResponse: APPROVAL - 000                \nApproved: Online                        \nTotal:           USD   $           15.00\n\n         NO SIGNATURE REQUIRED          \n             Merchant Copy              \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\">          BED BATH BEYOND 1997          </div><div class=\"transactionLine\">                  1997                  </div><div class=\"transactionLine\">            650 Liberty Ave             </div><div class=\"transactionLine\">            UNION, NJ 07083             </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">09/20/23                        04:42:30</div><div class=\"transactionLine\">Client ID: 17345800010001               </div><div class=\"transactionLine\">Merchant ID: ********3998               </div><div class=\"transactionLine\">Term ID: 1126076                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">******************VOID******************</div><div class=\"transactionLine\"></div><div class=\"transactionLine\">************6566                        </div><div class=\"transactionLine\">Appr Code: OK7822                       </div><div class=\"transactionLine\">Payment Type: CREDIT                    </div><div class=\"transactionLine\">Result:VOIDED                           </div><div class=\"transactionLine\">Invoice: 100401                         </div><div class=\"transactionLine\">Response: APPROVAL - 000                </div><div class=\"transactionLine\">Approved: Online                        </div><div class=\"transactionLine\">Total:           USD   $           15.00</div><div class=\"transactionLine\"></div><div class=\"transactionLine\">         NO SIGNATURE REQUIRED          </div><div class=\"transactionLine\">             Merchant Copy              </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\">          BED BATH BEYOND 1997          </div><div class=\"transactionLine\">                  1997                  </div><div class=\"transactionLine\">            650 Liberty Ave             </div><div class=\"transactionLine\">            UNION, NJ 07083             </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">09/20/23                        04:42:30</div><div class=\"transactionLine\">Client ID: 17345800010001               </div><div class=\"transactionLine\">Merchant ID: ********3998               </div><div class=\"transactionLine\">Term ID: 1126076                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">******************VOID******************</div><div class=\"transactionLine\"></div><div class=\"transactionLine\">************6566                        </div><div class=\"transactionLine\">Appr Code: OK7822                       </div><div class=\"transactionLine\">Payment Type: CREDIT                    </div><div class=\"transactionLine\">Result:VOIDED                           </div><div class=\"transactionLine\">Invoice: 100401                         </div><div class=\"transactionLine\">Response: APPROVAL - 000                </div><div class=\"transactionLine\">Approved: Online                        </div><div class=\"transactionLine\">Total:           USD   $           15.00</div><div class=\"transactionLine\"></div><div class=\"transactionLine\">         NO SIGNATURE REQUIRED          </div><div class=\"transactionLine\">             Merchant Copy              </div><div class=\"transactionLine\"></div></div>@#",
                    "OutputBarcode": null
                }
            }
        ]
    }
}