Pre-Auth Completion Transaction - V2
Last updated: 22-Jan-2024
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 |
|
| 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": "1234",
"POIID": "P400 459"
},
"PaymentRequest": {
"SaleData": {
"SaleTransactionID": {
"TransactionID": "112233",
"TimeStamp": "2020-04-20T14:43:59+05:30"
},
"SaleToPOIData": "{\"c\":\"150791\",\"m\":\"MC\",\"p\":\"CREDIT\",\"r\":\"APPROVED\",\"rc\":\"5\",\"ts\":\"SUCCESS\"}"
},
"PaymentTransaction": {
"AmountsReq": {
"Currency": "USD",
"RequestedAmount": "14",
"TipAmount": "0"
}
},
"PaymentData": {
"PaymentType": "COMPLETION"
}
}
}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": "1234",
"POIID": "P400 459"
},
"PaymentResponse": {
"Response": {
"Result": "SUCCESS",
"ErrorCondition": null,
"AdditionalResponse": null
},
"SaleData": {
"OperatorID": null,
"SaleTransactionID": {
"TransactionID": "112233",
"TimeStamp": "2020-04-20T14:43:59+05:30"
},
"TokenRequestedType": null,
"SaleReferenceID": null,
"SaleTerminalData": null,
"CustomerOrderReq": null,
"SaleToPOIData": "{\"c\":\"150791\",\"m\":\"MC\",\"p\":\"CREDIT\",\"i\":\"112233\",\"r\":\"CAPTURED\",\"rc\":\"4\",\"ts\":\"SUCCESS\"}",
"SaleToAcquirerData": null,
"VF_SaleNote": null
},
"POIData": {
"POITransactionID": {
"TransactionID": "150791",
"TimeStamp": "2023-06-23T06:23:00Z"
},
"POIReconciliationID": null
},
"PaymentResult": {
"PaymentType": null,
"PaymentInstrumentData": {
"PaymentInstrumentType": "CARD",
"ProtectedCardData": null,
"CardData": {
"BankUserData": "MC",
"PaymentBrand": "MasterCard",
"MaskedPAN": "541333******4111",
"PaymentAccountRef": null,
"EntryMode": null,
"CardCountryCode": null,
"ProtectedCardData": null,
"SensitiveCardData": {
"PAN": "541333******4111",
"CardSeqNumb": null,
"ExpiryDate": null,
"TrackData": null
},
"AllowedProductCode": null,
"PaymentToken": {
"TokenRequestedType": "TRANSACTION",
"TokenValue": null,
"ExpiryDateTime": null
},
"VF_CardholderName": null,
"VF_EmvTags": null
},
"VF_AccountType": "CREDIT",
"CustomerToken": null,
"_vf_AlternativePaymentData": null
},
"AmountsResp": {
"Currency": "USD",
"AuthorizedAmount": "14",
"TotalRebatesAmount": null,
"TotalFeesAmount": null,
"CashBackAmount": "0",
"TipAmount": "0",
"VF_FsaAuthorizedAmount": "0.0",
"VF_DiffAmountDue": "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": "005059233998",
"AcquirerPOIID": "1126076",
"AcquirerTransactionID": {
"TransactionID": "856955",
"TimeStamp": "2023-06-23T06:23:00Z"
},
"ApprovalCode": "924763",
"HostReconciliationID": "088c8f2c-01ab-4f7c-8333-3cef18224f95"
}
},
"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\n06/23/23 05:23:02\nClient ID: 17345800010001 \nMerchant ID: ********3998 \nTerm ID: 1126076 \n\n COMPLETION \n\n************4111 MC \nAppr Code: 924763 \nTransaction ID: 150791 \nPayment Type: CREDIT \nInvoice: 112233 \nResult:CAPTURED \nNet ID:03 \nApproved Amount:USD $14.00 \nRef: 000000000008 \nResponse: APPROVAL - 000 \nApproved: Online \n\nTotal: USD $ 14.00 \n\n\n\nX_______________________________________\n\n No Refunds \n Store Credit Only \n Merchant Copy \n@# BED BATH BEYOND 1997 \n 1997 \n 650 Liberty Ave \n UNION, NJ 07083 \n\n06/23/23 05:23:03\nClient ID: 17345800010001 \nMerchant ID: ********3998 \nTerm ID: 1126076 \n\n COMPLETION \n\n************4111 MC \nAppr Code: 924763 \nTransaction ID: 150791 \nPayment Type: CREDIT \nInvoice: 112233 \nResult:CAPTURED \nNet ID:03 \nApproved Amount:USD $14.00 \nRef: 000000000008 \nResponse: APPROVAL - 000 \nApproved: Online \n\nTotal: USD $ 14.00 \n\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
}
}
}
}
Rate this article:
