Share Gift Card

Shares a saved gift card with another user, granting them equal access to the same card balance.

Headers

x-applicationSource
Type: string
required

A custom HTTP header that accepts a free-form string value. It is used to identify the application making the API request. For example, if Punchh invokes the API, the value could be "punchh".
X-LocationId
Type: string
required

The unique location identifier for the store or business location processing the transaction.
Content-Type
Type: string
required

The media type of the request body. Must be set to application/json.
Authorization
Type: string
required

Bearer token for API authorization. Send in the format: Bearer ACCESS_TOKEN_GOES_HERE.

Body·

application/json

Request containing the sender userId, recipient userId, and gift card ID to share.

giftCardId
Type: string
min length:
1
required

The gift card ID to share (returned by savegiftcard).
recipientUserId
Type: string
min length:
1
required

The unique identifier of the user receiving access to the gift card.
senderUserId
Type: string
min length:
1
required

The unique identifier of the user sharing the gift card.

Responses

application/json
application/json
application/json
application/json

post/giftcard/v1/sharegiftcard

curl https://SERVER_NAME_GOES_HERE.partech.com/giftcard/v1/sharegiftcard \
  --request POST \
  --header 'x-applicationSource: ' \
  --header 'X-LocationId: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer ACCESS_TOKEN_GOES_HERE' \
  --data '{
  "senderUserId": "user-abc123",
  "recipientUserId": "user-xyz789",
  "giftCardId": "01JNXXXXXXXXXXXXXXXXXXXXXX"
}'

Show Schema

{
  "giftCardId": "01JNXXXXXXXXXXXXXXXXXXXXXX"
}

Gift card shared successfully