List your marketing campaigns
Selected free inclusive rate bundle modules.
[Optional] Should only be set if checkout page has been called with URL param identityToken. If no customer exists with this UUID a new one will be created.
User will be assigned as UNISEX if no gender is set.
If only one number is available use mobile as default.
If only one number is available use mobile as default.
language of customer as ISO 639-1 two-letter code (e.g. es or de)
locale of customer as ISO 639-1 two-letter language and country code (e.g. es_ES or de_DE)
Only configured values in the rate bundle allowed. For Contract Voucher redemption use CASH
Required in combination with paymentChoice DIRECT_DEBIT
Required in combination with paymentChoice CREDIT_CARD
Data privacy configuration for marketing purposes. Deprecated. Use communicationPreferences instead.
Communication preferences for the customer. If specified, the list must contain an element for each message category.
Deprecated. Use the identityNumber field.
Required for italian studios and none-italian nationals
information from an official document with identifies the customer
curl -i -X POST \
'https://redocly.sportalliance.com/_mock/apis/magicline/connectapi/connectapi/connect/v2/preview?checkoutPageConfigurationId=0&landingPageConfigurationId=0' \
-H 'Content-Type: application/json' \
-d '{
"studioId": 0,
"contract": {
"rateBundleTermId": 0,
"startDate": "2019-08-24",
"preuseDate": "2019-08-24",
"notes": "string",
"contractSignature": {
"base64Svg": "string",
"textBlockId": 0
},
"sepaSignature": {
"base64Svg": "string",
"textBlockId": 0
},
"textBlockSignatures": [
{
"base64Svg": "string",
"textBlockId": 0
}
],
"selectedRateBundleModules": [
{
"id": 0
}
],
"optionalRateBundleTermModules": [
{
"id": 0
}
]
},
"customer": {
"identityToken": "2340b1cc-3fe7-4f81-8eca-f92181dd2bb4",
"firstname": "string",
"secondFirstname": "string",
"lastname": "string",
"secondLastName": "string",
"dateOfBirth": "2019-08-24",
"email": "string",
"gender": "MALE",
"telephone_private": "string",
"telephone_mobile": "string",
"street": "Raboisen",
"secondStreet": "string",
"cityPart": "string",
"district": "string",
"streetType": "string",
"streetBlock": "string",
"portal": "string",
"stairway": "string",
"door": "string",
"province": "string",
"additionalAddressInformation": "string",
"floor": "string",
"language": "string",
"locale": "string",
"houseNumber": "3-4",
"buildingName": "string",
"city": "Hamburg",
"zipCode": "22099",
"countryCode": "DE",
"paymentChoice": "DIRECT_DEBIT",
"bankAccount": {
"iban": "string",
"bic": "string",
"accountHolder": "string"
},
"creditCard": {
"tokenizationReference": "string",
"accountPaymentInstrumentToken": "string"
},
"privacyConfiguration": {
"letter": true,
"email": true,
"textMessage": true,
"phone": true,
"mySportsMessage": true
},
"communicationPreferences": [
{
"messageCategoryId": 0,
"activeCommunicationChannels": [
"LETTER"
]
}
],
"identification": {
"spain_DNI_NIE": "string"
},
"taxId": "string",
"placeOfBirth": "string",
"countryOfBirth": "UNDEFINED",
"documentIdentification": {
"documentNumber": "string",
"documentType": "ID_CARD"
},
"imageObjectKey": "string",
"referralCode": "string",
"publicGender": "MALE",
"studioCountryCode": "UNDEFINED"
},
"landingPageConfigurationId": 0,
"voucherCode": "string",
"offerUuid": "5d19bb70-d72b-45ae-9b5e-c4257877bdbb"
}'OK
Type of a voucher, if a valid voucher code is provided
Effective period type in which a discount is applied
Effective period: term in which a discount is applied if type is time base
Effective period: term unit in which a discount is applied if type is time base
Type of discount (percentage or absolute), if valid a (company) discount voucher is provided
Discounted pre use charge, if a valid (company) discount voucher is provided
Type of company fee split (percentage or absolute), if valid a company discount voucher is provided
Bonus period applied with the (company) discount voucher, if valid a (company) discount voucher is provided
Voucher related text blocks, if a valid voucher is provided
Flat fee previews, including discount if a valid discount voucher is provided
Textual representation of the voucher conditions, if a valid voucher is provided
An error code, if the voucher code is invalid
The adjusted price, if age-based discounts are configured and the customer is eligible, null otherwise
Contains the total amount to be paid during the initial runtime of the contract and the average amounts per month and per the rate's payment frequency (e.g. 1 week)
Selected free inclusive rate bundle modules.
[Optional] Should only be set if checkout page has been called with URL param identityToken. If no customer exists with this UUID a new one will be created.
User will be assigned as UNISEX if no gender is set.
If only one number is available use mobile as default.
If only one number is available use mobile as default.
language of customer as ISO 639-1 two-letter code (e.g. es or de)
locale of customer as ISO 639-1 two-letter language and country code (e.g. es_ES or de_DE)
Only configured values in the rate bundle allowed. For Contract Voucher redemption use CASH
Required in combination with paymentChoice DIRECT_DEBIT
Required in combination with paymentChoice CREDIT_CARD
Data privacy configuration for marketing purposes. Deprecated. Use communicationPreferences instead.
Communication preferences for the customer. If specified, the list must contain an element for each message category.
Deprecated. Use the identityNumber field.
Required for italian studios and none-italian nationals
information from an official document with identifies the customer
curl -i -X POST \
'https://redocly.sportalliance.com/_mock/apis/magicline/connectapi/connectapi/connect/v1/preview?checkoutPageConfigurationId=0&landingPageConfigurationId=0' \
-H 'Content-Type: application/json' \
-d '{
"studioId": 0,
"contract": {
"rateBundleTermId": 0,
"startDate": "2019-08-24",
"preuseDate": "2019-08-24",
"notes": "string",
"contractSignature": {
"base64Svg": "string",
"textBlockId": 0
},
"sepaSignature": {
"base64Svg": "string",
"textBlockId": 0
},
"textBlockSignatures": [
{
"base64Svg": "string",
"textBlockId": 0
}
],
"selectedRateBundleModules": [
{
"id": 0
}
],
"optionalRateBundleTermModules": [
{
"id": 0
}
]
},
"customer": {
"identityToken": "2340b1cc-3fe7-4f81-8eca-f92181dd2bb4",
"firstname": "string",
"secondFirstname": "string",
"lastname": "string",
"secondLastName": "string",
"dateOfBirth": "2019-08-24",
"email": "string",
"gender": "MALE",
"telephone_private": "string",
"telephone_mobile": "string",
"street": "Raboisen",
"secondStreet": "string",
"cityPart": "string",
"district": "string",
"streetType": "string",
"streetBlock": "string",
"portal": "string",
"stairway": "string",
"door": "string",
"province": "string",
"additionalAddressInformation": "string",
"floor": "string",
"language": "string",
"locale": "string",
"houseNumber": "3-4",
"buildingName": "string",
"city": "Hamburg",
"zipCode": "22099",
"countryCode": "DE",
"paymentChoice": "DIRECT_DEBIT",
"bankAccount": {
"iban": "string",
"bic": "string",
"accountHolder": "string"
},
"creditCard": {
"tokenizationReference": "string",
"accountPaymentInstrumentToken": "string"
},
"privacyConfiguration": {
"letter": true,
"email": true,
"textMessage": true,
"phone": true,
"mySportsMessage": true
},
"communicationPreferences": [
{
"messageCategoryId": 0,
"activeCommunicationChannels": [
"LETTER"
]
}
],
"identification": {
"spain_DNI_NIE": "string"
},
"taxId": "string",
"placeOfBirth": "string",
"countryOfBirth": "UNDEFINED",
"documentIdentification": {
"documentNumber": "string",
"documentType": "ID_CARD"
},
"imageObjectKey": "string",
"referralCode": "string",
"publicGender": "MALE",
"studioCountryCode": "UNDEFINED"
},
"landingPageConfigurationId": 0,
"voucherCode": "string",
"offerUuid": "5d19bb70-d72b-45ae-9b5e-c4257877bdbb"
}'OK
Type of a voucher, if a valid voucher code is provided
Effective period type in which a discount is applied
Effective period: term in which a discount is applied if type is time base
Effective period: term unit in which a discount is applied if type is time base
Type of discount (percentage or absolute), if valid a (company) discount voucher is provided
Discounted pre use charge, if a valid (company) discount voucher is provided
Type of company fee split (percentage or absolute), if valid a company discount voucher is provided
Bonus period applied with the (company) discount voucher, if valid a (company) discount voucher is provided
Voucher related text blocks, if a valid voucher is provided
Flat fee previews, including discount if a valid discount voucher is provided
Textual representation of the voucher conditions, if a valid voucher is provided
An error code, if the voucher code is invalid
The adjusted price, if age-based discounts are configured and the customer is eligible, null otherwise
Contains the total amount to be paid during the initial runtime of the contract and the average amounts per month and per the rate's payment frequency (e.g. 1 week)