mobile_fetch_gift_card_transaction_history

Fetch Gift Card Transaction History

​

Returns the transaction history of a specified gift card

Path Parameters
  • uuid
    Type: string
    required

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

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

  • Accept
    Type: string
    required

    Advertises which content types the client is able to understand

  • Accept-Language
    Type: string

    Preferred language

  • Content-Type
    Type: string
    required

    Set this header to application/json.

  • 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

Responses
  • 200
    Type: array object[]
    • amount
      Type: numberFormat: float

      Amount involved in the transaction

    • balance
      Type: numberFormat: float

      Updated balance of the gift card after the transaction

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

      Date/time when the transaction happened, in ISO 8601 format

      • YYYY-MM-DDThh:mm:ssZ
    • description
      Type: string

      Additional information about the transaction event. A 'null' value indicates that no additional details are available.

    • event
      Type: string

      Title of the transaction event displayed in the app. This respects the locale, so the value of this may change with the requested locale.

    • event_type
      Type: string

      Fixed value of the transaction event that indicates the type of gift card transaction. Logic in the app can be applied based on the values returned in this parameter. For example, color coding in the transaction history can be based on this. Values returned are:

      • reloaded
      • card_added
      • transferred
      • redeemed
get/api2/mobile/gift_cards/{uuid}/history
[
  {
    "date": "YYYY-MM-DDThh:mm:ssZ",
    "event": "string",
    "description": "string",
    "amount": 1,
    "balance": 1,
    "event_type": "string"
  }
]