Mindbody · Schema

PurchaseGiftCardResponse

Implementation of the 'PurchaseGiftCardResponse' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
BarcodeId	string	The barcode ID assigned to the purchased gift card.
Value	number	The monetary value of the gift card.
AmountPaid	number	The amount paid for the gift card by the purchaser.
FromName	string	The name of the purchaser.
LayoutId	integer	The ID of the layout used for this gift card.
EmailReceipt	boolean	Whether or not an email receipt was sent to the purchaser. If true, a receipt was sent.
PurchaserClientId	string	The client ID of the purchaser.
PurchaserEmail	string	The purchaser’s email address.
RecipientEmail	string	The recipient’s email address.
SaleId	integer	The sale ID of the gift card.
PaymentProcessingFailures	array	Any cart processing failures, for example when SCA challenged, the cart is in PaymentAuthenticationRequired state and at least one of the failures listed will provide an authentication Url.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-schema/public-api-v6-purchase-gift-card-response-schema.json",
  "title": "PurchaseGiftCardResponse",
  "description": "Implementation of the 'PurchaseGiftCardResponse' model.",
  "type": "object",
  "properties": {
    "BarcodeId": {
      "type": "string",
      "description": "The barcode ID assigned to the purchased gift card.",
      "example": "example-value"
    },
    "Value": {
      "type": "number",
      "format": "double",
      "description": "The monetary value of the gift card.",
      "example": 1.0
    },
    "AmountPaid": {
      "type": "number",
      "format": "double",
      "description": "The amount paid for the gift card by the purchaser.",
      "example": 49.99
    },
    "FromName": {
      "type": "string",
      "description": "The name of the purchaser.",
      "example": "example-value"
    },
    "LayoutId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the layout used for this gift card.",
      "example": 123456
    },
    "EmailReceipt": {
      "type": "boolean",
      "description": "Whether or not an email receipt was sent to the purchaser. If true, a receipt was sent.",
      "example": true
    },
    "PurchaserClientId": {
      "type": "string",
      "description": "The client ID of the purchaser.",
      "example": "example-value"
    },
    "PurchaserEmail": {
      "type": "string",
      "description": "The purchaser\u2019s email address.",
      "example": "[email protected]"
    },
    "RecipientEmail": {
      "type": "string",
      "description": "The recipient\u2019s email address.",
      "example": "[email protected]"
    },
    "SaleId": {
      "type": "integer",
      "format": "int32",
      "description": "The sale ID of the gift card.",
      "example": 123456
    },
    "PaymentProcessingFailures": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PaymentProcessingFailure"
      },
      "description": "Any cart processing failures, for example when SCA challenged, the cart is in PaymentAuthenticationRequired state and at least one of the failures listed will provide an authentication Url.",
      "example": [
        {}
      ]
    }
  }
}