Mindbody · Schema

PurchaseAccountCreditResponse

Implementation of the 'PurchaseAccountCreditResponse' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name Type Description
AmountPaid number The amount paid for the gift card by the purchaser.
ClientId string The client ID of the purchaser.
SaleId integer The sale ID of the gift card.
EmailReceipt boolean Whether or not an email receipt was sent to the purchaser. If true, a receipt was sent.
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

public-api-v6-purchase-account-credit-response-schema.json Raw ↑
{
  "$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-account-credit-response-schema.json",
  "title": "PurchaseAccountCreditResponse",
  "description": "Implementation of the 'PurchaseAccountCreditResponse' model.",
  "type": "object",
  "properties": {
    "AmountPaid": {
      "type": "number",
      "format": "double",
      "description": "The amount paid for the gift card by the purchaser.",
      "example": 49.99
    },
    "ClientId": {
      "type": "string",
      "description": "The client ID of the purchaser.",
      "example": "example-value"
    },
    "SaleId": {
      "type": "integer",
      "format": "int32",
      "description": "The sale ID of the 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
    },
    "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": [
        {}
      ]
    }
  }
}