Imposta provider, modalità test/live e credenziali (cifrate)

PUT

/api/admin/v1/establishments/{establishmentId}/payment-settings

curl --request PUT \
  --url https://example.com/api/admin/v1/establishments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/payment-settings \
  --header 'Content-Type: application/json' \
  --cookie arenile_session=<arenile_session> \
  --data '{ "provider": "example", "mode": "test", "stripe": { "publishable_key": "example", "secret_key": "example", "webhook_secret": "example", "embedded_mode": true } }'

• Stessa origine dell'istanza Arenile

Permesso payments.configure. Le chiavi sono cifrate con il key ring (ARENILE_SECRET_KEY, AES-256-GCM) prima di essere salvate; un campo segreto assente lascia invariato il valore salvato, una stringa vuota lo cancella. Audit senza valori segreti.

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

establishmentId

required

string format: uuid

Header Parameters

If-Match

string

<= 64 characters

ETag (versione) letto in precedenza: se non coincide la richiesta fallisce con 412 version_conflict. * equivale a “qualsiasi versione”. È accettata anche la forma debole W/"3" prodotta dai proxy che comprimono le risposte (ADR 0008).

X-CSRF-Token

string

Obbligatorio per le richieste autenticate via cookie che modificano dati: deve coincidere con il valore del cookie arenile_csrf.

Request Body^required

Media typeapplication/json

object

provider

required

string

/^[a-z][a-z0-9_-]{1,31}$/

mode

required

string

Allowed values: test live

stripe

object

publishable_key

string

<= 255 characters /^(pk_(test|live)_[A-Za-z0-9]+)?$/

secret_key

Assente = invariata; vuota = cancella. Mai restituita.

string

<= 255 characters

webhook_secret

Assente = invariato; vuoto = cancella. Mai restituito.

string

<= 255 characters

embedded_mode

boolean

Responses

200

Impostazioni aggiornate

Media typeapplication/json

object

provider

required

Provider attivo per la pagina pubblica (manual = nessun pagamento online).

string

available_providers

required

Array<string>

mode

required

string

Allowed values: test live

stripe

required

object

configured

required

Chiave segreta salvata.

boolean

publishable_key

string

secret_key_last4

string

webhook_secret_configured

required

boolean

embedded_mode

required

boolean

verified_at

string format: date-time

webhook_url

required

URL da configurare presso il provider: <base>/webhooks/payments/<provider>/<establishment_id>.

string

live_payments_blocked

required

Vero quando il provider attivo (non manual) è in modalità test e la modalità prova dello stabilimento (spec 15.4) è spenta: i clienti reali non possono pagare online (INV-88). Per sbloccare usa le chiavi live oppure accendi la modalità prova per provare il flusso.

boolean

version

required

Versione per la concorrenza ottimistica; coincide con l’ETag.

integer format: int64

>= 1

Example

{
  "mode": "test"
}

Headers

ETag

string

Versione della risorsa ("<version>"), da reinviare in If-Match.

400

Richiesta non valida

Media typeapplication/problem+json

Errore RFC 9457 (application/problem+json).

object

type

required

Slug stabile del tipo di errore. I client devono basarsi su questo valore, mai sul testo di title o detail.

string

Allowed values: bad_request validation_failed unauthorized invalid_credentials totp_required invalid_totp totp_enrolment_required totp_already_enabled forbidden csrf_failed not_found conflict method_not_allowed unsupported_media_type rate_limited idempotency_key_reused idempotency_in_progress internal_error spot_unavailable no_price policy_violation hold_expired version_conflict precondition_required spot_has_future_allocations not_implemented pool_exhausted quota_exceeded invalid_transition cash_session_closed cash_session_already_open booking_outside_period checkout_not_found payment_provider_unavailable webhook_signature_invalid pairing_code_invalid lan_mode_required loopback_required setup_token_invalid setup_completed renewal_expired waitlist_offer_expired waitlist_disabled credit_insufficient season_rollover_conflict test_mode_preview_required import_invalid import_already_applied refund_in_progress zone_full assignment_conflict ticket_number_conflict ticket_voided ticket_already_entered price_changed ticket_owned printing_unavailable printer_address_not_allowed print_route_missing payment_provider_test_mode email_template_invalid

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

