Create gift card activity BETA
POST
/v2/gift-cards/activities
Creates a gift card activity.
For more information, see GiftCardActivity and Using activated gift cards.
Permissions
GIFTCARDS_WRITE
Try in API Explorer
| Name | Description |
|---|---|
idempotency_
Required
|
A unique string that identifies the |
gift_
Required
|
An activity to create on the gift card. This includes the type of gift card activity and corresponding activity details. |
Response Fields
| Name | Description |
|---|---|
errors
|
Any errors that occurred during the request. |
gift_
|
A gift card activity that was created. |
Examples
POST
/v2/gift-cards/activities
cURL
- cURL
- Ruby
- Python
- C#
- Java
- PHP
- Node.js
curl https://connect.squareup.com/v2/gift-cards/activities \
-X POST \
-H 'Square-Version: 2021-09-15' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"idempotency_key": "U16kfr-kA70er-q4Rsym-7U7NnY",
"gift_card_activity": {
"gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20",
"type": "ACTIVATE",
"location_id": "81FN9BNFZTKS4",
"activate_activity_details": {
"order_id": "jJNGHm4gLI6XkFbwtiSLqK72KkAZY",
"line_item_uid": "eIWl7X0nMuO9Ewbh0ChIx"
}
}
}'
Response JSON
{
"gift_card_activity": {
"id": "gcact_c8f8cbf1f24b448d8ecf39ed03f97864",
"gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20",
"gift_card_gan": "7783320002929081",
"type": "ACTIVATE",
"gift_card_balance_money": {
"amount": 1000,
"currency": "USD"
},
"location_id": "81FN9BNFZTKS4",
"created_at": "2021-05-20T22:26:54.000Z",
"activate_activity_details": {
"amount_money": {
"amount": 1000,
"currency": "USD"
},
"order_id": "jJNGHm4gLI6XkFbwtiSLqK72KkAZY",
"line_item_uid": "eIWl7X0nMuO9Ewbh0ChIx"
}
}
}Error Descriptions
| 400 Bad request |
PAYMENT_ Square declined the request because the payment amount exceeded the processing limit for this merchant. |
> |
| 400 Bad request |
INSUFFICIENT_ The funding source has insufficient funds to cover the payment. |
> |
400
Bad request
{
"errors": [
{
"code": "PAYMENT_LIMIT_EXCEEDED",
"category": "PAYMENT_METHOD_ERROR"
}
]
}