v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB

GiftCardActivities

CreateGiftCardActivity

Creates a gift card activity. For more information, see GiftCardActivity and Using activated gift cards.

post/v2/gift-cards/activities

Request body

idempotency_keystring required

A unique string that identifies the CreateGiftCardActivity request.

Example request

{
  "request_body": {
    "gift_card_activity": {
      "activate_activity_details": {
        "line_item_uid": "eIWl7X0nMuO9Ewbh0ChIx",
        "order_id": "jJNGHm4gLI6XkFbwtiSLqK72KkAZY"
      },
      "gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20",
      "location_id": "81FN9BNFZTKS4",
      "type": "ACTIVATE"
    },
    "idempotency_key": "U16kfr-kA70er-q4Rsym-7U7NnY"
  }
}

Response

Success

Example response

{
  "gift_card_activity": {
    "activate_activity_details": {
      "amount_money": {
        "amount": 1000,
        "currency": "USD"
      },
      "line_item_uid": "eIWl7X0nMuO9Ewbh0ChIx",
      "order_id": "jJNGHm4gLI6XkFbwtiSLqK72KkAZY"
    },
    "created_at": "2021-05-20T22:26:54.000Z",
    "gift_card_balance_money": {
      "amount": 1000,
      "currency": "USD"
    },
    "gift_card_gan": "7783320002929081",
    "gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20",
    "id": "gcact_c8f8cbf1f24b448d8ecf39ed03f97864",
    "location_id": "81FN9BNFZTKS4",
    "type": "ACTIVATE"
  }
}