API explorerChangelog

Theme switcher

Register a payment made on the terminal

Header Parameters

Api-Keystring

Body Parameters

customerUidstring Required

Value returned by /terminal/invoiceData.

providerIdstring Required

Terminal provider identifier. Accepted and ignored.

gymIdstring Required

Club the terminal stands in (organization uuid or id).

transactionIdstring Required

Terminal transaction identifier. Used as the idempotency key — repeating a request with the same value does not duplicate the payment.

paymentDataarray Required
Min items
1

Show child attributes

Response

200
Object

Payment registered (or already registered earlier).

Response Attributes

resultstring Required
Enum values:
ok
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.

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot