Redes e tokens

Escolha uma rede e um token pela API antes de criar uma fatura ou depósito. O nome do token sozinho não basta: a requisição precisa do endereço dele nessa rede.

Leia as redes disponíveis

curl 'https://platform.invoise.me/api/v1/networks'

Use estes campos de cada rede:

Campo	Finalidade
chain_id	ID da rede.
family	solana ou tron para essas redes; ausente ou evm para redes EVM.
tokens[].address	endereço do token: um contrato em EVM e Tron, um mint em Solana.
tokens[].decimals	número de casas decimais.
tokens[].status	prontidão, quando presente. Use ativos ready para pagamentos reais.
minimum_payment	o menor valor de fatura nessa rede, em tokens inteiros.

O catálogo público descreve as redes configuradas. Um lojista pode ter um conjunto habilitado menor; verifique GET /api/v1/merchants/{merchant_id}/networks com uma sessão durante a configuração. A API rejeita a criação de fatura ou depósito em uma rede ou ativo indisponível.

Solana e Tron precisam de um destinatário definido na loja antes da primeira fatura. Veja Solana e Tron.

Redes e tokens mudam por meio das configurações da plataforma. Leia a disponibilidade, os endereços e as casas decimais na API ao selecionar um ativo; não mantenha uma lista fixa.

Valor mínimo de pagamento

minimum_payment é um número inteiro de tokens, por exemplo "1". Uma fatura abaixo dele retorna 400 amount_below_minimum. As duas listagens de rede o retornam. O valor difere entre redes e pode mudar, então leia-o em vez de fixá-lo no código.

Formate o valor

Os valores de pagamento são strings de números inteiros nas menores unidades do token:

Casas decimais do token	10 tokens na requisição
6	"10000000"
18	"10000000000000000000"

Não envie "10.5". Com 6 casas decimais, 10,5 tokens é "10500000". Use aritmética de inteiros (BigInt em JavaScript) para os valores da API; números de ponto flutuante podem perder precisão.

Uma exceção: uma fatura que oferece vários tokens ou redes aceita um valor de token decimal, como "10.5". Veja vários tokens ou redes.

Leia taxas e limites de repasse

curl 'https://platform.invoise.me/api/v1/shops/{shop_id}/terms' \
  -H 'Authorization: Bearer ivk_...'

A resposta lista as condições por rede:

Campo	Finalidade
invoice e deposit	configurações de taxa: bps, minimum, maximum.
sweep_threshold	quanto um depósito precisa acumular antes de um repasse ser agendado.
minimum_sweep e maximum_sweep	a faixa anunciada para essa configuração.

bps significa centésimos de porcentagem: 50 bps = 0,5%. minimum e maximum da taxa usam unidades de dezoito casas decimais, independentemente das casas decimais do token; 10000000000000000 significa uma taxa de 0,01 token. sweep_threshold é um valor de token legível por humanos, como "1".

A taxa máxima não é o valor máximo de pagamento. Mantenha taxas, valores de fatura e limites de repasse separados.