Gift
Requires access scope.
Represents an error that happens during the execution of a gift card transaction mutation.
Anchor to FieldsFields
- code (GiftCardTransactionUserErrorCode)
- field ([String!])
- message (String!)
- Anchor to codecode•Gift
Card Transaction User Error Code The error code.
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- giftCardCredit (GiftCardCreditPayload)
- giftCardDebit (GiftCardDebitPayload)
- •mutation
Adds funds to an existing gift card, increasing its available balance. Use this when a merchant wants to top up a customer's gift card — for example, as a promotional bonus, a customer service gesture, or to reload a reusable gift card.
- •ID!required
The ID of the gift card to be credited.
- Anchor to creditInputcredit•Gift
Input Card Credit Input! required The input fields to credit a gift card.
Arguments
- •ID!
- •mutation
Removes funds from a gift card, decreasing its available balance. Use this for manual balance adjustments — for example, correcting an accidental over-credit or applying a fee.
- •ID!required
The ID of the gift card to be debited.
- Anchor to debitInputdebit•Gift
Input Card Debit Input! required The input fields to debit a gift card.
Arguments
- •ID!