Check gift card status

GET 
/gift-card/stripe/checkout/:checkout_id/

Check the status of a gift card checkout/payment and get the gift card details if payment is completed.

Request

Path Parameters

checkout_id stringrequired

The ID of the checkout to check

Responses

200

The current status of the checkout and gift card details if payment is completed.

application/json

Schema

Schema

checkout_id string

The ID of the checkout session

status string

Possible values: [pending, completed, expired, canceled]

The status of the payment

value float

The value of the gift card

currency string

The currency of the gift card

gift_card object

identification_code string

The public identifier of the gift card

value float

The value of the gift card

currency string

The currency of the gift card

active boolean

Whether the gift card is active

redeemed boolean

Whether the gift card has been redeemed

Example (from schema)

{
  "checkout_id": "string",
  "status": "pending",
  "value": 0,
  "currency": "string",
  "gift_card": {
    "identification_code": "string",
    "value": 0,
    "currency": "string",
    "active": true,
    "redeemed": true
  }
}

Example

{
  "checkout_id": "0c869910-3f24-48b7-b260-947303033943",
  "status": "completed",
  "value": 100.0,
  "currency": "USD",
  "gift_card": {
    "identification_code": "ID-JSBYPMSR",
    "value": 100.0,
    "currency": "USD",
    "active": true,
    "redeemed": false
  }
}

Loading...