retry_after

Secondi da attendere (solo per rate_limited).

integer

errors

Array<object>

object

field

required

string

message

required

string

current_version

Versione corrente della risorsa (solo per version_conflict).

integer format: int64

spot_ids

Postazioni con allocazioni future (solo per spot_has_future_allocations).

Array<string>

violations

Vincoli violati (solo per policy_violation).

Array<object>

object

code

required

Codice stabile (es. lead_time_too_short).

string

params

object

key

additional properties

string

conflicts

Mezze giornate non disponibili (solo per spot_unavailable, pool_exhausted, quota_exceeded).

Array<object>

Mezza giornata non disponibile per una risorsa (spec 7.2), restituita in Problem.conflicts e nelle anteprime.

object

spot_id

string format: uuid

pool_id

string format: uuid

zone_id

string format: uuid

date

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

slot

required

Fascia: mattina o pomeriggio.

string

Allowed values: AM PM

reason

required

string

Allowed values: spot_unavailable pool_exhausted quota_exceeded closed inactive

current_status

Stato della prenotazione (spec 10.2).

string

Allowed values: draft held pending_payment awaiting_approval confirmed checked_in completed cancelled no_show expired rejected

existing_customer_id

Cliente già presente con la stessa email o telefono (solo per conflict su createCustomer).

string format: uuid

period

Periodo del soggiorno e data odierna dello stabilimento (solo per booking_outside_period).

object

today

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

starts_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

ends_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

Example

{
  "type": "bad_request",
  "conflicts": [
    {
      "slot": "AM",
      "reason": "spot_unavailable"
    }
  ],
  "current_status": "draft"
}

401

Autenticazione assente o non valida

Media typeapplication/problem+json

Errore RFC 9457 (application/problem+json).

object

type

required

Slug stabile del tipo di errore. I client devono basarsi su questo valore, mai sul testo di title o detail.

string

Allowed values: bad_request validation_failed unauthorized invalid_credentials totp_required invalid_totp totp_enrolment_required totp_already_enabled forbidden csrf_failed not_found conflict method_not_allowed unsupported_media_type rate_limited idempotency_key_reused idempotency_in_progress internal_error spot_unavailable no_price policy_violation hold_expired version_conflict precondition_required spot_has_future_allocations not_implemented pool_exhausted quota_exceeded invalid_transition cash_session_closed cash_session_already_open booking_outside_period checkout_not_found payment_provider_unavailable webhook_signature_invalid pairing_code_invalid lan_mode_required loopback_required setup_token_invalid setup_completed renewal_expired waitlist_offer_expired waitlist_disabled credit_insufficient season_rollover_conflict test_mode_preview_required import_invalid import_already_applied refund_in_progress zone_full assignment_conflict ticket_number_conflict ticket_voided ticket_already_entered price_changed ticket_owned printing_unavailable printer_address_not_allowed print_route_missing payment_provider_test_mode email_template_invalid

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

retry_after

Secondi da attendere (solo per rate_limited).

integer

errors

Array<object>

object

field

required

string

message

required

string

current_version

Versione corrente della risorsa (solo per version_conflict).

integer format: int64

spot_ids

Postazioni con allocazioni future (solo per spot_has_future_allocations).

Array<string>

violations

Vincoli violati (solo per policy_violation).

Array<object>

object

code

required

Codice stabile (es. lead_time_too_short).

string

params

object

key

additional properties

string

conflicts

Mezze giornate non disponibili (solo per spot_unavailable, pool_exhausted, quota_exceeded).

Array<object>

Mezza giornata non disponibile per una risorsa (spec 7.2), restituita in Problem.conflicts e nelle anteprime.

object

spot_id

string format: uuid

pool_id

string format: uuid

zone_id

string format: uuid

date

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

slot

required

Fascia: mattina o pomeriggio.

string

Allowed values: AM PM

reason

required

string

Allowed values: spot_unavailable pool_exhausted quota_exceeded closed inactive

current_status

