LuckyFit Public Integration API

Identify a client and return the list of debts to pay

Step 1 of the self-service payment terminal flow. The client authenticates on the terminal with a MiFare card or a QR code from the mobile app; customerId carries whatever the reader produced.

Lookup cascade for customerId:

mobile app QR / barcode (ID:<id> or <id>|<ts>|<guest>);
exact match on the card code fitness_clients.tag;
fitness_clients.access_pin;
single-use mobile app PIN (fitness_client_pins, TTL 2 minutes).

The returned invoiceData contains only positions with a debt greater than zero:

invoiceType	Source	invoiceId
`membership`	membership debt (`fitness_client_tickets`)	`account_summ_id`
`personal`	personal training / object reserve (`fitness_reserves`)	`fitness_orders.account_id`
`group`	group class booking (`fitness_lesson_calendar_bookings`)	`fitness_orders.account_id`
`invoice`	any other unpaid bill (`fitness_orders`)	`fitness_orders.account_id`

Membership fee debt and a negative deposit balance are intentionally not exposed.

Header Parameters

Api-Keystring

Body Parameters

customerIdstring Required

Card code (fitness_clients.tag), access PIN, mobile app QR / barcode or single-use mobile app PIN.

providerIdstring Required

Terminal provider identifier. Accepted and ignored.

gymIdstring Required

Club the terminal stands in: platform_organizations.uuid or the numeric branch id. Must be visible to the Api-Key.

Response

200

Object

Identified client and the list of debts.

Response Attributes

customerUidstring Required

Opaque client identifier (the LuckyFit client id as a string). Must be echoed back in paymentData.

customerCodestring

Printed card number (cardnum), falling back to tag.

namestring Required

Surname, first name and patronymic.

DOBstring | null

Date of birth, YYYY-MM-DDT00:00:00.

taxNumberstring

Tax number (idcode).

payerPhonestring

Phone number (phone1).

passportDatastring

Passport as a single display string.

passportDetailsobject

Show child attributes

invoiceDataarray Required

Show child attributes

401

Object

Terminal protocol variant of 401: the Api-Key is missing or invalid.

Response Attributes

resultstring Required

Error code.

Enum values:

userNotIdentifiedgymNotFoundcustomerNotFoundinvoiceNotFoundbadRequestpaymentFailedinternalError

descriptionstring

Human readable error description.

403

Object

Terminal protocol variant of a business error (unknown gym, client, invoice, or a payment that could not be registered).

Response Attributes

resultstring Required

Error code.

Enum values:

userNotIdentifiedgymNotFoundcustomerNotFoundinvoiceNotFoundbadRequestpaymentFailedinternalError

descriptionstring

Human readable error description.

Sections

Identify a client and return the list of debts to pay

Header Parameters

Body Parameters

ResponseExpand all

Response Attributes

Response Attributes

Response Attributes

Response

Ask an AI

Code with AI

Response