In-Person Payments

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

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

{
  "MessageHeader": {
    "MessageClass": "SERVICE",
    "MessageCategory": "PAYMENT",
    "MessageType": "REQUEST",
    "ServiceID": "1234",
    "SaleID": "1234",
    "POIID": "P400 459"
  },
  "PaymentRequest": {
    "SaleData": {
      "SaleTransactionID": {
        "TransactionID": "68537",
        "TimeStamp": "2019-08-21T16:35:05.073Z"
      },
      "CustomerOrderReq": null,
      "SaleToAcquirerData": null
    },
    "PaymentTransaction": {
      "AmountsReq": {
        "Currency": "GBP",
        "RequestedAmount": "11.00",
        "TipAmount": "0"
      },
      "OriginalPOITransaction": {
        "POITransactionID": {
          "TransactionID": "150805",
          "TimeStamp": "2020-04-20T14:43:59+05:30"
        }
      }
    },
    "PaymentData": {
      "PaymentType": "REFUND"
    }
  }
}

• Perform the transaction in the terminal/external terminal simulator.
  
  • In the external terminal simulator, click on the Green button to simulate a successful transaction; click on the Red button to simulate a failed transaction.

Based on the response from the terminal/external terminal simulator, 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": "68537",
        "TimeStamp": "2019-08-21T16:35:05.073Z"
      },
      "TokenRequestedType": null,
      "SaleReferenceID": null,
      "SaleTerminalData": null,
      "CustomerOrderReq": null,
      "SaleToPOIData": "{\"c\":\"150806\",\"m\":\"MC\",\"p\":\"CREDIT\",\"i\":\"68537\",\"r\":\"CAPTURED\",\"rc\":\"4\",\"ts\":\"SUCCESS\"}",
      "SaleToAcquirerData": null,
      "VF_SaleNote": null
    },
    "POIData": {
      "POITransactionID": {
        "TransactionID": "150806",
        "TimeStamp": "2023-06-23T06:34:45Z"
      },
      "POIReconciliationID": null
    },
    "PaymentResult": {
      "PaymentType": "REFUND",
      "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": "GBP",
        "AuthorizedAmount": "11",
        "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": "857008",
          "TimeStamp": "2023-06-23T06:34:45Z"
        },
        "ApprovalCode": "OK1373",
        "HostReconciliationID": "e6627cd2-ba11-4bc7-b8e2-bd325f3d7f63"
      }
    },
    "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:34:46\nClient ID: 17345800010001               \nMerchant ID: ********3998               \nTerm ID: 1126076                        \n\n                 Refund                 \n\n************4111                        \nEntry Method: Host Retrieval            \nAppr Code: OK1373                       \nTransaction ID: 150806                  \nPayment Type: CREDIT                    \nResult:CAPTURED                         \nApproved Amount:USD $11.00              \nNet ID:03                               \nNet Name:MASTERCARD                     \nInvoice: 68537                          \nRef: 000000000022                       \nResponse: APPROVAL - 000                \nApproved: Online                        \n\nTotal:           USD    $          11.00\n\n         NO SIGNATURE REQUIRED          \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:34:47\nClient ID: 17345800010001               \nMerchant ID: ********3998               \nTerm ID: 1126076                        \n\n                 Refund                 \n\n************4111                        \nEntry Method: Host Retrieval            \nAppr Code: OK1373                       \nTransaction ID: 150806                  \nPayment Type: CREDIT                    \nResult:CAPTURED                         \nApproved Amount:USD $11.00              \nNet ID:03                               \nNet Name:MASTERCARD                     \nInvoice: 68537                          \nRef: 000000000022                       \nResponse: APPROVAL - 000                \nApproved: Online                        \n\nTotal:           USD    $          11.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
      }
    }
  }
}