API para desenvolvedores

Integre e personalize

Abra o Payment for Stripe a partir do seu próprio aplicativo ou site com esquemas de URL, e controle quais produtos aparecem no aplicativo direto do Dashboard da Stripe.

Integração com esquemas de URL

Dispare cobranças do seu aplicativo ou site, passe dados de clientes e trate os callbacks.

Ocultar produtos com metadados

Mantenha produtos exclusivos da loja online fora do aplicativo com uma única chave de metadados.

Integração com esquemas de URL

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.
`auto_return`	boolean	Não	Aciona a função de retorno de chamada quando o resultado é carregado, em vez de esperar que o lojista feche a caixa de diálogo de resultados. O padrão é falso.

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
`auto_return`	boolean	Não	Aciona a função de retorno de chamada quando o resultado é carregado, em vez de esperar que o lojista feche a caixa de diálogo de resultados. O padrão é falso.

Pagar uma fatura existente (somente iOS)

payment://invoice?

Receba um pagamento presencial referente a uma fatura Stripe existente. O valor, a moeda, o cliente e o imposto são provenientes da fatura. Qualquer alteração nesses dados resultará em rejeição. O comerciante utiliza um leitor de cartão, o recurso "Aproximar para Pagar" ou a entrada manual de dados; em caso de sucesso, a fatura é marcada como paga fora da banda e vinculada por meio dos metadados charge_id e payment_intent_id. Faturas com assinaturas, default_payment_method ou status não aberto serão rejeitadas com uma mensagem de erro que pode ser acionada.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID da fatura Stripe (deve começar com in_)
`callback`	string	Não	URL para a qual retornar após a conclusão. Recebe invoice_id e payment_intent_id em caso de sucesso.
`metadata`	string	Não	Pares de chave-valor personalizados (JSON codificado em URL) mesclados nos metadados do PaymentIntent.
`autoprocess`	boolean	Não	Ignore a tela inicial e inicie o carregamento imediatamente.
`auto_return`	boolean	Não	Aciona a função de retorno de chamada quando o resultado é carregado, em vez de esperar que o lojista feche a caixa de diálogo de resultados. O padrão é falso.

Gerenciando retornos de chamada

Quando a transação for concluída, o Payment for Stripe redireciona para o seu URL de retorno de chamada com parâmetros de consulta que indicam o resultado. Por padrão, o redirecionamento é acionado depois que o lojista fecha a caixa de diálogo de resultado para que ele possa realizar ações pós-cobrança (enviar um recibo por e-mail, efetuar um reembolso). Passe `auto_return=true` para que o redirecionamento seja acionado assim que o resultado for conhecido. Compatível com iOS e Android.

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)
`invoice_id`	string	ID da fatura Stripe (em caso de sucesso, apenas no fluxo payment://invoice)
`payment_intent_id`	string	ID do PaymentIntent do Stripe (em caso de sucesso, apenas para o fluxo payment://invoice)
`error`	string	Mensagem de erro (em caso de erro)

Exemplos

cobrança simples

Cobrar $10,00 com apenas um valor

payment://new?amount=1000

Acusar com descrição

Cobrar €25,00 com descrição

payment://new?amount=2500&currency=eur&description=Coffee%20and%20pastry

Cobranç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_ABC123xyz

Cobranç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%7D

Processamento 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-complete

Retorno automático ao resultado

Dispare a função de retorno assim que o resultado for conhecido, em vez de esperar que o lojista feche a caixa de diálogo de resultados.

payment://new?amount=3500&autoprocess=true&auto_return=true&callback=myapp://payment-complete

Fatura com itens detalhados

Crie uma fatura com produtos do seu catálogo Stripe.

payment://cart?prices=price_coffee:2,price_muffin:1&[email protected]

Pagar uma fatura existente (iOS)

Recebe pagamentos presenciais referentes a uma fatura existente do Stripe. Retorna o invoice_id e o payment_intent_id em caso de sucesso.

payment://invoice?id=in_1ABC123xyz&autoprocess=true&callback=myapp://invoice-paid

Exemplo completo

Todos os parâmetros combinados para um fluxo totalmente integrado

payment://new?amount=15000&currency=usd&description=Service%20Fee&customer=cus_ABC123xyz&metadata=%7B%22invoice%22%3A%22INV-2024-001%22%7D&autoprocess=true&callback=myapp://payment-result

Codificaçã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.

Ocultar produtos com metadados

Ocultar produtos do aplicativo

O aplicativo lista os produtos e preços da sua conta Stripe. Para manter um deles fora do aplicativo (por exemplo, itens vendidos apenas na sua loja online), adicione esta chave de metadados ao produto ou preço no Dashboard da Stripe:

payment_hidden = true

Em um produto: oculta o produto e todos os seus preços.

Em um preço: oculta apenas esse preço.

Remova a chave, ou defina-a como false, para exibi-lo novamente. As alterações valem na próxima vez que o aplicativo carregar sua lista de produtos.

Links de carrinho continuam funcionando

Ocultar afeta apenas a lista de produtos dentro do aplicativo. URLs payment://cart que referenciam um preço oculto continuam funcionando, e assinaturas existentes não são afetadas.

Pronto para integrar?

Baixe o aplicativo e comece a testar sua integração hoje mesmo.

Baixe o aplicativo Contate o suporte