Terminal-2 icon

Cashback

Obtain a small amount of cash from a card with a purchase or without a purchase (cashout).

The cashback feature lets shoppers get cash in hand from their account, either with their purchase or without a purchase. Cashback without a purchase is often called cashout.

This page shows how to make a Terminal API cashback request and interpret the response.

Requirements

Before you begin, take into account the following requirements, limitations, and preparations.

Requirement Description
Integration type This feature is supported with a Terminal API integration with payment terminals.
Limitations Support for the feature is limited to specific cards and countries/regions.
Setup steps Before you begin, contact our Support Team to enable cashbacks.

Issue a cashback

  1. Determine the following values that you will need to pass in your payment request:

    • The cashback amount.

    • The sum of the cashback amount and the amount due for the shopper's purchases.

  2. Make a payment request, including:

    • The PaymentTransaction object with the total and cashback amounts:

      Parameter Description
      AmountsReq.RequestedAmount The total amount to be paid by the shopper. That is the amount of the purchase plus the amount of the cashback.
      AmountsReq.CashBackAmount The cashback amount.

    The example below shows the request for a shopper who purchased goods for 10 AUD, and wants to get a cashback of 2 AUD:

  3. When you receive the payment response, check the PaymentResponse.Response.Result:

    • Success means the issuer authorized both the payment and the cashback.
      The amount in the PaymentResult.AmountsResp.CashBackAmount field is the amount that you need to pay to the shopper in cash.

    • Partial means the issuer authorized the payment but not the cashback.

Supported cards and countries/regions

Cashback is supported for:

  • eftpos debit cards in Australia.
  • girocard debit cards in Germany. Only with a purchase.
  • Mastercard in Europe. Only with a purchase, and only in specific countries/regions. Contact our Support Team to learn for which countries/regions cashback can be enabled.
  • Visa in Europe. Only with a purchase

See also