Refund a Gift Card by Code

Credits balance back onto a gift card code without referencing a specific redeem transaction. Use this for top-ups or partial refunds when you only have the code.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Behavior

  • Credits the code’s balance (internal ledger or Shopify, depending on balance_source)
  • Creates a refund gift card transaction
  • Caps the resulting balance at the code’s maximum (per-code ceiling; never above that max)
  • Does not reverse a specific prior redeem — for that, use POST /api/v1/gift-card/transaction/{transactionId}/refund

Example

{
  "amount": 1500,
  "note": "Partial return"
}

Path Params
string
required
Body Params
integer

Optional refund amount in cents. When omitted, the code is topped up by the remaining headroom to its maximum balance. When set, must be greater than zero and must not push the balance above the code’s maximum. Exceeding the maximum returns error 12010.

string

Optional note stored on the refund transaction.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json