POST Subscriber/{subscriberId}/Location/{locationId}/Order/{orderId}/Tips
Adds post auth tips to an order's credit card payments. Order must not be voided or refunded. Staff members receiving tips must be configured to do so. Tip amounts must be greater than 0. Payment transactions must not already be settled. A settled payment transaction cannot be modified. PaymentMethods must be the same PaymentMethod that was used in the original order creation.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
orderId |
The order to add tips to |
integer |
Required |
subscriberId | string |
None. |
|
locationId | string |
None. |
Body Parameters
Tips to add
Collection of AddTipToOrderRequestName | Description | Type | Additional information |
---|---|---|---|
Amount | decimal number |
None. |
|
StaffId | integer |
None. |
|
PaymentMethod | PaymentMethod |
None. |
Request Formats
application/json, text/json
Sample:
[ { "Amount": 1.0, "StaffId": 2, "PaymentMethod": { "Name": "sample string 1", "Description": "sample string 2", "Type": "sample string 3", "PaymentMethodTypeId": 4, "Templates": [ { "Name": "sample string 1", "TemplateType": "sample string 2", "Metadata": [ { "Key": "sample string 1", "Value": "sample string 2", "Type": "sample string 3", "Label": "sample string 4", "Rules": [ { "Rule": "sample string 1", "Value": "sample string 2" }, { "Rule": "sample string 1", "Value": "sample string 2" } ] }, { "Key": "sample string 1", "Value": "sample string 2", "Type": "sample string 3", "Label": "sample string 4", "Rules": [ { "Rule": "sample string 1", "Value": "sample string 2" }, { "Rule": "sample string 1", "Value": "sample string 2" } ] } ] }, { "Name": "sample string 1", "TemplateType": "sample string 2", "Metadata": [ { "Key": "sample string 1", "Value": "sample string 2", "Type": "sample string 3", "Label": "sample string 4", "Rules": [ { "Rule": "sample string 1", "Value": "sample string 2" }, { "Rule": "sample string 1", "Value": "sample string 2" } ] }, { "Key": "sample string 1", "Value": "sample string 2", "Type": "sample string 3", "Label": "sample string 4", "Rules": [ { "Rule": "sample string 1", "Value": "sample string 2" }, { "Rule": "sample string 1", "Value": "sample string 2" } ] } ] } ], "Options": [ { "MetadataType": "sample string 1", "Items": [ { "Name": "sample string 1", "Value": "sample string 2", "Properties": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } }, { "Name": "sample string 1", "Value": "sample string 2", "Properties": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } } ] }, { "MetadataType": "sample string 1", "Items": [ { "Name": "sample string 1", "Value": "sample string 2", "Properties": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } }, { "Name": "sample string 1", "Value": "sample string 2", "Properties": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } } ] } ], "Rules": [ { "Rule": "sample string 1", "Values": [ "sample string 1", "sample string 2" ], "Key": "sample string 2", "Operation": "sample string 3" }, { "Rule": "sample string 1", "Values": [ "sample string 1", "sample string 2" ], "Key": "sample string 2", "Operation": "sample string 3" } ] } }, { "Amount": 1.0, "StaffId": 2, "PaymentMethod": { "Name": "sample string 1", "Description": "sample string 2", "Type": "sample string 3", "PaymentMethodTypeId": 4, "Templates": [ { "Name": "sample string 1", "TemplateType": "sample string 2", "Metadata": [ { "Key": "sample string 1", "Value": "sample string 2", "Type": "sample string 3", "Label": "sample string 4", "Rules": [ { "Rule": "sample string 1", "Value": "sample string 2" }, { "Rule": "sample string 1", "Value": "sample string 2" } ] }, { "Key": "sample string 1", "Value": "sample string 2", "Type": "sample string 3", "Label": "sample string 4", "Rules": [ { "Rule": "sample string 1", "Value": "sample string 2" }, { "Rule": "sample string 1", "Value": "sample string 2" } ] } ] }, { "Name": "sample string 1", "TemplateType": "sample string 2", "Metadata": [ { "Key": "sample string 1", "Value": "sample string 2", "Type": "sample string 3", "Label": "sample string 4", "Rules": [ { "Rule": "sample string 1", "Value": "sample string 2" }, { "Rule": "sample string 1", "Value": "sample string 2" } ] }, { "Key": "sample string 1", "Value": "sample string 2", "Type": "sample string 3", "Label": "sample string 4", "Rules": [ { "Rule": "sample string 1", "Value": "sample string 2" }, { "Rule": "sample string 1", "Value": "sample string 2" } ] } ] } ], "Options": [ { "MetadataType": "sample string 1", "Items": [ { "Name": "sample string 1", "Value": "sample string 2", "Properties": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } }, { "Name": "sample string 1", "Value": "sample string 2", "Properties": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } } ] }, { "MetadataType": "sample string 1", "Items": [ { "Name": "sample string 1", "Value": "sample string 2", "Properties": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } }, { "Name": "sample string 1", "Value": "sample string 2", "Properties": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } } ] } ], "Rules": [ { "Rule": "sample string 1", "Values": [ "sample string 1", "sample string 2" ], "Key": "sample string 2", "Operation": "sample string 3" }, { "Rule": "sample string 1", "Values": [ "sample string 1", "sample string 2" ], "Key": "sample string 2", "Operation": "sample string 3" } ] } } ]
application/xml, text/xml
Sample:
<ArrayOfAddTipToOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Requests"> <AddTipToOrderRequest> <Amount>1</Amount> <PaymentMethod xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Payments"> <d3p1:Description>sample string 2</d3p1:Description> <d3p1:Name>sample string 1</d3p1:Name> <d3p1:Options xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Catalog.Item"> <d4p1:ItemOption> <d4p1:Items> <d4p1:ItemOptionItem> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Properties xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 1</d8p1:Key> <d8p1:Value>sample string 2</d8p1:Value> </d8p1:KeyValueOfstringstring> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 3</d8p1:Key> <d8p1:Value>sample string 4</d8p1:Value> </d8p1:KeyValueOfstringstring> </d4p1:Properties> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemOptionItem> <d4p1:ItemOptionItem> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Properties xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 1</d8p1:Key> <d8p1:Value>sample string 2</d8p1:Value> </d8p1:KeyValueOfstringstring> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 3</d8p1:Key> <d8p1:Value>sample string 4</d8p1:Value> </d8p1:KeyValueOfstringstring> </d4p1:Properties> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemOptionItem> </d4p1:Items> <d4p1:MetadataType>sample string 1</d4p1:MetadataType> </d4p1:ItemOption> <d4p1:ItemOption> <d4p1:Items> <d4p1:ItemOptionItem> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Properties xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 1</d8p1:Key> <d8p1:Value>sample string 2</d8p1:Value> </d8p1:KeyValueOfstringstring> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 3</d8p1:Key> <d8p1:Value>sample string 4</d8p1:Value> </d8p1:KeyValueOfstringstring> </d4p1:Properties> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemOptionItem> <d4p1:ItemOptionItem> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Properties xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 1</d8p1:Key> <d8p1:Value>sample string 2</d8p1:Value> </d8p1:KeyValueOfstringstring> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 3</d8p1:Key> <d8p1:Value>sample string 4</d8p1:Value> </d8p1:KeyValueOfstringstring> </d4p1:Properties> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemOptionItem> </d4p1:Items> <d4p1:MetadataType>sample string 1</d4p1:MetadataType> </d4p1:ItemOption> </d3p1:Options> <d3p1:PaymentMethodTypeId>4</d3p1:PaymentMethodTypeId> <d3p1:Rules xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Catalog.Item"> <d4p1:ItemRule> <d4p1:Key>sample string 2</d4p1:Key> <d4p1:Operation>sample string 3</d4p1:Operation> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </d4p1:Values> </d4p1:ItemRule> <d4p1:ItemRule> <d4p1:Key>sample string 2</d4p1:Key> <d4p1:Operation>sample string 3</d4p1:Operation> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </d4p1:Values> </d4p1:ItemRule> </d3p1:Rules> <d3p1:Templates xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Catalog.Item.Metadata"> <d4p1:ItemMetadataTemplate> <d4p1:Metadata> <d4p1:ItemMetadata> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Label>sample string 4</d4p1:Label> <d4p1:Rules> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> </d4p1:Rules> <d4p1:Type>sample string 3</d4p1:Type> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadata> <d4p1:ItemMetadata> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Label>sample string 4</d4p1:Label> <d4p1:Rules> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> </d4p1:Rules> <d4p1:Type>sample string 3</d4p1:Type> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadata> </d4p1:Metadata> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:TemplateType>sample string 2</d4p1:TemplateType> </d4p1:ItemMetadataTemplate> <d4p1:ItemMetadataTemplate> <d4p1:Metadata> <d4p1:ItemMetadata> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Label>sample string 4</d4p1:Label> <d4p1:Rules> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> </d4p1:Rules> <d4p1:Type>sample string 3</d4p1:Type> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadata> <d4p1:ItemMetadata> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Label>sample string 4</d4p1:Label> <d4p1:Rules> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> </d4p1:Rules> <d4p1:Type>sample string 3</d4p1:Type> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadata> </d4p1:Metadata> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:TemplateType>sample string 2</d4p1:TemplateType> </d4p1:ItemMetadataTemplate> </d3p1:Templates> <d3p1:Type>sample string 3</d3p1:Type> </PaymentMethod> <StaffId>2</StaffId> </AddTipToOrderRequest> <AddTipToOrderRequest> <Amount>1</Amount> <PaymentMethod xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Payments"> <d3p1:Description>sample string 2</d3p1:Description> <d3p1:Name>sample string 1</d3p1:Name> <d3p1:Options xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Catalog.Item"> <d4p1:ItemOption> <d4p1:Items> <d4p1:ItemOptionItem> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Properties xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 1</d8p1:Key> <d8p1:Value>sample string 2</d8p1:Value> </d8p1:KeyValueOfstringstring> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 3</d8p1:Key> <d8p1:Value>sample string 4</d8p1:Value> </d8p1:KeyValueOfstringstring> </d4p1:Properties> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemOptionItem> <d4p1:ItemOptionItem> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Properties xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 1</d8p1:Key> <d8p1:Value>sample string 2</d8p1:Value> </d8p1:KeyValueOfstringstring> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 3</d8p1:Key> <d8p1:Value>sample string 4</d8p1:Value> </d8p1:KeyValueOfstringstring> </d4p1:Properties> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemOptionItem> </d4p1:Items> <d4p1:MetadataType>sample string 1</d4p1:MetadataType> </d4p1:ItemOption> <d4p1:ItemOption> <d4p1:Items> <d4p1:ItemOptionItem> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Properties xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 1</d8p1:Key> <d8p1:Value>sample string 2</d8p1:Value> </d8p1:KeyValueOfstringstring> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 3</d8p1:Key> <d8p1:Value>sample string 4</d8p1:Value> </d8p1:KeyValueOfstringstring> </d4p1:Properties> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemOptionItem> <d4p1:ItemOptionItem> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Properties xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 1</d8p1:Key> <d8p1:Value>sample string 2</d8p1:Value> </d8p1:KeyValueOfstringstring> <d8p1:KeyValueOfstringstring> <d8p1:Key>sample string 3</d8p1:Key> <d8p1:Value>sample string 4</d8p1:Value> </d8p1:KeyValueOfstringstring> </d4p1:Properties> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemOptionItem> </d4p1:Items> <d4p1:MetadataType>sample string 1</d4p1:MetadataType> </d4p1:ItemOption> </d3p1:Options> <d3p1:PaymentMethodTypeId>4</d3p1:PaymentMethodTypeId> <d3p1:Rules xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Catalog.Item"> <d4p1:ItemRule> <d4p1:Key>sample string 2</d4p1:Key> <d4p1:Operation>sample string 3</d4p1:Operation> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </d4p1:Values> </d4p1:ItemRule> <d4p1:ItemRule> <d4p1:Key>sample string 2</d4p1:Key> <d4p1:Operation>sample string 3</d4p1:Operation> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </d4p1:Values> </d4p1:ItemRule> </d3p1:Rules> <d3p1:Templates xmlns:d4p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Catalog.Item.Metadata"> <d4p1:ItemMetadataTemplate> <d4p1:Metadata> <d4p1:ItemMetadata> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Label>sample string 4</d4p1:Label> <d4p1:Rules> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> </d4p1:Rules> <d4p1:Type>sample string 3</d4p1:Type> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadata> <d4p1:ItemMetadata> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Label>sample string 4</d4p1:Label> <d4p1:Rules> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> </d4p1:Rules> <d4p1:Type>sample string 3</d4p1:Type> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadata> </d4p1:Metadata> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:TemplateType>sample string 2</d4p1:TemplateType> </d4p1:ItemMetadataTemplate> <d4p1:ItemMetadataTemplate> <d4p1:Metadata> <d4p1:ItemMetadata> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Label>sample string 4</d4p1:Label> <d4p1:Rules> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> </d4p1:Rules> <d4p1:Type>sample string 3</d4p1:Type> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadata> <d4p1:ItemMetadata> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Label>sample string 4</d4p1:Label> <d4p1:Rules> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> <d4p1:ItemMetadataRule> <d4p1:Rule>sample string 1</d4p1:Rule> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadataRule> </d4p1:Rules> <d4p1:Type>sample string 3</d4p1:Type> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:ItemMetadata> </d4p1:Metadata> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:TemplateType>sample string 2</d4p1:TemplateType> </d4p1:ItemMetadataTemplate> </d3p1:Templates> <d3p1:Type>sample string 3</d3p1:Type> </PaymentMethod> <StaffId>2</StaffId> </AddTipToOrderRequest> </ArrayOfAddTipToOrderRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.