Stato della prenotazione (spec 10.2).

string

Allowed values: draft held pending_payment awaiting_approval confirmed checked_in completed cancelled no_show expired rejected

existing_customer_id

Cliente già presente con la stessa email o telefono (solo per conflict su createCustomer).

string format: uuid

period

Periodo del soggiorno e data odierna dello stabilimento (solo per booking_outside_period).

object

today

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

starts_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

ends_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

Example

{
  "type": "bad_request",
  "conflicts": [
    {
      "slot": "AM",
      "reason": "spot_unavailable"
    }
  ],
  "current_status": "draft"
}

403

Permesso negato

Media typeapplication/problem+json

Errore RFC 9457 (application/problem+json).

object

type

required

Slug stabile del tipo di errore. I client devono basarsi su questo valore, mai sul testo di title o detail.

string

Allowed values: bad_request validation_failed unauthorized invalid_credentials totp_required invalid_totp totp_enrolment_required totp_already_enabled forbidden csrf_failed not_found conflict method_not_allowed unsupported_media_type rate_limited idempotency_key_reused idempotency_in_progress internal_error spot_unavailable no_price policy_violation hold_expired version_conflict precondition_required spot_has_future_allocations not_implemented pool_exhausted quota_exceeded invalid_transition cash_session_closed cash_session_already_open booking_outside_period checkout_not_found payment_provider_unavailable webhook_signature_invalid pairing_code_invalid lan_mode_required loopback_required setup_token_invalid setup_completed renewal_expired waitlist_offer_expired waitlist_disabled credit_insufficient season_rollover_conflict test_mode_preview_required import_invalid import_already_applied refund_in_progress zone_full assignment_conflict ticket_number_conflict ticket_voided ticket_already_entered price_changed ticket_owned printing_unavailable printer_address_not_allowed print_route_missing payment_provider_test_mode email_template_invalid

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

retry_after

Secondi da attendere (solo per rate_limited).

integer

errors

Array<object>

object

field

required

string

message

required

string

current_version

Versione corrente della risorsa (solo per version_conflict).

integer format: int64

spot_ids

Postazioni con allocazioni future (solo per spot_has_future_allocations).

Array<string>

violations

Vincoli violati (solo per policy_violation).

Array<object>

object

code

required

Codice stabile (es. lead_time_too_short).

string

params

object

key

additional properties

string

conflicts

Mezze giornate non disponibili (solo per spot_unavailable, pool_exhausted, quota_exceeded).

Array<object>

Mezza giornata non disponibile per una risorsa (spec 7.2), restituita in Problem.conflicts e nelle anteprime.

object

spot_id

string format: uuid

pool_id

string format: uuid

zone_id

string format: uuid

date

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

slot

required

Fascia: mattina o pomeriggio.

string

Allowed values: AM PM

reason

required

string

Allowed values: spot_unavailable pool_exhausted quota_exceeded closed inactive

current_status

Stato della prenotazione (spec 10.2).

string

Allowed values: draft held pending_payment awaiting_approval confirmed checked_in completed cancelled no_show expired rejected

existing_customer_id

Cliente già presente con la stessa email o telefono (solo per conflict su createCustomer).

string format: uuid

period

Periodo del soggiorno e data odierna dello stabilimento (solo per booking_outside_period).

object

today

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

starts_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

ends_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

Example

{
  "type": "bad_request",
  "conflicts": [
    {
      "slot": "AM",
      "reason": "spot_unavailable"
    }
  ],
  "current_status": "draft"
}

404

Risorsa inesistente

Media typeapplication/problem+json

Errore RFC 9457 (application/problem+json).

object

type

required

Slug stabile del tipo di errore. I client devono basarsi su questo valore, mai sul testo di title o detail.

string

