Documentação das APIs

Consulta os produtos por nome

O método de produto é uma maneira de simplificar as cobranças, podendo criar uma cobrança padrão para determinado cliente. O produto possui dois tipos: avulso e assinatura.
Avulso: É uma cobrança realizada diretamente com a inserção de todos os dados referente a mesma.
Assinatura: É uma cobrança realizada apenas uma única vez e será disparada automaticamente para o cliente conforme suas informações pré-estabelecidas.
Esta API permite a consulta dos produtos por nome.

Requisição

CampoTipoDescrição
nomeContainsTextoNome do produto, aceita consulta parcial

Resposta

CampoTipoDescrição
IdNuméricoIdentificador único do produto
NomeTextoNome do produto
TiposTextoTipo do produto avulso ou assinatura
MultaNuméricoPorcentagem da multa colocada no produto
JurosMesNuméricoPorcentagem dos juros por mês
DescontoAteVencimentoNuméricoDesconto aplicado até a data do vencimento
NotificacaoCobrancaDiasNuméricoDias antes do vencimento da cobrança para enviar a notificação
NotificacaoCobrancaEmailBoleanoSe esta opção estiver marcada o cliente receberá uma notificação via e-mail
NotificacaoCobrancaSMSBoleanoSe esta opção estiver marcada o cliente receberá uma notificação via SMS
NotificacaoCobrancaCartaImpressaBoleanoSe esta opção estiver marcada o cliente receberá uma notificação via carta
PrimeiraTentativaHabilitadaBoleanoPrimeira tentativa de notificação com os dias vencidos
PrimeiraTentativaDiasNuméricoNúmero de dias vencidos
PrimeiraTentativaEmailBoleanoPrimeira tentativa de notificação com os dias vencidos via e-mail
PrimeiraTentativaSMSBoleanoPrimeira tentativa de notificação com os dias vencidos via SMS
SegundaTentativaHabilitadaBoleanoSegunda tentativa de notificação com os dias vencidos
SegundaTentativaDiasNuméricoNúmero de dias vencidos
SegundaTentativaEmailBoleanoSegunda tentativa de notificação com os dias vencidos via e-mail
SegundaTentativaSMSBoleanoSegunda tentativa de notificação com os dias vencidos via SMS
TerceiraTentativaHabilitadaBoleanoTerceira tentativa de notificação com os dias vencidos
TerceiraTentativaDiasNuméricoNúmero de dias vencidos
TerceiraTentativaEmailBoleanoTerceira tentativa de notificação com os dias vencidos via e-mail
TerceiraTentativaSMSBoleanoTerceira tentativa de notificação com os dias vencidos via SMS
QuartaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos
QuartaTentativaDiasNuméricoNúmero de dias vencidos
QuartaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail
QuartaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS
QuintaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos
QuintaTentativaDiasNuméricoNúmero de dias vencidos
QuintaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail
QuintaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS
SextaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos
SextaTentativaDiasNuméricoNúmero de dias vencidos
SextaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail
SextaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS
SetimaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos
SetimaTentativaDiasNuméricoNúmero de dias vencidos
SetimaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail
SetimaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS
OitavaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos
OitavaTentativaDiasNuméricoNúmero de dias vencidos
OitavaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail
OitavaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS
NonaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos
NonaTentativaDiasNuméricoNúmero de dias vencidos
NonaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail
NonaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS
DecimaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos
DecimaTentativaDiasNuméricoNúmero de dias vencidos
DecimaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail
DecimaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!