In-Person Payments

Incremental Auth - V2

Last updated: 11-Sep-2025
Download as PDF

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

Request Details Values
Method POST
URL https://{ENVIRONMENT}/oidc/poscloud/nexo/v2/payment
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 "PAYMENT"
MessageHeader.MessageType "REQUEST"
MessageHeader.ServiceID String
MessageHeader.SaleID String
MessageHeader.POIID String
PaymentRequest Object
PaymentRequest.SaleData Object
PaymentRequest.TransactionID String
PaymentRequest.TimeStamp String
PaymentRequest.PaymentTransaction Object
PaymentRequest.AmountsReq Object
PaymentRequest.Currency String 
{
    "MessageHeader": {
        "MessageClass": "SERVICE",
        "MessageCategory": "PAYMENT",
        "MessageType": "REQUEST",
        "ServiceID": "1234",
        "SaleID": "1992",
        "POIID": "GSC-B"
    },
    "PaymentRequest": {
        "SaleData": {
            "SaleTransactionID": {
                "TransactionID": "121212",
                "TimeStamp": "2020-04-20T14:43:59+05:30"
            },
            "SaleToPOIData": "{\"c\":\"673349\",\"m\":\"MC\",\"p\":\"CREDIT\",\"i\":\"12340\",\"r\":\"APPROVED\",\"rc\":\"5\",\"ts\":\"SUCCESS\"}"
        },
        "PaymentTransaction": {
            "AmountsReq": {
                "Currency": "SEK",
                "RequestedAmount": "20",
                "TipAmount": "0"
            }
        },
        "PaymentData": {
            "PaymentType": "UPDATERESERVATION"
        }
    }
}

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

