mobile_gift_a_card

Gift a Gift Card

​

Enables a user to gift a gift card to another user

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-Language
    Type: string

    Preferred language

  • Accept
    Type: string
    required

    Advertises which content types the client is able to understand

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

    Monetary value of the gift card

  • cardholder_name
    Type: string

    Name of the person who owns the payment card used to purchase the gift card

  • client
    Type: string
    required

    OAuth client ID provided by the business

  • design_id
    Type: string

    Identification of a particular gift card design selected by the user while gifting a gift card

  • exp_date
    Format: dateenum
    const:  
    YYYY-MM-DD

    Expiration date of the payment card used by the user

    • YYYY-MM-DD
  • payment_type
    Type: string

    This parameter is required when a user makes a payment via saved cards. Send "recurring" as the value of this parameter.

  • recipient_email
    Type: string

    Email address of the user who will receive the gift card. At least one of the three (i.e., recipient_email, recipient_phone, and recipient_fb_uid) should be provided. If more than one are provided as parameters, the system will identify that user for whom all of the provided parameters match.

  • recipient_fb_uid
    Type: string

    Facebook "uid" of the user who will receive the gift card. At least one of the three (i.e., recipient_email, recipient_phone, and recipient_fb_uid) should be provided. If more than one are provided as parameters, the system will identify that user for whom all of the provided parameters match.

  • recipient_phone
    Type: integerFormat: int32

    Phone number of the user who will receive the gift card. At least one of the three (i.e., recipient_email, recipient_phone, and recipient_fb_uid) should be provided. If more than one are provided as parameters, the system will identify that user for whom all of the provided parameters match.

  • transaction_token
    Type: string

    Unique digital identifier/token of the user's payment card, or the UUID of the saved payment card if the value of payment_type is "recurring". The transaction token is issued by a payment processor used by a business.

  • type
    Type: string

    Type of payment card used by the user (e.g., Visa, Mastercard, etc.).

Responses
  • 200
    Type: object
post/api2/mobile/gift_cards/gift
{}