Appointment, bookable appointment and slots operations
Magicline API (1.19.3)
- Appointment, bookable appointment and slots operations
- Redeem checkin vouchers
- Class and slots operations
- Cross studio operations
- Get customers and contracts
- Retrieve customer accounting details
- Retrieve customer communication details
- Retrieve customer transaction details
- Get device information
- Employee operations
- Debt collection operations
- Leads operations
- Get member lists
- Manage membership contracts
- Membership operations
- Online offer operations
- Payment operations
- Get studio information
- Get trial offers information
Download OpenAPI description
Languages
Servers
Demo tenant
https://open-api-demo.open-api.magicline.com/
Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/openapi/openapi/
Bodyapplication/jsonrequired
Specifies the payment amount for the initiated transaction. Should equal 0 to capture a payment instrument for future recurring payments. The currency is defined by the studio.
Example: 19.99
Specifies where the created payment instruments will be used, as the available payment methods differ by scope.
| Enum Value | Description |
|---|---|
| MEMBER_ACCOUNT | Use when initiating a payment user session to collect a payment instrument intended for future payment runs (e.g., BACS, credit card). |
| ECOM | Use when the user is making a purchase or when the payment instrument will be used for future user-initiated payments (e.g., saving a credit card for later purchases). |
Example: "MEMBER_ACCOUNT"
This field represents the unique identifier for an existing customer within ERP. Providing this ID ensures the payment session is linked to the correct customer record. It is a mutually exclusive field with finionPayCustomerId, meaning you can only provide one or the other.
Conditions for use: This ID is required for payment sessions involving existing customers.
Behavior when omitted: If this field is left empty, a new customer will be treated as a “potential customer” and a
finionPayCustomerIdwill be automatically generated and returned in the response. If omitted, it will not be possible to use it for existing customers.Mutually exclusive with:
finionPayCustomerId
Example: 1234567890
This field is the identifier for a customer within the Finion Pay payment service, typically used for customers who are not yet registered in ERP. Use this ID to track repeat payment sessions for a potential customer.
Conditions for use: This ID should only be provided for subsequent payment sessions for a customer who has been previously identified by Finion Pay but doesn’t have an ERP
customerIdyet.Behavior when omitted: In the absence of a
customerId, a newfinionPayCustomerIdwill be automatically created and assigned to the user for the current session.Mutually exclusive with:
customerId
Example: "753ea8ec-c2ec-4761-824b-bc46eda3f644"
List of permitted payment choices, i.e. obtained by the contract offer. Acts as a filter for the available payment methods defined by the scope
| Items Enum Value | Description |
|---|---|
| TWINT | Payment by Twint |
| SEPA | Payment by SEPA direct debit |
| ACH | Payment by ACH direct debit |
| CH_DD | Payment by CH_DD direct debit |
| CASH | Payment by cash |
| BECS | Payment by BECS direct debit |
| CREDIT_CARD | Payment by credit card |
| LSV | Payment by LSV direct debit |
| BACS | Payment by BACS direct debit |
| IDEAL | Payment by ideal |
Example: ["CASH"]
Allows the definition of the reference text shown on the bank statement of the customer.
Example: "Gym Joining Fee 01.07.2025"
When set to true the direct debit form will show a signature field to the user that is required to proceed. This applies to the payment methods SEPA, CH_DD and LSV.
Example: false
When set to true the UPC component will also fetch the user's existing payment instruments. Default is true
Example: true
This field allows saving the payment instrument for future recurring use. true => saving is allowed; false => do not save. For MEMBER_ACCOUNT scope, false is rejected with 400.
Conditions for use: Ignored for payment methods that only support one-time online payments.
Behavior when omitted: omitted/null => save (default).
Example: true
- Demo tenant
https://open-api-demo.open-api.magicline.com/v1/payments/user-session
- Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/openapi/openapi/v1/payments/user-session
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://open-api-demo.open-api.magicline.com/v1/payments/user-session \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-d '{
"amount": 19.99,
"scope": "MEMBER_ACCOUNT",
"customerId": 1234567890,
"finionPayCustomerId": "753ea8ec-c2ec-4761-824b-bc46eda3f644",
"permittedPaymentChoices": [
"CASH"
],
"referenceText": "Gym Joining Fee 01.07.2025",
"requireDirectDebitSignature": false,
"showExistingPaymentInstruments": true,
"savePaymentInstrument": true
}'OK
The token for the user session.
Example: "CllClFmVlSCs3oe0ND0JloLWlNzdb3QseU4507gf1mSVAHqRTwzKWU"
The date and time until the token is valid.
Example: "2025-01-07T16:25:09.416924+01:00"
Identifies a customer in Finion Pay, i.e. to retrieve existing payment instruments.
Example: "753ea8ec-c2ec-4761-824b-bc46eda3f644"
Response
application/json
{ "token": "CllClFmVlSCs3oe0ND0JloLWlNzdb3QseU4507gf1mSVAHqRTwzKWU", "tokenValidUntil": "2025-01-07T16:25:09.416924+01:00", "finionPayCustomerId": "753ea8ec-c2ec-4761-824b-bc46eda3f644", "finionPayRegion": "eu-central-1" }