Skip to main content
POST
Crea un link di pagamento

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Obbligatoria. La stessa chiave entro 24 ore ripete la prima risposta 2xx.

Maximum string length: 255

Body

application/json
invoiceId
string<uuid>

La fattura da incassare (emessa o scaduta).

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
installmentId
string<uuid>

Oppure la rata di un piano di pagamento.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
description
string

Cio' che il paziente legge su Stripe. Predefinito: «Prestazione odontoiatrica».

Required string length: 1 - 200

Response

Il link creato (o, con una chiave di prova, quello che sarebbe).

id
string<uuid> | null
required

null con una chiave di prova: nessun link creato.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
url
string | null
required

L'indirizzo di Stripe da mandare al paziente; scade dopo un'ora. null con una chiave di prova.

livemode
boolean
required

false con una chiave di prova (dsk_test_): niente passa da Stripe.

amount
number
required

In euro: il residuo della fattura o della rata al momento della creazione.

currency
string
required
Allowed value: "eur"
expiresAt
string | null
required
patientId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
invoiceId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
installmentId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$