Skip to main content

BatchRevokeUnusedGiftCardsRequest

cards object[]required

At most 1000 same-organization cards in the requested original-sale currency are revoked atomically only if active with matching original/current balances and no redemption ever. Exact batch replay returns the revoked cards; larger whole operations are unsupported.

Possible values: >= 1, <= 1000

  • Array [
    • expectedUnusedBalanceCentsinteger<int64>required

    Possible values: >= 1

    giftCardIdstringrequired

    Possible values: <= 64 characters, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$

  • ]
    • currencystringrequired

    ISO uppercase three-letter currency of the original sale; every card must match, including on replay.

    Possible values: non-empty, Value must match regular expression ^[A-Z]{3}$

    idempotencyKeystringrequired

    Possible values: <= 128 characters

    reasonstringrequired

    Possible values: <= 500 characters

    BatchRevokeUnusedGiftCardsRequest
    {
      "cards": [
        {
          "expectedUnusedBalanceCents": 0,
          "giftCardId": "string"
        }
      ],
      "currency": "string",
      "idempotencyKey": "string",
      "reason": "string"
    }