Allowed values: bad_request validation_failed unauthorized invalid_credentials totp_required invalid_totp totp_enrolment_required totp_already_enabled forbidden csrf_failed not_found conflict method_not_allowed unsupported_media_type rate_limited idempotency_key_reused idempotency_in_progress internal_error spot_unavailable no_price policy_violation hold_expired version_conflict precondition_required spot_has_future_allocations not_implemented pool_exhausted quota_exceeded invalid_transition cash_session_closed cash_session_already_open booking_outside_period checkout_not_found payment_provider_unavailable webhook_signature_invalid pairing_code_invalid lan_mode_required loopback_required setup_token_invalid setup_completed renewal_expired waitlist_offer_expired waitlist_disabled credit_insufficient season_rollover_conflict test_mode_preview_required import_invalid import_already_applied refund_in_progress zone_full assignment_conflict ticket_number_conflict ticket_voided ticket_already_entered price_changed ticket_owned printing_unavailable printer_address_not_allowed print_route_missing payment_provider_test_mode email_template_invalid

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

retry_after

Secondi da attendere (solo per rate_limited).

integer

errors

Array<object>

object

field

required

string

message

required

string

current_version

Versione corrente della risorsa (solo per version_conflict).

integer format: int64

spot_ids

Postazioni con allocazioni future (solo per spot_has_future_allocations).

Array<string>

violations

Vincoli violati (solo per policy_violation).

Array<object>

object

code

required

Codice stabile (es. lead_time_too_short).

string

params

object

key

additional properties

string

conflicts

Mezze giornate non disponibili (solo per spot_unavailable, pool_exhausted, quota_exceeded).

Array<object>

Mezza giornata non disponibile per una risorsa (spec 7.2), restituita in Problem.conflicts e nelle anteprime.

object

spot_id

string format: uuid

pool_id

string format: uuid

zone_id

string format: uuid

date

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

slot

required

Fascia: mattina o pomeriggio.

string

Allowed values: AM PM

reason

required

string

Allowed values: spot_unavailable pool_exhausted quota_exceeded closed inactive

current_status

Stato della prenotazione (spec 10.2).

string

Allowed values: draft held pending_payment awaiting_approval confirmed checked_in completed cancelled no_show expired rejected

existing_customer_id

Cliente già presente con la stessa email o telefono (solo per conflict su createCustomer).

string format: uuid

period

Periodo del soggiorno e data odierna dello stabilimento (solo per booking_outside_period).

object

today

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

starts_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

ends_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

Example

{
  "type": "bad_request",
  "conflicts": [
    {
      "slot": "AM",
      "reason": "spot_unavailable"
    }
  ],
  "current_status": "draft"
}

412

Versione non aggiornata (version_conflict, con current_version)

Media typeapplication/problem+json

Errore RFC 9457 (application/problem+json).

object

type

required

Slug stabile del tipo di errore. I client devono basarsi su questo valore, mai sul testo di title o detail.

string

Allowed values: bad_request validation_failed unauthorized invalid_credentials totp_required invalid_totp totp_enrolment_required totp_already_enabled forbidden csrf_failed not_found conflict method_not_allowed unsupported_media_type rate_limited idempotency_key_reused idempotency_in_progress internal_error spot_unavailable no_price policy_violation hold_expired version_conflict precondition_required spot_has_future_allocations not_implemented pool_exhausted quota_exceeded invalid_transition cash_session_closed cash_session_already_open booking_outside_period checkout_not_found payment_provider_unavailable webhook_signature_invalid pairing_code_invalid lan_mode_required loopback_required setup_token_invalid setup_completed renewal_expired waitlist_offer_expired waitlist_disabled credit_insufficient season_rollover_conflict test_mode_preview_required import_invalid import_already_applied refund_in_progress zone_full assignment_conflict ticket_number_conflict ticket_voided ticket_already_entered price_changed ticket_owned printing_unavailable printer_address_not_allowed print_route_missing payment_provider_test_mode email_template_invalid

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

retry_after

Secondi da attendere (solo per rate_limited).

integer

errors

Array<object>

object

field

required

string

message

required

string

current_version

Versione corrente della risorsa (solo per version_conflict).

integer format: int64

spot_ids

Postazioni con allocazioni future (solo per spot_has_future_allocations).

Array<string>

violations

Vincoli violati (solo per policy_violation).

Array<object>

object

code

required

Codice stabile (es. lead_time_too_short).

string

params

object

key

additional properties

