Mindbody · Schema

CompleteCheckoutShoppingCartUsingAlternativePaymentsRequest

Implementation of the 'CompleteCheckoutShoppingCartUsingAlternativePaymentsRequest' model. The API Request model for Complete Checkout Shopping Cart API.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name Type Description
AccessToken string The Access Token generated during Pre-Payment step.
ClientId string The RSSID of the client making the purchase. A cart can be validated without a client ID, but a client ID must be specified to complete a sale.
Test boolean When `true`, indicates that the contents of the cart are validated, but the transaction does not take place. You should use this parameter during testing and when checking the calculated totals of the
View JSON Schema on GitHub

JSON Schema

public-api-v6-complete-checkout-shopping-cart-using-alternative-payments-request-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-complete-checkout-shopping-cart-using-alternative-payments-request-schema.json",
  "title": "CompleteCheckoutShoppingCartUsingAlternativePaymentsRequest",
  "description": "Implementation of the 'CompleteCheckoutShoppingCartUsingAlternativePaymentsRequest' model. The API Request model for Complete Checkout Shopping Cart API.",
  "type": "object",
  "properties": {
    "AccessToken": {
      "type": "string",
      "description": "The Access Token generated during Pre-Payment step.",
      "example": "example-value"
    },
    "ClientId": {
      "type": "string",
      "description": "The RSSID of the client making the purchase. A cart can be validated without a client ID, but a client ID must be specified to complete a sale.",
      "example": "example-value"
    },
    "Test": {
      "type": "boolean",
      "description": "When `true`, indicates that the contents of the cart are validated, but the transaction does not take place. You should use this parameter during testing and when checking the calculated totals of the items in the cart.<br /> When `false`, the transaction takes place and the database is affected.<br /> Default: **false**",
      "example": true
    }
  }
}