API Explorer

You are viewing an old version of the API

All Versions

Create gift card activity

Beta

- POST /v2/gift-cards/activities

Creates a gift card activity to manage the balance or state of a gift card.

Open in API Reference

Access Tokens Sign in to populate your access tokens from the developer dashboard Sign In

Body

gift_card_activity

An activity to create on the gift card. This includes the type of gift card activity and corresponding activity details.

GiftCardActivity

location_id

The ID of the location at which the activity occurred.

string

type

The type of the gift card activity.

string

Select type

ACTIVATE Activated a gift card with a balance.

activate_activity_details

Gift card activity data for activating a gift card. This data is present only when the type is ACTIVATE.

GiftCardActivityActivate

amount_money

The amount of money to add to the card. This is required if your application does not use the Square Orders API.

Money

buyer_payment_instrument_ids

Required if your application does not use the Square Orders API. This is a list of client-provided payment instrument IDs. Square uses this information to perform compliance checks. If you use the Square Orders API, Square has the necessary instrument IDs to perform necessary compliance checks.

string[]

line_item_uid

The line_item_uid of the gift card line item in an order. This is required if your application uses the Square Orders API.

string

order_id

The ID of the order associated with the activity. This is required if your application uses the Square Orders API.

string

reference_id

If your application does not use the Square Orders API, you can optionally use this field to associate the gift card activity with a client-side entity.

string

adjust_decrement_activity_details

Gift card activity data for manually decreasing the balance of a gift card. Present only when type is ADJUST_DECREMENT

GiftCardActivityAdjustDecrement

adjust_increment_activity_details

Gift card activity data for manually increasing the balance of a gift card. Present only when type is ADJUST_INCREMENT

GiftCardActivityAdjustIncrement

clear_balance_activity_details

Gift card activity data for clearing the balance on a gift card. Present only when type is CLEAR_BALANCE

GiftCardActivityClearBalance

deactivate_activity_details

Gift card activity data for deactivating a gift card. Present only when type is DEACTIVATE

GiftCardActivityDeactivate

gift_card_gan

The gift card GAN. The GAN is not required if gift_card_id is present.

string

gift_card_id

The gift card ID. The ID is not required if a GAN is present.

string

load_activity_details

Gift card activity data for adding value to the gift card. This data is present only when the type is LOAD.

GiftCardActivityLoad

redeem_activity_details

Gift card activity data for redeeming a gift card. This data is present only when the type is REDEEM.

GiftCardActivityRedeem

refund_activity_details

Gift card activity data for refunding an activity. This data is present only when the type is REFUND.

GiftCardActivityRefund

unlinked_activity_refund_activity_details

Gift card activity data for refunding an unlinked activity. Present only when type is UNLINKED_ACTIVITY_REFUND.

GiftCardActivityUnlinkedActivityRefund

idempotency_key

A unique string that identifies the CreateGiftCardActivity request.

string

You are viewing an old version of the API

All Versions

Request

cURL

Ruby

Python

Java

PHP

Node.js

Response

// No response received yet.

Thanks for the feedback. For more help, check out our support resources.

Developer Support Developer Forums

There was an error submitting feedback. Try again later.

Developer Support Developer Forums