REST API

orderInformation. amountDetails.gratuityAmount

Gratuity or tip amount for restaurants when the card is present.
Allowed only when the
orderInformation.amountDetails.gratuityAmount
field value is
restaurant
.
Restaurant data is supported only on
Visa Platform Connect
.
When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount.

Specifications

  • Data Type:
    String
  • Data Length:
    12

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.gratuityAmount
  • SCMP API Field:
    gratuity_amount
  • Simple Order API Field:
    ccCaptureService_gratuityAmount