string

conflicts

Mezze giornate non disponibili (solo per spot_unavailable, pool_exhausted, quota_exceeded).

Array<object>

Mezza giornata non disponibile per una risorsa (spec 7.2), restituita in Problem.conflicts e nelle anteprime.

object

spot_id

string format: uuid

pool_id

string format: uuid

zone_id

string format: uuid

date

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

slot

required

Fascia: mattina o pomeriggio.

string

Allowed values: AM PM

reason

required

string

Allowed values: spot_unavailable pool_exhausted quota_exceeded closed inactive

current_status

Stato della prenotazione (spec 10.2).

string

Allowed values: draft held pending_payment awaiting_approval confirmed checked_in completed cancelled no_show expired rejected

existing_customer_id

Cliente già presente con la stessa email o telefono (solo per conflict su createCustomer).

string format: uuid

period

Periodo del soggiorno e data odierna dello stabilimento (solo per booking_outside_period).

object

today

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

starts_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

ends_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

Example

{
  "type": "bad_request",
  "conflicts": [
    {
      "slot": "AM",
      "reason": "spot_unavailable"
    }
  ],
  "current_status": "draft"
}

501

Operazione non ancora disponibile (not_implemented)

Media typeapplication/problem+json

Errore RFC 9457 (application/problem+json).

object

type

required

Slug stabile del tipo di errore. I client devono basarsi su questo valore, mai sul testo di title o detail.

string

Allowed values: bad_request validation_failed unauthorized invalid_credentials totp_required invalid_totp totp_enrolment_required totp_already_enabled forbidden csrf_failed not_found conflict method_not_allowed unsupported_media_type rate_limited idempotency_key_reused idempotency_in_progress internal_error spot_unavailable no_price policy_violation hold_expired version_conflict precondition_required spot_has_future_allocations not_implemented pool_exhausted quota_exceeded invalid_transition cash_session_closed cash_session_already_open booking_outside_period checkout_not_found payment_provider_unavailable webhook_signature_invalid pairing_code_invalid lan_mode_required loopback_required setup_token_invalid setup_completed renewal_expired waitlist_offer_expired waitlist_disabled credit_insufficient season_rollover_conflict test_mode_preview_required import_invalid import_already_applied refund_in_progress zone_full assignment_conflict ticket_number_conflict ticket_voided ticket_already_entered price_changed ticket_owned printing_unavailable printer_address_not_allowed print_route_missing payment_provider_test_mode email_template_invalid

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

retry_after

Secondi da attendere (solo per rate_limited).

integer

errors

Array<object>

object

field

required

string

message

required

string

current_version

Versione corrente della risorsa (solo per version_conflict).

integer format: int64

spot_ids

Postazioni con allocazioni future (solo per spot_has_future_allocations).

Array<string>

violations

Vincoli violati (solo per policy_violation).

Array<object>

object

code

required

Codice stabile (es. lead_time_too_short).

string

params

object

key

additional properties

string

conflicts

Mezze giornate non disponibili (solo per spot_unavailable, pool_exhausted, quota_exceeded).

Array<object>

Mezza giornata non disponibile per una risorsa (spec 7.2), restituita in Problem.conflicts e nelle anteprime.

object

spot_id

string format: uuid

pool_id

string format: uuid

zone_id

string format: uuid

date

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

slot

required

Fascia: mattina o pomeriggio.

string

Allowed values: AM PM

reason

required

string

Allowed values: spot_unavailable pool_exhausted quota_exceeded closed inactive

current_status

Stato della prenotazione (spec 10.2).

string

Allowed values: draft held pending_payment awaiting_approval confirmed checked_in completed cancelled no_show expired rejected

existing_customer_id

Cliente già presente con la stessa email o telefono (solo per conflict su createCustomer).

string format: uuid

period

Periodo del soggiorno e data odierna dello stabilimento (solo per booking_outside_period).

object

today

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

starts_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

ends_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

Example

{
  "type": "bad_request",
  "conflicts": [
    {
      "slot": "AM",
      "reason": "spot_unavailable"
    }
  ],
  "current_status": "draft"
}