data-src=../../../../includes/commerce-only.md

redeemGiftCardBalanceAsStoreCredit mutation

The redeemGiftCardBalanceAsStoreCredit mutation converts the entire balance of a gift card to store credit. The gift card must be redeemable and cannot have a balance of 0 at the time you run the mutation. After successfully running the mutation, the value of the gift card changes to 0.

data-variant=info

data-slots=text

Syntax

mutation {
  redeemGiftCardBalanceAsStoreCredit(
    input: GiftCardAccountInput
  ) {
    GiftCardAccount
  }
}

Reference

The redeemGiftCardBalanceAsStoreCredit reference provides detailed information about the types and fields defined in this mutation.

• Adobe Commerce as a Cloud Service

• On-Premises/Cloud

Example usage

The following example redeems the gift card with code "056MHP57TJ5C".

Request:

mutation {
  redeemGiftCardBalanceAsStoreCredit(
    input: {
      gift_card_code: "056MHP57TJ5C"
    }
  ) {
    balance {
      currency
      value
    }
    code
    expiration_date
  }
}

Response:

{
  "data": {
    "redeemGiftCardBalanceAsStoreCredit": {
      "balance": {
        "currency": "USD",
        "value": 0
      },
      "code": "056MHP57TJ5C",
      "expiration_date": null
    }
  }
}

Errors