Pular para o conteúdo

Conceitos

O Invoise dá ao seu cliente um endereço de pagamento e envia os fundos recebidos para sua carteira, menos a taxa de serviço.

Conceito Significado
Conta Um usuário que entra na plataforma e recebe acesso a lojistas e lojas.
Lojista Um negócio no Invoise com suas próprias lojas, equipe e condições.
Loja Onde faturas e depósitos são criados. Tem suas próprias configurações de destinatário, chaves de API e histórico de operações.
Fatura Uma solicitação de pagamento único de valor fixo. Criada por /invoices.
Depósito Um endereço reutilizável para recargas sem valor fixo. Criado por /deposits.
Transferência recebida Fundos enviados pelo pagador para um endereço de fatura ou depósito. Várias transferências podem pagar uma fatura.
Repasse Fundos recebidos transferidos ao destinatário da loja, menos a taxa de serviço.

issuance é o nome do recurso da API compartilhado por faturas e depósitos. Salve o id da resposta de criação como issuance_id para as próximas requisições.

Vincule um pedido do seu próprio sistema a uma fatura por meio de external_id. A entidade no Invoise é sempre uma fatura.

  1. Crie uma fatura ou depósito.
  2. Aguarde seu address, depois dê ao cliente o payment_url retornado.
  3. O cliente envia o token selecionado na rede selecionada.
  4. O Invoise confirma a transferência recebida. Assim que houver fundos suficientes disponíveis, ele envia o repasse ao seu destinatário.

Você pode verificar o progresso com uma requisição GET ou receber webhooks. Veja Status de fatura e depósito.

Uma fatura se torna funded quando fundos confirmados suficientes chegaram. A conclusão do repasse é confirmada separadamente por payout.confirmed.

Configuração Finalidade
Endereço do destinatário A carteira que recebe os repasses em EVM. Verifique se ela é compatível com as redes selecionadas.
Carteira Invoise Em vez de um endereço, uma loja pode pagar na carteira Invoise de um membro da conta.
Delegado Uma carteira opcional que você controla e que pode liquidar faturas EVM de forma independente e pagar o gas. Um endereço de corretora não é adequado.

Você pode alterar o destinatário, o delegado e a escolha entre um endereço e a carteira Invoise depois, com PATCH /shops/{shop_id}. Cada fatura e depósito mantém o destinatário e o delegado com que foi criado, então uma alteração afeta apenas faturas e endereços criados depois.

Solana e Tron têm seus próprios destinatários. Veja Solana e Tron.

Um owner pode arquivar uma loja com PATCH /shops/{shop_id} e {"archived":true}. Isso cancela as faturas não pagas e desativa os endereços de depósito, as chaves de API e os endpoints de webhook da loja. Uma loja arquivada não conta para o limite de lojas do lojista, 10 por padrão.

A taxa de serviço é deduzida do repasse. As taxas gerais por rede estão na tabela; elas podem variar de um lojista para outro, então leia os termos da sua loja na API.

Para depósitos, pagamentos pequenos se acumulam até que o limite de repasse seja atingido. Para faturas, pagamentos parciais se acumulam até que o valor da fatura seja atingido. Um pagamento em excesso de uma fatura vai para o Invoise junto com a taxa, não para o seu destinatário.

Use uma loja sandbox para testar a integração sem fundos reais.