API per sviluppatori
Integrare con Schemi URL
Avvia il pagamento per Stripe dalla tua app o dal tuo sito web per elaborare le transazioni. Trasmetti i dati del cliente, gli importi e le informazioni sui prodotti, quindi gestisci la richiamata al termine.
Come funziona
La tua app apre un pagamento:// URL con parametri
Il pagamento per Stripe avvia ed elabora la transazione
Al termine, l'app reindirizza all'URL di callback con il risultato
Punti finali
Crea un addebito
payment://new?Elabora un pagamento una tantum con importo, valuta e descrizione.
Parametri
| Nome | Tipo | Necessario | Descrizione |
|---|---|---|---|
amount | integer | SÌ | Importo in centesimi (ad esempio, 1000 = $ 10,00) |
currency | string | NO | Codice valuta ISO a tre lettere (predefinito: USD) |
description | string | NO | Descrizione dell'addebito codificata in URL |
customer | string | NO | ID cliente Stripe esistente |
email | string | NO | Email del cliente per la ricevuta |
name | string | NO | Nome del cliente codificato in URL |
metadata | string | NO | Coppie chiave-valore personalizzate (JSON codificato in URL) |
callback | string | NO | URL a cui tornare dopo il completamento |
autoprocess | boolean | NO | Salta la schermata iniziale e inizia subito la ricarica |
auto_return | boolean | NO | Esegui la funzione di callback al caricamento dei risultati anziché attendere che il commerciante chiuda la finestra di dialogo dei risultati. Valore predefinito: false. |
Crea una fattura
payment://cart?Crea una fattura Stripe con le voci del tuo catalogo prodotti.
Parametri
| Nome | Tipo | Necessario | Descrizione |
|---|---|---|---|
prices | string | SÌ | ID dei prezzi separati da virgole con quantità (ad esempio, price_abc:2,price_xyz:1) |
customer | string | NO | ID cliente Stripe esistente |
email | string | NO | Email del cliente per la ricevuta |
name | string | NO | Nome del cliente codificato in URL |
callback | string | NO | URL a cui tornare dopo il completamento |
auto_return | boolean | NO | Esegui la funzione di callback al caricamento dei risultati anziché attendere che il commerciante chiuda la finestra di dialogo dei risultati. Valore predefinito: false. |
Paga una fattura esistente (solo iOS)
payment://invoice?Riscuoti un pagamento di persona a fronte di una fattura Stripe esistente. Importo, valuta, cliente e imposta provengono dalla fattura: qualsiasi modifica a questi dati verrà rifiutata. Il commerciante effettua il pagamento tramite lettore, Tap to Pay o inserimento manuale; in caso di successo, la fattura viene contrassegnata come pagata fuori banda e collegata tramite i metadati charge_id e payment_intent_id. Le fatture con abbonamenti, default_payment_method o stato non aperto vengono rifiutate con un errore risolvibile.
Parametri
| Nome | Tipo | Necessario | Descrizione |
|---|---|---|---|
id | string | SÌ | ID fattura Stripe (deve iniziare con in_) |
callback | string | NO | URL a cui tornare al termine dell'operazione. Riceve invoice_id e payment_intent_id in caso di successo. |
metadata | string | NO | Coppie chiave-valore personalizzate (JSON codificato in URL) unite ai metadati di PaymentIntent |
autoprocess | boolean | NO | Salta la schermata iniziale e avvia subito la ricarica. |
auto_return | boolean | NO | Esegui la funzione di callback al caricamento dei risultati anziché attendere che il commerciante chiuda la finestra di dialogo dei risultati. Valore predefinito: false. |
Gestione delle richiamate
Al termine della transazione, Payment for Stripe reindirizza all'URL di callback specificato, con parametri di query che indicano il risultato. Per impostazione predefinita, il reindirizzamento si attiva dopo che il commerciante ha chiuso la finestra di dialogo con il risultato, consentendogli di intraprendere azioni successive all'addebito (invio di una ricevuta via email, rimborso). Impostando `auto_return=true`, il reindirizzamento si attiverà non appena il risultato sarà noto. Supportato su iOS e Android.
Parametri di callback
| Parametro | Valori | Descrizione |
|---|---|---|
status | success | error | cancelled | Risultato della transazione |
charge_id | string | ID addebito Stripe (in caso di successo) |
invoice_id | string | ID fattura Stripe (solo in caso di successo, flusso pagamento://fattura) |
payment_intent_id | string | ID di intent di pagamento Stripe (solo in caso di successo, flusso payment://invoice) |
error | string | Messaggio di errore (in caso di errore) |
Esempi
Carica semplice
Addebita $ 10,00 con un solo importo
payment://new?amount=1000Carica con descrizione
Addebita € 25,00 con descrizione
payment://new?amount=2500¤cy=eur&description=Coffee%20and%20pastryAddebita con nuovo cliente
Addebita $ 50,00 e crea un record cliente
payment://new?amount=5000&name=John%20Smith&[email protected]Addebita al cliente esistente
Addebita $ 75,00 a un cliente Stripe esistente
payment://new?amount=7500&customer=cus_ABC123xyzCarica con metadati
Addebita $ 100,00 con metadati personalizzati per i tuoi record
payment://new?amount=10000&description=Invoice%20%231234&metadata=%7B%22order_id%22%3A%221234%22%2C%22location%22%3A%22Store%20A%22%7DElaborazione automatica con callback
Salta la schermata iniziale e torna all'app quando hai finito
payment://new?amount=3500&autoprocess=true&callback=myapp://payment-completeRitorno automatico al risultato
Attiva la funzione di callback non appena il risultato è noto, invece di attendere che il commerciante chiuda la finestra di dialogo del risultato.
payment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-completeFattura con voci di riga
Crea una fattura con i prodotti dal tuo catalogo Stripe
payment://cart?prices=price_coffee:2,price_muffin:1&[email protected]Paga una fattura esistente (iOS)
Raccoglie il pagamento di persona per una fattura Stripe esistente. Restituisce invoice_id e payment_intent_id in caso di successo.
payment://invoice?id=in_1ABC123xyz&autoprocess=true&callback=myapp://invoice-paidEsempio completo
Tutti i parametri combinati per un flusso completamente integrato
payment://new?amount=15000¤cy=usd&description=Service%20Fee&customer=cus_ABC123xyz&metadata=%7B%22invoice%22%3A%22INV-2024-001%22%7D&autoprocess=true&callback=myapp://payment-resultCodifica URL
Ricordatevi di codificare i caratteri speciali nell'URL nei valori dei parametri. Gli spazi diventano %20, le parentesi graffe diventano %7B e %7D.
Pronti per l'integrazione?
Scarica l'app e inizia subito a testare la tua integrazione.