Creates a gift card activity to manage the balance or state of a gift card.
Open in API Reference
An activity to create on the gift card. This includes the type of gift card activity and corresponding activity details.
The ID of the location at which the activity occurred.
A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field’s value.
''
The type of the gift card activity.
Gift card activity data for activating a gift card. This data is present only when the type is ACTIVATE.
Gift card activity data for manually decreasing the balance of a gift card. Present only when type is ADJUST_DECREMENT
Gift card activity data for manually increasing the balance of a gift card. Present only when type is ADJUST_INCREMENT
Gift card activity data for clearing the balance on a gift card. Present only when type is CLEAR_BALANCE
Gift card activity data for deactivating a gift card. Present only when type is DEACTIVATE
The gift card GAN. The GAN is not required if gift_card_id is present.
gift_card_id
The gift card ID. The ID is not required if a GAN is present.
Gift card activity data for adding value to the gift card. This data is present only when the type is LOAD.
The amount of money to be added or removed, depending on the activity. The value of the field is always positive. This is not needed if order_id and line_item_id are provided.
order_id
line_item_id
If you are not using the Orders API, this field is required because it is used to identify a buyer to perform compliance checks.
The line_item_uid of the gift card’s line item in the order associated with the activity. It is populated along with order_id and is required if using the Square Orders API.
line_item_uid
The order_id of the order associated with the activity. It is populated along with line_item_uid and is required if using the Square Orders API.
A client-specified ID to associate an entity, in another system, with this gift card activity. This can be used to track the order or payment related information when the Square Orders API is not being used.
Gift card activity data for redeeming a gift card. This data is present only when the type is REDEEM.
Gift card activity data for refunding an activity. This data is present only when the type is REFUND.
Gift card activity data for refunding an unlinked activity. Present only when type is UNLINKED_ACTIVITY_REFUND.
UNLINKED_ACTIVITY_REFUND
A unique string that identifies the CreateGiftCardActivity request.
CreateGiftCardActivity
// No response received yet.