Comece Aqui
Receba pagamentos com cartão, PIX ou link de pagamento usando a API da Sopague. Escolha como você quer cobrar e siga o roteiro até confirmar o resultado da sua primeira transação em homologação. Veja também como cancelar uma venda e receber notificações por webhook. Para entender o funcionamento do gateway e suas possibilidades, consulte a Introdução.
Antes de começar
Antes de iniciar qualquer um dos fluxos abaixo, acesse a página de Suporte e entre em contato com nossa equipe para solicitar suas credenciais de acesso. Com as credenciais em mãos, siga a página de Autenticação para obter o token JWT usado nas requisições à API.
Cartão
Prepare o cartão
Consulte a visão geral das bibliotecas e configure os recursos de segurança necessários para sua integração: Antifraude ou 3DS.
Crie o pagamento
Envie a cobrança de débito ou crédito em Criar Pagamento. Para pagamentos com 3DS, siga Criar Pagamento com 3DS.
Confira o resultado
Consulte a transação em Pesquisar Pagamento e acompanhe as atualizações pelas notificações de pagamento.
PIX
Gere a cobrança
Use Criar Transação PIX com o valor e a referência do pedido.
Apresente o código ao cliente
Disponibilize o código copia e cola ou o QR Code e guarde o identificador da transação.
Confirme o pagamento
Acompanhe o status em Consultar Transação PIX até confirmar o pagamento.
Link de pagamento
Crie o link
Em Criar Link, defina a descrição, o valor, o parcelamento e a validade da cobrança.
Compartilhe com o cliente
Envie a URL retornada para o cliente concluir o pagamento no checkout.
Acompanhe o pagamento
Consulte o link em Pesquisar Link e use as notificações de urlCallBack para acompanhar o resultado do pagamento.
Cancelamento
Identifique a transação e o tipo de cancelamento
Para uma venda capturada no mesmo dia, use Cancelar Pagamento, informando o identificador e o valor em centavos. Para datas retroativas e outros tipos de captura, como POS, TEF e WEB, siga Solicitar Cancelamento.
Envie a solicitação
No pedido de estorno, informe NSU, código de autorização, valor total, data da operação e motivo. Guarde o identificador retornado: a solicitação começa como PENDENTE e ainda depende de processamento.
Acompanhe o resultado
Confira o retorno do cancelamento no mesmo dia e consulte a venda em Pesquisar Pagamento. Para pedidos de estorno, acompanhe o status em Listar Cancelamentos. Se precisar desistir de um pedido ainda PENDENTE, use Cancelar Pedido de Estorno.
Webhook
Prepare o recebimento
Crie um endpoint que aceite POST e informe sua URL no campo urlCallBack da criação do pagamento ou do link. Consulte os formatos enviados em Notificações de Pagamento.
Valide e processe a notificação
Valide o header Access-Key conforme a documentação de notificações. Se sua integração utilizar autenticação Basic, cadastre as credenciais em Autenticação de Webhook. Relacione a notificação à transação, atualize seu pedido sem duplicar o processamento e retorne HTTP 200 quando o recebimento for concluído com sucesso.
Trate falhas de entrega
Quando houver uma notificação elegível que não foi entregue com sucesso, use Reenviar Webhook. O retorno queued indica que o reenvio foi enfileirado; acompanhe o recebimento no seu endpoint. Para retirar a credencial Basic cadastrada, consulte Remover Autenticação de Webhook.
Em caso de dúvida, entre em contato com o suporte.