API para desenvolvedores
Integrar com esquemas de URL
Inicie o processamento de pagamentos via Stripe a partir do seu aplicativo ou site. Transmita dados do cliente, valores e informações do produto e, em seguida, gerencie a solicitação de retorno quando a transação for concluída.
Como funciona
Seu aplicativo abre um pagamento:// URL com parâmetros
O pagamento para o Stripe inicia e processa a transação.
Ao concluir, o aplicativo redireciona para o seu URL de retorno de chamada com o resultado.
Pontos finais
Criar uma cobrança
payment://new?Processar um pagamento único com valor, moeda e descrição.
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
amount | integer | Sim | Valor em centavos (ex.: 1000 = $10,00) |
currency | string | Não | Código ISO de moeda com três letras (padrão: USD) |
description | string | Não | Descrição da cobrança codificada em URL |
customer | string | Não | ID de cliente Stripe existente |
email | string | Não | E-mail do cliente para recebimento do recibo |
name | string | Não | Nome do cliente codificado em URL |
metadata | string | Não | Pares de chave-valor personalizados (JSON codificado em URL) |
callback | string | Não | URL para onde retornar após a conclusão |
autoprocess | boolean | Não | Ignore a tela inicial e inicie o carregamento imediatamente. |
Criar uma fatura
payment://cart?Crie uma fatura do Stripe com itens de linha do seu catálogo de produtos.
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
prices | string | Sim | IDs de preço separados por vírgulas com as respectivas quantidades (ex.: preço_abc:2,preço_xyz:1) |
customer | string | Não | ID de cliente Stripe existente |
email | string | Não | E-mail do cliente para recebimento do recibo |
name | string | Não | Nome do cliente codificado em URL |
callback | string | Não | URL para onde retornar após a conclusão |
Gerenciando retornos de chamada
Quando a transação for concluída, o Payment for Stripe redirecionará para o seu URL de retorno de chamada com parâmetros de consulta indicando o resultado.
Parâmetros de retorno de chamada
| Parâmetro | Valores | Descrição |
|---|---|---|
status | success | error | cancelled | Resultado da transação |
charge_id | string | ID de cobrança do Stripe (em caso de sucesso) |
error | string | Mensagem de erro (em caso de erro) |
Exemplos
cobrança simples
Cobrar $10,00 com apenas um valor
payment://new?amount=1000Acusar com descrição
Cobrar €25,00 com descrição
payment://new?amount=2500¤cy=eur&description=Coffee%20and%20pastryCobrança para novos clientes
Cobrar US$ 50,00 e criar um registro de cliente.
payment://new?amount=5000&name=John%20Smith&[email protected]Cobrar do cliente existente
Cobrar US$ 75,00 de um cliente Stripe existente.
payment://new?amount=7500&customer=cus_ABC123xyzCobrança com metadados
Cobramos US$ 100,00 com metadados personalizados para seus registros.
payment://new?amount=10000&description=Invoice%20%231234&metadata=%7B%22order_id%22%3A%221234%22%2C%22location%22%3A%22Store%20A%22%7DProcessamento automático com retorno de chamada
Ignore a tela inicial e retorne ao seu aplicativo quando terminar.
payment://new?amount=3500&autoprocess=true&callback=myapp://payment-completeFatura com itens detalhados
Crie uma fatura com produtos do seu catálogo Stripe.
payment://cart?prices=price_coffee:2,price_muffin:1&[email protected]Exemplo completo
Todos os parâmetros combinados para um fluxo 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-resultCodificação de URL
Lembre-se de codificar caracteres especiais em URLs nos valores dos parâmetros. Espaços se tornam %20, chaves se tornam %7B e %7D.
Pronto para integrar?
Baixe o aplicativo e comece a testar sua integração hoje mesmo.