mobile_generating_gift_card_epin

Get Gift Card EPIN

​

Returns the generated EPIN for a gift card

Path Parameters
  • uuid
    Type: string
    required

    Unique ID of the gift card issued by and maintained in the Punchh system

Headers
  • Accept
    Type: string
    required

    Advertises which content types the client is able to understand

  • Accept-Language
    Type: string

    Preferred language

  • 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

  • x-pch-digest
    Type: string
    required

    The signature for the API call

  • 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
  • client
    Type: string
    required

    OAuth client ID provided by the business

  • passcode
    Type: string

    Secondary authentication PIN that must be passed if it is enabled for a business. It can be turned on/off from the Punchh platform.

Responses
  • 200
    Type: object
    • epin
      Type: string

      Security PIN associated with a gift card. A 'NULL' value indicates that no EPIN is associated with the gift card.

get/api2/mobile/gift_cards/{uuid}/epin
{
  "epin": "string"
}