API para desarrolladores
Integrar con Esquemas de URL
Inicia el pago de Stripe desde tu app o sitio web para procesar transacciones. Transfiere datos de clientes, importes e información del producto; luego, gestiona la devolución de llamada una vez finalizado.
Cómo funciona
Su aplicación abre una pago:// URL con parámetros
El pago por Stripe inicia y procesa la transacción
Al finalizar, la aplicación redirecciona a su URL de devolución de llamada con el resultado.
Puntos finales
Crear un cargo
payment://new?Procesar un pago único con monto, moneda y descripción.
Parámetros
| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
amount | integer | Sí | Cantidad en centavos (por ejemplo, 1000 = $10,00) |
currency | string | No | Código de moneda ISO de tres letras (predeterminado: USD) |
description | string | No | Descripción del cargo codificada en URL |
customer | string | No | ID de cliente de Stripe existente |
email | string | No | Correo electrónico del cliente para el recibo |
name | string | No | Nombre del cliente codificado en URL |
metadata | string | No | Pares clave-valor personalizados (JSON codificado en URL) |
callback | string | No | URL a la que volver después de finalizar |
autoprocess | boolean | No | Omitir la pantalla de inicio y comenzar a cargar inmediatamente |
auto_return | boolean | No | Se activa la función de devolución de llamada cuando se carga el resultado, en lugar de esperar a que el comerciante cierre el cuadro de diálogo de resultados. Valor predeterminado: falso. |
Crear una factura
payment://cart?Crea una factura de Stripe con artículos de línea de tu catálogo de productos.
Parámetros
| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
prices | string | Sí | Identificadores de precios separados por comas con cantidades (p. ej., precio_abc:2, precio_xyz:1) |
customer | string | No | ID de cliente de Stripe existente |
email | string | No | Correo electrónico del cliente para el recibo |
name | string | No | Nombre del cliente codificado en URL |
callback | string | No | URL a la que volver después de finalizar |
auto_return | boolean | No | Se activa la función de devolución de llamada cuando se carga el resultado, en lugar de esperar a que el comerciante cierre el cuadro de diálogo de resultados. Valor predeterminado: falso. |
Pagar una factura existente (solo iOS)
payment://invoice?Cobra un pago presencial contra una factura de Stripe existente. El importe, la moneda, el cliente y los impuestos provienen de la factura; cualquier modificación de estos datos será rechazada. El comerciante acerca la tarjeta al lector, mediante la función "Tocar para pagar" o manualmente. Si la transacción es exitosa, la factura se marca como pagada fuera de banda y se vincula mediante los metadatos charge_id y payment_intent_id. Las facturas con suscripciones, default_payment_method o estado no abierto se rechazan con un error procesable.
Parámetros
| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
id | string | Sí | ID de factura de Stripe (debe comenzar con in_) |
callback | string | No | URL a la que regresar después de completar la operación. Recibe invoice_id y payment_intent_id en caso de éxito. |
metadata | string | No | Pares clave-valor personalizados (JSON codificado en URL) fusionados en los metadatos de PaymentIntent. |
autoprocess | boolean | No | Saltar la pantalla de inicio y comenzar la carga inmediatamente |
auto_return | boolean | No | Se activa la función de devolución de llamada cuando se carga el resultado, en lugar de esperar a que el comerciante cierre el cuadro de diálogo de resultados. Valor predeterminado: falso. |
Manejo de devoluciones de llamadas
Cuando se completa la transacción, Payment for Stripe redirige a tu URL de devolución de llamada con parámetros de consulta que indican el resultado. Por defecto, la redirección se activa después de que el comerciante cierre el cuadro de diálogo de resultados para que pueda realizar acciones posteriores al cobro (enviar un recibo por correo electrónico, realizar un reembolso). Si pasas `auto_return=true`, se activará tan pronto como se conozca el resultado. Compatible con iOS y Android.
Parámetros de devolución de llamada
| Parámetro | Valores | Descripción |
|---|---|---|
status | success | error | cancelled | Resultado de la transacción |
charge_id | string | ID de cargo de Stripe (en caso de éxito) |
invoice_id | string | ID de factura de Stripe (solo en caso de éxito, flujo payment://invoice) |
payment_intent_id | string | ID de Stripe PaymentIntent (en caso de éxito, solo en el flujo payment://invoice) |
error | string | Mensaje de error (en caso de error) |
Ejemplos
Carga simple
Cobrar $10.00 con solo un monto
payment://new?amount=1000Cargar con descripción
Cobrar 25,00€ con una descripción
payment://new?amount=2500¤cy=eur&description=Coffee%20and%20pastryCargar con nuevo cliente
Cobrar $50.00 y crear un registro de cliente
payment://new?amount=5000&name=John%20Smith&[email protected]Cobrar a un cliente existente
Cobrar $75.00 a un cliente existente de Stripe
payment://new?amount=7500&customer=cus_ABC123xyzCargar con metadatos
Cobra $100.00 con metadatos personalizados para tus registros
payment://new?amount=10000&description=Invoice%20%231234&metadata=%7B%22order_id%22%3A%221234%22%2C%22location%22%3A%22Store%20A%22%7DProcesamiento automático con devolución de llamada
Omite la pantalla de inicio y regresa a tu aplicación cuando hayas terminado
payment://new?amount=3500&autoprocess=true&callback=myapp://payment-completeRetorno automático al obtener el resultado
Inicie la llamada de retorno tan pronto como se conozca el resultado, en lugar de esperar a que el comerciante cierre el cuadro de diálogo de resultados.
payment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-completeFactura con artículos de línea
Crea una factura con productos de tu catálogo de Stripe
payment://cart?prices=price_coffee:2,price_muffin:1&[email protected]Pagar una factura existente (iOS)
Cobra el pago en persona de una factura de Stripe existente. Devuelve invoice_id y payment_intent_id si la operación se realiza correctamente.
payment://invoice?id=in_1ABC123xyz&autoprocess=true&callback=myapp://invoice-paidEjemplo completo
Todos los parámetros combinados para un flujo totalmente integrado
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-resultCodificación de URL
Recuerde codificar en URL los caracteres especiales en los valores de los parámetros. Los espacios se convierten en %20 y las llaves en %7B y %7D.
¿Listo para integrarse?
Descargue la aplicación y comience a probar su integración hoy mismo.