{
    "MessageHeader": {
        "MessageClass": "SERVICE",
        "MessageCategory": "PAYMENT",
        "MessageType": "RESPONSE",
        "ServiceID": "1234",
        "SaleID": "1992",
        "POIID": "GSC-B"
    },
    "PaymentResponse": {
        "Response": {
            "Result": "SUCCESS",
            "ErrorCondition": null,
            "AdditionalResponse": null
        },
        "SaleData": {
            "OperatorID": null,
            "SaleTransactionID": {
                "TransactionID": "121212",
                "TimeStamp": "2020-04-20T14:43:59+05:30"
            },
            "TokenRequestedType": null,
            "SaleReferenceID": null,
            "VF_TokenizationParameters": null,
            "SaleTerminalData": null,
            "CustomerOrderReq": null,
            "SaleToPOIData": "{\"c\":\"673349\",\"m\":\"MC\",\"p\":\"CREDIT\",\"i\":\"12340\",\"r\":\"APPROVED\",\"rc\":\"5\",\"ts\":\"SUCCESS\"}",
            "SaleToAcquirerData": null,
            "VF_SaleNote": null,
            "VF_PartnerID": null,
            "VF_CustomerID": null,
            "VF_L2Data": null
        },
        "POIData": {
            "POITransactionID": {
                "TransactionID": "673349",
                "TimeStamp": "2025-08-22T05:10:06Z"
            },
            "POIReconciliationID": null
        },
        "PaymentResult": {
            "PaymentType": null,
            "PaymentInstrumentData": {
                "PaymentInstrumentType": "CARD",
                "PaymentAccountReference": null,
                "VF_Tokens": null,
                "ProtectedCardData": null,
                "CardData": {
                    "BankUserData": "MC",
                    "PaymentBrand": "MasterCard",
                    "MaskedPAN": "541333******0200",
                    "PaymentAccountRef": null,
                    "EntryMode": null,
                    "CardCountryCode": null,
                    "ProtectedCardData": null,
                    "SensitiveCardData": {
                        "PAN": "541333******0200",
                        "CardSeqNumb": null,
                        "ExpiryDate": null,
                        "TrackData": null
                    },
                    "AllowedProductCode": null,
                    "PaymentToken": {
                        "TokenRequestedType": "TRANSACTION",
                        "TokenValue": null,
                        "ExpiryDateTime": null
                    },
                    "VF_CardholderName": null,
                    "VF_EmvTags": null
                },
                "VF_FleetCard": {
                    "VF_DepartmentNum": null,
                    "VF_DriverNum": null,
                    "VF_EmployeeNum": null,
                    "VF_FleetData1": null,
                    "VF_FleetData2": null,
                    "VF_Hubometer": null,
                    "VF_JobNum": null,
                    "VF_MaintenanceId": null,
                    "VF_Odometer": null,
                    "VF_License": null,
                    "VF_PurchaseDataSeq": null,
                    "VF_ReferHours": null,
                    "VF_RefNum": null,
                    "VF_RestrictedProducts": null,
                    "VF_TrailerNum": null,
                    "VF_TripNum": null,
                    "VF_UnitNum": null,
                    "VF_UserId": null,
                    "VF_VehicleId": null
                },
                "VF_AccountType": "CREDIT",
                "CustomerToken": null,
                "_vf_AlternativePaymentData": null,
                "CheckData": {
                    "TrackData": null,
                    "BankID": null,
                    "AccountNumber": null,
                    "CheckNumber": null,
                    "CheckCardNumber": null,
                    "Country": null,
                    "TypeCode": null
                }
            },
            "AmountsResp": {
                "Currency": "SEK",
                "AuthorizedAmount": "20",
                "TotalRebatesAmount": null,
                "TotalFeesAmount": null,
                "CashBackAmount": "0",
                "TipAmount": "0",
                "VF_FsaAuthorizedAmount": "0.0",
                "VF_DiffAmountDue": "0.0",
                "VF_ReturnCheckFee": 0.0
            },
            "MerchantOverrideFlag": null,
            "CapturedSignature": {
                "RawSignature": null,
                "SignatureImage": {
                    "ImageFormat": null,
                    "ImageData": null,
                    "ImageReference": null
                }
            },
            "ProtectedSignature": null,
            "OnlineFlag": true,
            "AuthenticationMethod": [
                "NONE"
            ],
            "ValidityDate": null,
            "PaymentAcquirerData": {
                "AcquirerID": null,
                "MerchantID": "372417363887",
                "AcquirerPOIID": "1303027",
                "AcquirerTransactionID": {
                    "TransactionID": "659326",
                    "TimeStamp": "2025-08-22T05:10:06Z"
                },
                "ApprovalCode": "308677",
                "HostReconciliationID": null,
                "VF_AcquirerResponseCode": null,
                "VF_AcquirerResponseMessage": "Incremental Attempted "
            },
            "VF_PaymentHostData": {
                "ApprovalCode": null,
                "AcquirerTransactionID": {
                    "TransactionID": null,
                    "TimeStamp": null
                }
            }
        },
        "LoyaltyResult": {
            "VF_PromotionInfo": {
                "VF_FinType": null,
                "VF_VariableApr": false,
                "VF_VariableAprAfter": false,
                "VF_Apr": null,
                "VF_AprAfter": null,
                "VF_Duration": null,
                "VF_Description": null
            }
        },
        "PaymentReceipt": [
            {
                "DocumentQualifier": "SALERECEIPT",
                "IntegratedPrintFlag": null,
                "RequiredSignatureFlag": null,
                "OutputContent": {
                    "OutputFormat": "TEXT",
                    "PredefinedContent": null,
                    "OutputText": [
                        {
                            "Text": "         Pizza Hut Demo QA Lab          \n           Dedicated MID BAMS           \n          7100 Corporate Drive          \n            PLANO, TX 75024             \n\n08/22/25                        04:10:08\nClient ID: 13694600010001               \nMerchant ID: ********3887               \nTerm ID: 1303027                        \n\n               COMPLETION               \n\n************0200                 MC     \nAppr Code: 308677                       \nTransaction ID: 673349                  \nPayment Type: CREDIT                    \nInvoice: 12340                          \nResult:APPROVED                         \nNet ID:03                               \nNet Name:MASTERCARD                     \nApproved Amount:USD $20.00              \nRef: 000000000045                       \nResponse: APPROVAL - 000                \nApproved: Online                        \n\nAmount:            $          20.00     \n\nTotal:        USD  $          20.00     \n\n\nX_______________________________________\n\n               No Refunds               \n           Store Credit Only            \n             Merchant Copy              \n@#         Pizza Hut Demo QA Lab          \n           Dedicated MID BAMS           \n          7100 Corporate Drive          \n            PLANO, TX 75024             \n\n08/22/25                        04:10:10\nClient ID: 13694600010001               \nMerchant ID: ********3887               \nTerm ID: 1303027                        \n\n               COMPLETION               \n\n************0200                 MC     \nAppr Code: 308677                       \nTransaction ID: 673349                  \nPayment Type: CREDIT                    \nInvoice: 12340                          \nResult:APPROVED                         \nNet ID:03                               \nNet Name:MASTERCARD                     \nApproved Amount:USD $20.00              \nRef: 000000000045                       \nResponse: APPROVAL - 000                \nApproved: Online                        \n\nAmount:            $          20.00     \n\nTotal:        USD  $          20.00     \n               No Refunds               \n           Store Credit Only            \n             Customer 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\">         Pizza Hut Demo QA Lab          </div><div class=\"transactionLine\">           Dedicated MID BAMS           </div><div class=\"transactionLine\">          7100 Corporate Drive          </div><div class=\"transactionLine\">            PLANO, TX 75024             </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">08/22/25                        04:10:08</div><div class=\"transactionLine\">Client ID: 13694600010001               </div><div class=\"transactionLine\">Merchant ID: ********3887               </div><div class=\"transactionLine\">Term ID: 1303027                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">               COMPLETION               </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">************0200                 MC     </div><div class=\"transactionLine\">Appr Code: 308677                       </div><div class=\"transactionLine\">Transaction ID: 673349                  </div><div class=\"transactionLine\">Payment Type: CREDIT                    </div><div class=\"transactionLine\">Invoice: 12340                          </div><div class=\"transactionLine\">Result:APPROVED                         </div><div class=\"transactionLine\">Net ID:03                               </div><div class=\"transactionLine\">Net Name:MASTERCARD                     </div><div class=\"transactionLine\">Approved Amount:USD $20.00              </div><div class=\"transactionLine\">Ref: 000000000045                       </div><div class=\"transactionLine\">Response: APPROVAL - 000                </div><div class=\"transactionLine\">Approved: Online                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Amount:            $          20.00     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Total:        USD  $          20.00     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">X_______________________________________</div><div class=\"transactionLine\"></div><div class=\"transactionLine\">               No Refunds               </div><div class=\"transactionLine\">           Store Credit Only            </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>@#<!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\">         Pizza Hut Demo QA Lab          </div><div class=\"transactionLine\">           Dedicated MID BAMS           </div><div class=\"transactionLine\">          7100 Corporate Drive          </div><div class=\"transactionLine\">            PLANO, TX 75024             </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">08/22/25                        04:10:10</div><div class=\"transactionLine\">Client ID: 13694600010001               </div><div class=\"transactionLine\">Merchant ID: ********3887               </div><div class=\"transactionLine\">Term ID: 1303027                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">               COMPLETION               </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">************0200                 MC     </div><div class=\"transactionLine\">Appr Code: 308677                       </div><div class=\"transactionLine\">Transaction ID: 673349                  </div><div class=\"transactionLine\">Payment Type: CREDIT                    </div><div class=\"transactionLine\">Invoice: 12340                          </div><div class=\"transactionLine\">Result:APPROVED                         </div><div class=\"transactionLine\">Net ID:03                               </div><div class=\"transactionLine\">Net Name:MASTERCARD                     </div><div class=\"transactionLine\">Approved Amount:USD $20.00              </div><div class=\"transactionLine\">Ref: 000000000045                       </div><div class=\"transactionLine\">Response: APPROVAL - 000                </div><div class=\"transactionLine\">Approved: Online                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Amount:            $          20.00     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Total:        USD  $          20.00     </div><div class=\"transactionLine\">               No Refunds               </div><div class=\"transactionLine\">           Store Credit Only            </div><div class=\"transactionLine\">             Customer 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\">         Pizza Hut Demo QA Lab          </div><div class=\"transactionLine\">           Dedicated MID BAMS           </div><div class=\"transactionLine\">          7100 Corporate Drive          </div><div class=\"transactionLine\">            PLANO, TX 75024             </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">08/22/25                        04:10:08</div><div class=\"transactionLine\">Client ID: 13694600010001               </div><div class=\"transactionLine\">Merchant ID: ********3887               </div><div class=\"transactionLine\">Term ID: 1303027                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">               COMPLETION               </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">************0200                 MC     </div><div class=\"transactionLine\">Appr Code: 308677                       </div><div class=\"transactionLine\">Transaction ID: 673349                  </div><div class=\"transactionLine\">Payment Type: CREDIT                    </div><div class=\"transactionLine\">Invoice: 12340                          </div><div class=\"transactionLine\">Result:APPROVED                         </div><div class=\"transactionLine\">Net ID:03                               </div><div class=\"transactionLine\">Net Name:MASTERCARD                     </div><div class=\"transactionLine\">Approved Amount:USD $20.00              </div><div class=\"transactionLine\">Ref: 000000000045                       </div><div class=\"transactionLine\">Response: APPROVAL - 000                </div><div class=\"transactionLine\">Approved: Online                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Amount:            $          20.00     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Total:        USD  $          20.00     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\"></div><div class=\"transactionLine\">X_______________________________________</div><div class=\"transactionLine\"></div><div class=\"transactionLine\">               No Refunds               </div><div class=\"transactionLine\">           Store Credit Only            </div><div class=\"transactionLine\">             Merchant Copy              </div><div class=\"transactionLine\"></div></div>@#<div id=\"transactionInformation\"><div class=\"transactionLine\">         Pizza Hut Demo QA Lab          </div><div class=\"transactionLine\">           Dedicated MID BAMS           </div><div class=\"transactionLine\">          7100 Corporate Drive          </div><div class=\"transactionLine\">            PLANO, TX 75024             </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">08/22/25                        04:10:10</div><div class=\"transactionLine\">Client ID: 13694600010001               </div><div class=\"transactionLine\">Merchant ID: ********3887               </div><div class=\"transactionLine\">Term ID: 1303027                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">               COMPLETION               </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">************0200                 MC     </div><div class=\"transactionLine\">Appr Code: 308677                       </div><div class=\"transactionLine\">Transaction ID: 673349                  </div><div class=\"transactionLine\">Payment Type: CREDIT                    </div><div class=\"transactionLine\">Invoice: 12340                          </div><div class=\"transactionLine\">Result:APPROVED                         </div><div class=\"transactionLine\">Net ID:03                               </div><div class=\"transactionLine\">Net Name:MASTERCARD                     </div><div class=\"transactionLine\">Approved Amount:USD $20.00              </div><div class=\"transactionLine\">Ref: 000000000045                       </div><div class=\"transactionLine\">Response: APPROVAL - 000                </div><div class=\"transactionLine\">Approved: Online                        </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Amount:            $          20.00     </div><div class=\"transactionLine\"></div><div class=\"transactionLine\">Total:        USD  $          20.00     </div><div class=\"transactionLine\">               No Refunds               </div><div class=\"transactionLine\">           Store Credit Only            </div><div class=\"transactionLine\">             Customer Copy              </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