Skip to main content
POST
Create a payment method

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Headers

Idempotency-Key
string

Retry-safe key; a repeat of the same request replays the first response

Maximum string length: 255

Body

application/json

Fields accepted when creating a payment method. Unknown fields are rejected.

name
string
required

What staff and members see, e.g. "Bank transfer"

Required string length: 1 - 100
code
string

Lower-case letters, digits and underscores. Derived from the name when omitted on create. Must be free within the organization.

Maximum string length: 50
Pattern: ^[a-z0-9_]+$
visibility
enum<string>

Who may choose it. Defaults to Private (staff only) on create.

Available options:
Private,
Member_only,
Public

Response

Payment method created

One of the organization's own payment methods - a tender staff record by hand, such as cash or a bank transfer.

id
integer
name
string
code
string

How reports and imports name the method. Unique within the organization.

visibility
enum<string>

Private: staff only (the till, check-in). Member_only and Public: also offered to members paying for a booking.

Available options:
Private,
Member_only,
Public