Cashback and cash out

Outlines obtaining a small amount of cash from a card with or without a purchase.


In specific regions, a customer can obtain a small amount of cash from their account along with their purchase (cashback), or obtain the cash without a purchase (cashout).

Currently only EFTPOS cards support these features.

To perform cashbacks or cashouts, contact the POS Support Team to enable this feature.

Endpoint

The URL used to send  Terminal API  messages depends on your type of implementation. For more information on the architectures available, see the Terminal API Overview .

Request

For a list of Payment Request fields, see PaymentRequest fields. The elements of a login request are wrapped in a PaymentRequest envelope.

The SaleID and ServiceID in the MessageHeader should be unique. SaleID and ServiceID combinations are rejected if used recently, within 48 hours.

Pass the following fields when making a PaymentRequest call to the Terminal API.

PaymentRequest - Cashback
{
  "SaleToPOIRequest": {
    "MessageHeader": {
      "ProtocolVersion": "3.0",
      "MessageClass": "Service",
      "MessageCategory": "Payment",
      "MessageType": "Request",
      "ServiceID": "0501160930",
      "SaleID": "POSSystemID12345",
      "POIID": "P400Plus-540004072"
    },
    "PaymentRequest": {
      "SaleData": {
        "SaleTransactionID": {
          "TransactionID": "3375",
          "TimeStamp": "2018-05-01T14:09:30+00:00"
        }
      },
      "PaymentTransaction": {
        "AmountsReq": {
          "Currency": "AUD",
          "RequestedAmount": 400,
          "CashBackAmount": 20
        }
      }
    }
  }
}

Response

For a list of Payment Response fields, see PaymentResponse fields.

The payment response contains information about the status of the cashback or cashout in the following fields:

PaymentResponse - Cashback
{
  "SaleToPOIResponse": {
    "PaymentResponse": {
      "POIData": {
        "POITransactionID": {
          "TimeStamp": "2018-05-01T14:09:30.000Z",
          "TransactionID": "u6W7001525183770000.9815251837923768"
        }
      },
      "SaleData": {
        "SaleTransactionID": {
          "TimeStamp": "2018-05-01T14:09:30.000Z",
          "TransactionID": "3375"
        }
      },
      "PaymentResult": {
        "AuthenticationMethod": [
          "OnlinePIN"
        ],
        "PaymentAcquirerData": {
          "AcquirerPOIID": "P400Plus-540004072",
          "AcquirerTransactionID": {
            "TimeStamp": "2018-05-01T14:09:30.000Z",
            "TransactionID": "9815251837923768"
          },
          "MerchantID": "TestMerchantPOSAU1"
        },
        "PaymentInstrumentData": {
          "CardData": {
            "EntryMode": [
              "MagStripe"
            ],
            "PaymentBrand": "eftpos_australia_sav",
            "MaskedPan": "637204 **** 0025",
            "SensitiveCardData": {
              "ExpiryDate": "1220"
            }
          },
          "PaymentInstrumentType": "Card"
        },
        "AmountsResp": {
          "AuthorizedAmount": 400,
          "CashBackAmount": 20,
          "Currency": "AUD"
        }
      },
      "Response": {
        "Result": "Success",
        "AdditionalResponse": "tid=87253103&transactionType=GOODS_SERVICES_WITH_CASHBACK&pspReference=9815251837923768&cardHolderName=&offline=false&mid=000023000000015&note=Direct%20API%20REQUIRES%20payload%20crypto%20on%20live%2c%20cleartext%20allowed%20for%20testing%20only&cardHolderVerificationMethodResults=020300&cashBackAmountValue=20"
      }
    },
    "MessageHeader": {
      "ProtocolVersion": "3.0",
      "SaleID": "POSSystemID12345",
      "MessageClass": "Service",
      "MessageCategory": "Payment",
      "ServiceID": "0501160930",
      "POIID": "P400Plus-540004072",
      "MessageType": "Response"
    }
  }
}