mobile_tip_via_gift_card

Tip via Gift Card

​

Enables a user to leave a tip (gratuity) using a gift card

Path Parameters
  • uuid
    Type: string
    required

    Unique ID of the gift card used for the tip

Headers
  • x-pch-digest
    Type: string
    required

    The signature for the API call

  • Authorization
    Type: string
    required

    Used to authorize the request with access_token. It should be supplied as Bearer ACCESS_TOKEN_GOES_HERE. Note: When authentication is performed using Advanced Authentication, you must include the id_token in the id-token header and the access_token in the Authorization header. See Access Punchh APIs Using Access and ID tokens

  • Content-Type
    Type: string
    required

    Set this header to application/json.

  • Accept
    Type: string
    required

    Advertises which content types the client is able to understand

  • Accept-Language
    Type: string

    Preferred language

  • User-Agent
    Type: string
    required

    Used to identify the software, device, and application initiating the request, providing information about the client to the server. For details, see User Agent.

  • id-token
    Type: string

    A token that contains identity information about the authenticated user. It is used to verify the user’s identity and is required only when authentication is performed using Advanced Authentication. This token alone does not grant access to Punchh APIs. To access the APIs, you must include the id_token in the id-token header and the access_token in the Authorization header. See Access Punchh APIs Using Access and ID tokens

Body
application/json
  • checkin_id
    Type: integer
    required

    Identifier of the check-in/order for which the tip is given

  • client
    Type: string
    required

    OAuth client ID provided by the business

  • tip
    Type: number
    required

    Currency value of the tip, which should be less than or equal to the gift card balance

Responses
  • 200
    Type: object
    • approved_amount
      Type: number

      Amount of the tip

    • checkin_id
      Type: integer

      Identifier of the check-in/order for which the tip is given

    • gift_card_uuid
      Type: string

      Unique ID of the gift card used for the tip

    • location_id
      Type: integer

      Unique ID of the location where the tip occurred

    • tipping_time
      Format: date-timeenum
      const:  
      YYYY-MM-DDThh:mm:ssZ

      Date/time when the tip was created in the system, in ISO 8601 format

      • YYYY-MM-DDThh:mm:ssZ
post/api2/mobile/gift_cards/{uuid}/tip
{
  "tipping_time": "YYYY-MM-DDThh:mm:ssZ",
  "checkin_id": 1,
  "location_id": 1,
  "approved_amount": 1,
  "gift_card_uuid": "string"
}