Skip to main content
POST
Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.
Cards/{id}/charge`.

Path parameters

string
required
Gift card ID (UUID)

Request body

GiftCardAmountRequest
string
required
Amount to charge (debit) or refund (credit). Must be positive.
string,null
Optional reference (e.g. order ID) recorded on the transaction.

Response

GiftCardTransactionResponse
string
required
string
required
string (date-time)
required
string
required
string
required
string,null
string
required

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on September 21, 2026