Cashback or cashout from a card

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 a cashback or cashout, pass the corresponding transaction_type listed below when you create a tender. For more information on how to create a tender, see Create the tender.

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

Parameters

Value Description
GOODS_SERVICES_WITH_CASHBACK
Pass this value as the transaction_type with the create_tender method to allow a customer to obtain cash along with their purchase. For a cashback, the cashback amount is the difference between the price of the purchased goods and the total authorised amount. For example, if an item costs $70, and the customer asks for $30 cashback, the total authorised amount is $100. Populate the field cashbackAmount in Additional Data with the cash amount that will be provided to the shopper. The field amount equals the total authorised amount (cashbackAmount + value of the purchased goods and services).
CASHOUT Pass this value as the transaction_type with the create_tender method to allow a customer to obtain cash without a purchase. For a cashout, the cashback amount equals the total authorised amount. The field amount equals the total authorised amount (which is also equal to the cash amount that is provided to the shopper). Populate the field cashbackAmount in Additional Data with the cash amount that will be provided to the shopper.