POST Subscriber/{subscriberId}/Location/{locationId}/Carts/{cartId}/Checkout

Checkout a cart and initiate payment processing. GetCart must be used to check payment processing status.

Returns metadata about the order and account information that is pending finalization from this cart's processing. This data is only usable if the cart successfuly processes.

Request Information

URI Parameters

Name	Type	Additional information
subscriberId	string	None.
locationId	string	None.
cartId	string	None.

Body Parameters

SubscriberCheckoutRequest

Name	Type	Additional information
CashRegisterId	integer	None.
SalesRepId	integer	None.
CreditCardProcessingData	Dictionary of globally unique identifier [key] and SubscriberCreditCardProcessingData [value]	None.
NotificationCheckoutSettings	NotificationCheckoutSettings	None.
CheckoutSignature	string	None.
BypassHangingPaymentsValidationForContracts	boolean	None.
TransactionClientSource	string	None.
SecurePaymentMethodsIntendedForPermanentStorageAfterProcessing	Collection of SecurePaymentMethodReference	None.

Request Formats

application/json, text/json

Sample:

{
  "SecurePaymentMethodsIntendedForPermanentStorageAfterProcessing": [
    {
      "Token": "4db575e8-cd34-4d81-ba0f-d456bea14651",
      "Type": "sample string 2"
    },
    {
      "Token": "4db575e8-cd34-4d81-ba0f-d456bea14651",
      "Type": "sample string 2"
    }
  ],
  "CashRegisterId": 1,
  "SalesRepId": 1,
  "CreditCardProcessingData": {
    "a8e4e71a-c8cf-4484-840f-892b52f5b334": {
      "TrackData": "sample string 1",
      "TrackDataEncrypted": true,
      "CVV": "sample string 3"
    },
    "89679607-e57a-44b4-a8c2-adb75a8941e6": {
      "TrackData": "sample string 1",
      "TrackDataEncrypted": true,
      "CVV": "sample string 3"
    }
  },
  "NotificationCheckoutSettings": {
    "NotificationTypeSettings": {
      "PurchaseReceipt": {
        "EmailMode": "Default",
        "Email": "sample string 1",
        "SmsMode": "Default",
        "SmsPhoneNumber": "sample string 2"
      }
    }
  },
  "CheckoutSignature": "sample string 1",
  "BypassHangingPaymentsValidationForContracts": true,
  "TransactionClientSource": "sample string 3"
}

application/xml, text/xml

Sample:

<SubscriberCheckoutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Checkout">
  <BypassHangingPaymentsValidationForContracts>true</BypassHangingPaymentsValidationForContracts>
  <CashRegisterId>1</CashRegisterId>
  <CheckoutSignature>sample string 1</CheckoutSignature>
  <CreditCardProcessingData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfguidSubscriberCreditCardProcessingDatacbNtXzx_P>
      <d2p1:Key>a8e4e71a-c8cf-4484-840f-892b52f5b334</d2p1:Key>
      <d2p1:Value>
        <CVV>sample string 3</CVV>
        <TrackData>sample string 1</TrackData>
        <TrackDataEncrypted>true</TrackDataEncrypted>
      </d2p1:Value>
    </d2p1:KeyValueOfguidSubscriberCreditCardProcessingDatacbNtXzx_P>
    <d2p1:KeyValueOfguidSubscriberCreditCardProcessingDatacbNtXzx_P>
      <d2p1:Key>89679607-e57a-44b4-a8c2-adb75a8941e6</d2p1:Key>
      <d2p1:Value>
        <CVV>sample string 3</CVV>
        <TrackData>sample string 1</TrackData>
        <TrackDataEncrypted>true</TrackDataEncrypted>
      </d2p1:Value>
    </d2p1:KeyValueOfguidSubscriberCreditCardProcessingDatacbNtXzx_P>
  </CreditCardProcessingData>
  <NotificationCheckoutSettings>
    <NotificationTypeSettings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfEMarketplaceNotificationTypeNotificationConfigurationOverridesWlY_SjyZ8>
        <d3p1:Key>PurchaseReceipt</d3p1:Key>
        <d3p1:Value xmlns:d5p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Notifications">
          <d5p1:Email>sample string 1</d5p1:Email>
          <d5p1:EmailMode>Default</d5p1:EmailMode>
          <d5p1:SmsMode>Default</d5p1:SmsMode>
          <d5p1:SmsPhoneNumber>sample string 2</d5p1:SmsPhoneNumber>
        </d3p1:Value>
      </d3p1:KeyValueOfEMarketplaceNotificationTypeNotificationConfigurationOverridesWlY_SjyZ8>
    </NotificationTypeSettings>
  </NotificationCheckoutSettings>
  <SalesRepId>1</SalesRepId>
  <SecurePaymentMethodsIntendedForPermanentStorageAfterProcessing xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Payments">
    <d2p1:SecurePaymentMethodReference>
      <d2p1:Token>4db575e8-cd34-4d81-ba0f-d456bea14651</d2p1:Token>
      <d2p1:Type>sample string 2</d2p1:Type>
    </d2p1:SecurePaymentMethodReference>
    <d2p1:SecurePaymentMethodReference>
      <d2p1:Token>4db575e8-cd34-4d81-ba0f-d456bea14651</d2p1:Token>
      <d2p1:Type>sample string 2</d2p1:Type>
    </d2p1:SecurePaymentMethodReference>
  </SecurePaymentMethodsIntendedForPermanentStorageAfterProcessing>
  <TransactionClientSource>sample string 3</TransactionClientSource>
</SubscriberCheckoutRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The status of this method only pertains to acceptence into payment processing.
To check on the final status of the cart's processing, GetCart must be called and the cart's current state must be checked until it is either in Finalized or Failure states.

201: The cart was accepted for payment processing 400: The cart could not be validated for payment processing 401: User is not authorized to checkout the cart 403: User cannot access endpoint

SubscriberCheckoutResponse

Name	Type	Additional information
OrderId	integer	None.
CartPackageToAccountContract	Dictionary of globally unique identifier [key] and integer [value]	None.
CartServicePricingOptionToAccountServicePricingOptions	Dictionary of globally unique identifier [key] and Collection of integer [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderId": 1,
  "CartPackageToAccountContract": {
    "7f7244f8-19b8-471b-b313-9f5b6bfefa85": 2,
    "0e6a658e-155e-4f22-a6d6-06d59c2b8f82": 4
  },
  "CartServicePricingOptionToAccountServicePricingOptions": {
    "bc6c0d71-35aa-428d-9180-056908970815": [
      1,
      2
    ],
    "d95ed22f-8cb3-4efc-9045-5caf6ab97fb6": [
      1,
      2
    ]
  }
}

application/xml, text/xml

Sample:

<SubscriberCheckoutResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Responses">
  <CartPackageToAccountContract xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfguidint>
      <d2p1:Key>7f7244f8-19b8-471b-b313-9f5b6bfefa85</d2p1:Key>
      <d2p1:Value>2</d2p1:Value>
    </d2p1:KeyValueOfguidint>
    <d2p1:KeyValueOfguidint>
      <d2p1:Key>0e6a658e-155e-4f22-a6d6-06d59c2b8f82</d2p1:Key>
      <d2p1:Value>4</d2p1:Value>
    </d2p1:KeyValueOfguidint>
  </CartPackageToAccountContract>
  <CartServicePricingOptionToAccountServicePricingOptions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfguidArrayOflongox8ieOcg>
      <d2p1:Key>bc6c0d71-35aa-428d-9180-056908970815</d2p1:Key>
      <d2p1:Value>
        <d2p1:long>1</d2p1:long>
        <d2p1:long>2</d2p1:long>
      </d2p1:Value>
    </d2p1:KeyValueOfguidArrayOflongox8ieOcg>
    <d2p1:KeyValueOfguidArrayOflongox8ieOcg>
      <d2p1:Key>d95ed22f-8cb3-4efc-9045-5caf6ab97fb6</d2p1:Key>
      <d2p1:Value>
        <d2p1:long>1</d2p1:long>
        <d2p1:long>2</d2p1:long>
      </d2p1:Value>
    </d2p1:KeyValueOfguidArrayOflongox8ieOcg>
  </CartServicePricingOptionToAccountServicePricingOptions>
  <OrderId>1</OrderId>
</SubscriberCheckoutResponse>