# Gift Cards ## Activate - [POST /giftcards/activate](https://docs.shift4.com/apis/payments-platform-rest/openapi/gift-cards/activate.md): This function requests that a new gift card be activated for use or that a new gift card be loaded with funds. - Host Direct - Locally Installed UTG See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option. See the JSON Body Schemas for more details on the various JSON body formats. ## Allocate - [POST /giftcards/allocate](https://docs.shift4.com/apis/payments-platform-rest/openapi/gift-cards/allocate.md): This function requests that a new gift card be allocated for use under a specific Program ID. The new card will be generated during the request and activated with the requested amount. - Host Direct - Locally Installed UTG See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option. ## Deactivate - [POST /giftcards/deactivate](https://docs.shift4.com/apis/payments-platform-rest/openapi/gift-cards/deactivate.md): This function requests that an active gift card be deactivated so that it can’t be used to process transactions. A balance will remain on the gift card (if supported by the processor). If you want to return the card's current balance back to the customer, use the Cashout endpoint instead. - Host Direct - Locally Installed UTG See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option. See the JSON Body Schemas for more details on the various JSON body formats. ## Cashback - [POST /giftcards/cashback](https://docs.shift4.com/apis/payments-platform-rest/openapi/gift-cards/cashback.md): This function requests that an active gift card be deactivated so that it can’t be used to process transactions. Any current balance is removed from the card so that the funds can be returned to the consumer as cash. - Host Direct - Locally Installed UTG See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option. See the JSON Body Schemas for more details on the various JSON body formats. ## Reactivate - [POST /giftcards/reactivate](https://docs.shift4.com/apis/payments-platform-rest/openapi/gift-cards/reactivate.md): This function requests that a previously deactivated gift card be reactivated. If there was a balance remaining on the gift card at the time of deactivation, the balance will again become available for use. Funds cannot be added to a gift card during a Reactivate request. - Host Direct - Locally Installed UTG See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option. See the JSON Body Schemas for more details on the various JSON body formats. ## Reload - [POST /giftcards/reload](https://docs.shift4.com/apis/payments-platform-rest/openapi/gift-cards/reload.md): This function requests that an active gift card be loaded with additional funds. - Host Direct - Locally Installed UTG See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option. See the JSON Body Schemas for more details on the various JSON body formats. ## Balance - [POST /giftcards/balance](https://docs.shift4.com/apis/payments-platform-rest/openapi/gift-cards/balance.md): This function requests that a gift card's balance, masked card number, expiration date, and discount percentage be returned. Merchants may be required to pay a fee for an inquiry request depending on their processor agreement. - Host Direct - Locally Installed UTG See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option. See the JSON Body Schemas for more details on the various JSON body formats. ## Cancel - [POST /giftcards/cancel](https://docs.shift4.com/apis/payments-platform-rest/openapi/gift-cards/cancel.md): This function attempts to undo the last /giftcards/* request that was made against a gift card or private label card. For example, an Activate or Reload request may eligible for cancellation. Some processors do not support this functionality. This endpoint cannot be used to cancel a sale or authorization against a gift card - the Void request should be used for that scenario. - Host Direct - Locally Installed UTG See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option. ## Cashout (deprecated) - [POST /giftcards/cashout](https://docs.shift4.com/apis/payments-platform-rest/openapi/gift-cards/cashout.md): This function requests that an active gift card be deactivated so that it can’t be used to process transactions. Any current balance is removed from the card so that the funds can be returned to the consumer as cash. - Host Direct - Locally Installed UTG See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option. See the JSON Body Schemas for more details on the various JSON body formats.