Transfer Gift Card or Balance

Transfers an entire gift card or partial amount from one user to another user. If the balance transfer feature is disabled for the brand in the Punchh platform, the API returns a 422 error. Contact your Punchh representative to update this Punchh platform configuration.

Path Parameters

uuid
Type: string
required

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

Headers

Authorization
Type: string
required

Used to authorize the request with access_token. It should be supplied as Bearer ACCESS_TOKEN_GOES_HERE.
x-pch-digest
Type: string
required

The signature for the API call
Accept
Type: string
required

Advertises which content types the client is able to understand
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.

Body

application/json

amount
Type: string
required

Amount being transferred to a recipient. If the entire available amount on a gift card is selected, the whole card will be transferred.
client
Type: string
required

OAuth client ID provided by the business
recipient_email
Type: string
required

Email address of the user to whom the balance / gift card is being transferred. 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
required

Facebook "uid" of the user to whom the balance / gift card is being transferred. 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
required

Phone number of the user to whom the balance / gift card is being transferred. 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.
full_transfer
Type: boolean

Whether a gift card should be transferred or not. A "true" value indicates that the gift card itself should be transferred. Following the gift card transfer, the system revokes the original user’s ownership, and the transferee becomes the new owner. A "false" value indicates that only a partial amount should be transferred from the gift card.
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

text/plain
422

Please turn on <config_key> in Mobile Configuration before performing this gift card action.

post/api2/mobile/gift_cards/{uuid}/transfer

curl 'https://SERVER_NAME_GOES_HERE.punchh.com/api2/mobile/gift_cards/{uuid}/transfer' \
  --request POST \
  --header 'Authorization: Bearer ACCESS_TOKEN_GOES_HERE' \
  --header 'x-pch-digest: {{$$.env.signature}}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: AppName/AppVersion/BuildNumber (OS; Model; MANUFACTURER; MODEL; OS Version)' \
  --data '{
  "client": "CLIENT_GOES_HERE",
  "recipient_email": "test@example.com",
  "recipient_phone": 1111111111,
  "recipient_fb_uid": "FB_UID_GOES_HERE",
  "passcode": "1234",
  "amount": "13",
  "full_transfer": false
}'

[
  "Your transfer of $13.00 to <user> is bound to come back to you tenfold. It’s the burrito karma, Amigo!"
]

Fetch Gift Card Transaction History

Share Gift Card