Configurando a conta

Primeiramente, informe o nome de seu negócio para criar a configuração dele. Caso você tenha diversos negócios, poderá vincular todos eles a sua conta de forma independente.

Após a criação, você poderá acessar o painel de configuração do negócio selecionado.

Você deverá informar as seguintes informações

• Webhook URL: é a rota de sua aplicação que receberá as atualizações dos status das ordens de pagamentos gerado por você.

• Redirect Success URL: página da sua aplicação para a qual o navegador é redirecionado automaticamente após um pagamento realizado com sucesso no checkout da Bitpayway.

• Redirect Failure URL: página da sua aplicação para a qual o navegador é redirecionado quando ocorre uma falha na tentativa de pagamento. Se a ordem estiver expirada, o checkout exibirá um botão Return to merchant que redireciona para essa URL. Veja o que o cliente vê no checkout redirecionado.

• Api Key: o nome da chave secreta que te possibilita gerar ordens de pagamento para sua aplicação. Pode haver mais de uma chave.

• Webhook secret key: gera a chave usada para conferir a assinatura dos dados enviados pelo webhook para sua aplicação. Pode haver apenas 1 chave, ao gerar uma nova, a antiga deixa de ser válido.

• Wallet: para cada token (stable coin) em cada rede deve haver uma wallet para a qual os valores do pagamento deverão ser enviados. Você deve informar, e após isso habilitar. Para habilitar, você deverá ter configurado uma carteira para realizar o procedimento on-chain: MetaMask na Ethereum e na Arbitrum. Não é possível gerar ordens de pagamentos utilizando um determinao token (stable coin) sem este mesmo token estar previamente habilitado. Após finalizar o pagamento, você pode clicar me Check status para atualizar o status da habilitação.

Pagamentos multidestino

Os pagamentos multidestino usam um registro próprio de carteiras e exigem uma configuração adicional. O processo completo — modelo das carteiras, cadastro por token no painel, configuração de parceiros somente pela API, criação das ordens, liquidação e conciliação — está reunido em Pagamentos multidestino.

Parâmetros das URLs de redirecionamento

O checkout acrescenta o identificador da ordem de pagamento à URL configurada como um parâmetro de query:

Resultado no checkout	Destino configurado	Parâmetro de query
Pagamento realizado com sucesso	Redirect Success URL	request=<requestId>
Falha na tentativa de pagamento	Redirect Failure URL	request=<requestId>
Ordem expirada, após o usuário clicar em Return to merchant	Redirect Failure URL	order=<requestId>

O requestId é o mesmo UUID informado pela sua aplicação no campo requestId durante a criação da ordem de pagamento. Utilize esse valor para relacionar o retorno do usuário à ordem correspondente no seu sistema.

Por exemplo, se as URLs configuradas forem https://merchant.example/pagamentos/sucesso e https://merchant.example/pagamentos/falha, o navegador poderá redirecionar o usuário para:

https://merchant.example/pagamentos/sucesso?request=2f3c9d2c-1b75-4e9d-9b2f-67d0a9c3c7d1
https://merchant.example/pagamentos/falha?request=2f3c9d2c-1b75-4e9d-9b2f-67d0a9c3c7d1
https://merchant.example/pagamentos/falha?order=2f3c9d2c-1b75-4e9d-9b2f-67d0a9c3c7d1

Configure esses campos com URLs base que não contenham uma query string ou fragmento. O checkout realiza um redirecionamento no navegador e não envia corpo de requisição nem um parâmetro com o status do pagamento. Utilize o webhook para confirmar o status do pagamento com segurança no servidor; não considere somente o redirecionamento do navegador como comprovação do pagamento.

Excluindo um negócio

Para excluir um negócio, abra a aba Configuração, clique em Excluir negócio e digite o nome do negócio para confirmar. A exclusão não pode ser desfeita:

• O negócio deixa de aparecer na sua conta.
• As chaves de API são revogadas: requisições autenticadas com elas são rejeitadas e não é possível criar novas ordens de pagamento.
• As ordens de pagamento criadas antes da exclusão continuam funcionando: os clientes ainda podem pagá-las no checkout e a sua URL de webhook continua recebendo as atualizações de status.