Schemas

Mensagem legível.

O código a usar para ramificar. É ele que é estável, não o texto.

O resultado da consulta.

Saldo da carteira depois da cobrança.

Unidades restantes, quando o pagamento saiu de um pacote.

Presente e true quando esta resposta repete uma chamada anterior, sem nova cobrança.

Presente quando completed.

Presente quando failed.

Quanto foi estornado, quando houve cobrança.

Se havia consulta no histórico.

O identificador a enviar em consultation_type.

O contrato de input_data.

O campo que identifica o sujeito, quando há um.

O preço para a SUA conta, em reais.

Quando true, o POST devolve async e o resultado sai por GET /status.

De onde o pagamento sairia.

Se aquele documento já foi consultado. null quando não dá para saber.

Legenda para humano; pode ser reescrita.

O contrato: ramifique nele, nunca no texto.

A chave do depósito em todas as chamadas seguintes. Guarde.

O seu identificador, como você o enviou.

Nasce sempre assim: o vínculo vale quando o depósito aceitar.

É ele que distingue a repetição do cadastro novo — nunca o status.

O estado real naquele instante.

CNPJ, só dígitos.

active = o depósito aceitou e já recebe convites.

Quando o vínculo foi criado — não quando foi aceito.

Do vínculo mais recente para o mais antigo.

CNPJ, só dígitos.

Quantos fornecedores do depósito têm selo válido agora. A lista sai de /suppliers.

A vigência que esta forma paga.

No Pix, o valor à vista; no cartão, o total em 1x.

Só no Pix, e só quando maior que o valor: o preço de referência ("de … por …").

Só no cartão: cada opção de parcelamento.

Guarde: é o que o reenvio do convite pede.

O mesmo nome do primeiro dos estados do andamento e dos avisos.

O link que o fornecedor abre. Entregue-o como veio.

Em centavos de real. Depende do tipo de pessoa — não fixe no seu código.

As formas que o fornecedor verá na adesão, na ordem da página; a primeira é a de price_cents.

true = já havia convite vivo para o documento neste depósito, e ele voltou. Chamar de novo não duplica.

O que aconteceu com o NOSSO envio — informativo, nunca impede o convite: sent (saiu), sem_destinatario (o convite não trazia contact.email), nao_pedido (send_invite_email: false), reenvio_recente (o mesmo convite já recebeu um e-mail nos últimos minutos), undeliverable (o endereço não pode receber mensagens) e failed (tentamos e não saiu; o link da resposta vale).

CPF ou CNPJ, só dígitos.

O andamento — os nove estados. Não é o vocabulário de /distributor/seal.

Só em certified/expired.

Quando o selo acendeu pela primeira vez. Só em certified/expired.

A página pública do selo — a mesma que o QR do certificado abre. Só em certified/expired.

O número impresso no certificado. Só em certified/expired.

Uma linha por documento.

0 é resposta normal — também para um client_id fora do seu canal.

O documento normalizado, só dígitos.

true se o documento tem selo em pelo menos um depósito do seu canal.

null quando certified é false.

O mesmo link do convite — reenviar não cria convite novo.

O que aconteceu com o NOSSO envio — informativo, nunca impede o convite: sent (saiu), sem_destinatario (o convite não trazia contact.email), nao_pedido (send_invite_email: false), reenvio_recente (o mesmo convite já recebeu um e-mail nos últimos minutos), undeliverable (o endereço não pode receber mensagens) e failed (tentamos e não saiu; o link da resposta vale).

O documento normalizado, só dígitos.

true quando ao menos uma pessoa recebeu.

Quantas pessoas do fornecedor receberam o link agora — sem identificá-las.