---
title: giftCardCredit - GraphQL Admin
description: Credit a gift card.
api_version: 2024-10
api_name: admin
type: mutation
api_type: graphql
source_url:
  html: 'https://shopify.dev/docs/api/admin-graphql/2024-10/mutations/giftCardCredit'
  md: >-
    https://shopify.dev/docs/api/admin-graphql/2024-10/mutations/giftCardCredit.txt
---

# gift​Card​Credit

mutation

Requires `write_gift_card_transactions` access scope.

Credit a gift card.

## Arguments

* credit​Input

  [Gift​Card​Credit​Input!](https://shopify.dev/docs/api/admin-graphql/2024-10/input-objects/GiftCardCreditInput)

  required

  The input fields to credit a gift card.

* id

  [ID!](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/ID)

  required

  The ID of the gift card to be credited.

***

## Gift​Card​Credit​Payload returns

* gift​Card​Credit​Transaction

  [Gift​Card​Credit​Transaction](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/GiftCardCreditTransaction)

  The gift card credit transaction that was created.

* user​Errors

  [\[Gift​Card​Transaction​User​Error!\]!](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/GiftCardTransactionUserError)

  non-null

  The list of errors that occurred from executing the mutation.

***

## Examples

* ### Create a new Gift Card Adjustment

  #### Query

  ```graphql
  mutation giftCardCredit($id: ID!, $creditInput: GiftCardCreditInput!) {
    giftCardCredit(id: $id, creditInput: $creditInput) {
      giftCardCreditTransaction {
        id
        amount {
          amount
          currencyCode
        }
        processedAt
        note
        giftCard {
          id
          balance {
            amount
            currencyCode
          }
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }
  ```

  #### Variables

  ```json
  {
    "id": "gid://shopify/GiftCard/411106674",
    "creditInput": {
      "creditAmount": {
        "amount": "10",
        "currencyCode": "USD"
      },
      "processedAt": "2024-09-09T12:48:33-04:00",
      "note": "A note."
    }
  }
  ```

  #### cURL

  ```bash
  curl -X POST \
  https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
  -H 'Content-Type: application/json' \
  -H 'X-Shopify-Access-Token: {access_token}' \
  -d '{
  "query": "mutation giftCardCredit($id: ID!, $creditInput: GiftCardCreditInput!) { giftCardCredit(id: $id, creditInput: $creditInput) { giftCardCreditTransaction { id amount { amount currencyCode } processedAt note giftCard { id balance { amount currencyCode } } } userErrors { message field code } } }",
   "variables": {
      "id": "gid://shopify/GiftCard/411106674",
      "creditInput": {
        "creditAmount": {
          "amount": "10",
          "currencyCode": "USD"
        },
        "processedAt": "2024-09-09T12:48:33-04:00",
        "note": "A note."
      }
    }
  }'
  ```

  #### Remix

  ```javascript
  const { admin } = await authenticate.admin(request);

  const response = await admin.graphql(
    `#graphql
    mutation giftCardCredit($id: ID!, $creditInput: GiftCardCreditInput!) {
      giftCardCredit(id: $id, creditInput: $creditInput) {
        giftCardCreditTransaction {
          id
          amount {
            amount
            currencyCode
          }
          processedAt
          note
          giftCard {
            id
            balance {
              amount
              currencyCode
            }
          }
        }
        userErrors {
          message
          field
          code
        }
      }
    }`,
    {
      variables: {
          "id": "gid://shopify/GiftCard/411106674",
          "creditInput": {
              "creditAmount": {
                  "amount": "10",
                  "currencyCode": "USD"
              },
              "processedAt": "2024-09-09T12:48:33-04:00",
              "note": "A note."
          }
      },
    },
  );

  const data = await response.json();
  ```

  #### Ruby

  ```ruby
  session = ShopifyAPI::Auth::Session.new(
    shop: "your-development-store.myshopify.com",
    access_token: access_token
  )
  client = ShopifyAPI::Clients::Graphql::Admin.new(
    session: session
  )

  query = <<~QUERY
    mutation giftCardCredit($id: ID!, $creditInput: GiftCardCreditInput!) {
      giftCardCredit(id: $id, creditInput: $creditInput) {
        giftCardCreditTransaction {
          id
          amount {
            amount
            currencyCode
          }
          processedAt
          note
          giftCard {
            id
            balance {
              amount
              currencyCode
            }
          }
        }
        userErrors {
          message
          field
          code
        }
      }
    }
  QUERY

  variables = {
    "id": "gid://shopify/GiftCard/411106674",
    "creditInput": {
      "creditAmount": {
        "amount": "10",
        "currencyCode": "USD"
      },
      "processedAt": "2024-09-09T12:48:33-04:00",
      "note": "A note."
    }
  }

  response = client.query(query: query, variables: variables)
  ```

  #### Node.js

  ```javascript
  const client = new shopify.clients.Graphql({session});
  const data = await client.query({
    data: {
      "query": `mutation giftCardCredit($id: ID!, $creditInput: GiftCardCreditInput!) {
        giftCardCredit(id: $id, creditInput: $creditInput) {
          giftCardCreditTransaction {
            id
            amount {
              amount
              currencyCode
            }
            processedAt
            note
            giftCard {
              id
              balance {
                amount
                currencyCode
              }
            }
          }
          userErrors {
            message
            field
            code
          }
        }
      }`,
      "variables": {
          "id": "gid://shopify/GiftCard/411106674",
          "creditInput": {
              "creditAmount": {
                  "amount": "10",
                  "currencyCode": "USD"
              },
              "processedAt": "2024-09-09T12:48:33-04:00",
              "note": "A note."
          }
      },
    },
  });
  ```

  #### Response

  ```json
  {
    "giftCardCredit": {
      "giftCardCreditTransaction": {
        "id": "gid://shopify/GiftCardCreditTransaction/1064273912",
        "amount": {
          "amount": "10.0",
          "currencyCode": "USD"
        },
        "processedAt": "2024-09-09T16:48:33Z",
        "note": "A note.",
        "giftCard": {
          "id": "gid://shopify/GiftCard/411106674",
          "balance": {
            "amount": "35.0",
            "currencyCode": "USD"
          }
        }
      },
      "userErrors": []
    }
  }
  ```

* ### giftCardCredit reference

[Open in GraphiQL](http://localhost:3457/graphiql?query=mutation%20giftCardCredit\(%24id%3A%20ID!%2C%20%24creditInput%3A%20GiftCardCreditInput!\)%20%7B%0A%20%20giftCardCredit\(id%3A%20%24id%2C%20creditInput%3A%20%24creditInput\)%20%7B%0A%20%20%20%20giftCardCreditTransaction%20%7B%0A%20%20%20%20%20%20id%0A%20%20%20%20%20%20amount%20%7B%0A%20%20%20%20%20%20%20%20amount%0A%20%20%20%20%20%20%20%20currencyCode%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20processedAt%0A%20%20%20%20%20%20note%0A%20%20%20%20%20%20giftCard%20%7B%0A%20%20%20%20%20%20%20%20id%0A%20%20%20%20%20%20%20%20balance%20%7B%0A%20%20%20%20%20%20%20%20%20%20amount%0A%20%20%20%20%20%20%20%20%20%20currencyCode%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%20%20%20%20userErrors%20%7B%0A%20%20%20%20%20%20message%0A%20%20%20%20%20%20field%0A%20%20%20%20%20%20code%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D\&variables=%7B%0A%20%20%22id%22%3A%20%22gid%3A%2F%2Fshopify%2FGiftCard%2F411106674%22%2C%0A%20%20%22creditInput%22%3A%20%7B%0A%20%20%20%20%22creditAmount%22%3A%20%7B%0A%20%20%20%20%20%20%22amount%22%3A%20%2210%22%2C%0A%20%20%20%20%20%20%22currencyCode%22%3A%20%22USD%22%0A%20%20%20%20%7D%2C%0A%20%20%20%20%22processedAt%22%3A%20%222024-09-09T12%3A48%3A33-04%3A00%22%2C%0A%20%20%20%20%22note%22%3A%20%22A%20note.%22%0A%20%20%7D%0A%7D)

```javascript
const { admin } = await authenticate.admin(request);


const response = await admin.graphql(
  `#graphql
  mutation giftCardCredit($id: ID!, $creditInput: GiftCardCreditInput!) {
    giftCardCredit(id: $id, creditInput: $creditInput) {
      giftCardCreditTransaction {
        id
        amount {
          amount
          currencyCode
        }
        processedAt
        note
        giftCard {
          id
          balance {
            amount
            currencyCode
          }
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/GiftCard/411106674",
        "creditInput": {
            "creditAmount": {
                "amount": "10",
                "currencyCode": "USD"
            },
            "processedAt": "2024-09-09T12:48:33-04:00",
            "note": "A note."
        }
    },
  },
);


const data = await response.json();
```

## Input variables

JSON

```json
{
  "id": "gid://shopify/GiftCard/411106674",
  "creditInput": {
    "creditAmount": {
      "amount": "10",
      "currencyCode": "USD"
    },
    "processedAt": "2024-09-09T12:48:33-04:00",
    "note": "A note."
  }
}
```

## Response

JSON

```json
{
  "giftCardCredit": {
    "giftCardCreditTransaction": {
      "id": "gid://shopify/GiftCardCreditTransaction/1064273912",
      "amount": {
        "amount": "10.0",
        "currencyCode": "USD"
      },
      "processedAt": "2024-09-09T16:48:33Z",
      "note": "A note.",
      "giftCard": {
        "id": "gid://shopify/GiftCard/411106674",
        "balance": {
          "amount": "35.0",
          "currencyCode": "USD"
        }
      }
    },
    "userErrors": []
  }
}
```