Tips

External payment gateway applications can work with the inTandem Tips feature and include it in the app experience.

Tips are configured at the business level on the Payments Settings page. Businesses can configure 3 pre-set tip options, but a custom tip value can be set at the checkout or charge pages if needed.

More information and product examples regarding tips can be found in this article.

📘

Tips app

The tips feature is available on inTandem as a paid app, thus only businesses who purchased the Tips app will have it.

However, certain directories or inTandem partners might have the Tips feature enabled by default, thus all accounts under those directories will have Tips enabled with no further actions needed.

Managing business-global tips settings

Using the app OAuth access tokens, you can view and manage tips' business-global settings.

Both Get and Update options are available through the Get Payment Settings and Update Payment Settings APIs.

Tips on Charge and Checkout pages

Tips can be added by the business owner when processing payments via back-office (Charge) or by the end client on checkout. In both cases, the Charge and Checkout flows remain the same, and the amount inTandem sends to your application will reflect the total amount of the original amount plus the tip amount.

Post-checkout tips

While end clients can add tips in the client portal before the redirect to the external checkout page, tips can also be applied retroactively if your external checkout page supports it.

In that case, when adding tips from the external checkout page, the PUT request for updating the checkout should include the tips data as well as setting the sync_flow to true.

curl --request PUT \
     --url https://api.vcita.biz/platform/v1/payment/checkout/ \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {TOKEN}' \
     --header 'content-type: application/json' \
     --data '
{
  "amount": 100,
  "payment_method": "Credit Card",
  "ps_id": "{PAYMENT_STATUS_UID}",
  "sync_flow": true,
  "tips": [
    {
      "amount": 15
    }
  ],
  "transaction_id": "{EXTERNAL_TRANSACTION_ID}",
  "type": "checkout.session.completed",
  "url_key": "{URL_KEY}"
}
'

payment_status_uid (ps_id)

The payment_status_uid can be retrieved via the GET Checkout Details API.

The "id" property from the response payload corresponds to the payment_status_uid.

tips

tip value should be the fixed tip amount, not a percentage.