Documentação das APIs

Lista os sellers vinculados ao cliente logado

Esta API permite que você consulte informações sobre vendedores em uma plataforma de cobranças online.

Requisição

CampoTipoDescrição
NomeTextoNome do Seller
CpfCnpjTextoCPF ou CNPJ do Seller
PageTextoPágina da consulta

Resposta

CampoTipoDescrição
IdTextoId da cobrança
IdentificadorSequencialNúmeroIdentificador numérico da cobrança, não pode ser re-configurado
ClienteIdTextoId do cliente relacionado a cobrança
ClienteNomeTextoNome do cliente relacionado a cobrança, somente para retornar dados
DescricaoTextoDescrição da cobrança
ValorNúmeroValor da cobrança
CriacaoTextoData de criação da cobrança
VencimentoTextoData de vencimento da cobrança
NaoReceberDepoisDeTextoData para não aceitar pagamento da cobrança
TipoTextoTipo da cobrança, podendo ser = Todos, Avulsa, Assinatura, Link
EstadoTextoEstado da cobrança, podendo ser = Todos, Pendente, Paga, Inadimplente
FormasPagamentoTextoFormas de pagamento da cobrança, podendo ser = Nenhum, Boleto, Cartão, Pix, Manual, Protesto, SaldoWebConta
ProdutoIdTextoId do produto relacionado a cobrança
MultaNúmeroMulta percentual da cobrança
MultaCorrecaoTextoTipo da multa a ser aplicada, podendo ser= Percentual, Valor, Diário
JurosMesNúmeroJuros mensal percentual da cobrança
JurosCorrecaoTextoTipo do juros a ser aplicado, podendo ser= Percentual, Valor, Diário
DescontoAteVencimentoNúmeroDesconto percentual até o vencimento da cobrança
DescontoCorrecaoTextoTipo do desconto a ser aplicado, podendo ser= Percentual, Valor, Diário
DadosPagamentpagamentoDados do pagamento da cobrança, caso exista
NotificacaoCobrancaDiasNúmeroDias antes do vencimento para notificar
NotificacaoCobrancaEMailBoleanoNotificação via Email
NotificacaoCobrancaSMSBoleanoNotificação via SMS
NotificacaoCobrancaCartaImpressaBoleanoNotificação via Carta
PrimeiraTentativaHabilitadaBoleanoHabilitado primeira tentativa em atraso
PrimeiraTentativaDiasNúmeroDias primeira tentativa em atraso
PrimeiraTentativaEMailBoleanoEmail da primeira tentativa em atraso
PrimeiraTentativaSMSBoleanoSMS da primeira tentativa em atraso
SegundaTentativaHabilitadaBoleanoHabilitado segunda tentativa em atraso
SegundaTentativaDiasNúmeroDias segunda tentativa em atraso
SegundaTentativaEMailBoleanoEmail da segunda tentativa em atraso
SegundaTentativaSMSBoleanoSMS da segunda tentativa em atraso
TerceiraTentativaHabilitadaBoleanoHabilitado terceira tentativa em atraso
TerceiraTentativaDiasNúmeroDias terceira tentativa em atraso
TerceiraTentativaEMailBoleanoEmail da terceira tentativa em atraso
TerceiraTentativaSMSBoleanoSMS da terceira tentativa em atraso
QuartaTentativaHabilitadaBoleanoHabilitado quarta tentativa em atraso
QuartaTentativaDiasNúmeroDias quarta tentativa em atraso
QuartaTentativaEMailBoleanoEmail da quarta tentativa em atraso
QuartaTentativaSMSBoleanoSMS da quarta tentativa em atraso
QuintaTentativaHabilitadaBoleanoHabilitado quinta tentativa em atraso
QuintaTentativaDiasNúmeroDias quinta tentativa em atraso
QuintaTentativaEMailBoleanoEmail da quinta tentativa em atraso
QuintaTentativaSMSBoleanoSMS da quinta tentativa em atraso
SextaTentativaHabilitadaNúmeroHabilitado sexta tentativa em atraso
SextaTentativaDiasNúmeroDias sexta tentativa em atraso
SextaTentativaEMailBoleanoEmail da sexta tentativa em atraso
SextaTentativaSMSBoleanoSMS da sexta tentativa em atraso
SetimaTentativaHabilitadaBoleanoHabilitado sétima tentativa em atraso
SetimaTentativaDiasNúmeroDias sétima tentativa em atraso
SetimaTentativaEMailBoleanoEmail da sétima tentativa em atraso
SetimaTentativaSMSBoleanoSMS da sétima tentativa em atraso
OitavaTentativaHabilitadaBoleanoHabilitado oitava tentativa em atraso
OitavaTentativaDiasNúmeroDias oitava tentativa em atraso
OitavaTentativaEMailBoleanoEmail da oitava tentativa em atraso
OitavaTentativaSMSBoleanoSMS da oitava tentativa em atraso
NonaTentativaHabilitadaBoleanoHabilitado nona tentativa em atraso
NonaTentativaDiasNúmeroDias nona tentativa em atraso
NonaTentativaEMailBoleanoEmail da nona tentativa em atraso
NonaTentativaSMSBoleanoSMS da nona tentativa em atraso
DecimaTentativaHabilitadaBoleanoHabilitado decima tentativa em atraso
DecimaTentativaDiasNúmeroDias decima tentativa em atraso
DecimaTentativaEMailBoleanoEmail da decima tentativa em atraso
DecimaTentativaSMSBoleanoSMS da decima tentativa em atraso
imgBase64ImagemImagem
NumeroOperacaoTextoNúmero de toda a operação realiza
SplitValoreArray[SplitCobrancaRequest]-
ClientePagamentosIdTextoId do cliente de pagamento
Pagamento--
IdTextoId do pagamento
SituacaoTextoSituação do pagamento, podendo ser = pendente, pago, atrasado
DataPagamentoTextoData do pagamento
FormaPagamentoTextoForma de pagamento, podendo ser = Nenhum, Boleto, Cartão, Pix, Manual, Protesto, SaldoWebConta
DadosPagamentoTextoDados do pagamento
ValorPagoNúmeroValor pago de pagamento
ValorPrincipalNúmeroValor principal de pagamento
ValorMultaJurosNúmeroValor multa / juros de pagamento
NumeroPagamentoTextoNúmero do pagamento
ValorTaxasNúmeroValor das taxas de pagamento
ValorLiquidoNúmeroValor líquido de pagamento
DataDisponibilizacaoTextoData de disponibilização pagamento
ReembolsadoAoClienteBoleanoIndicação de reembolsado ao cliente do pagamento
AntecipadoBoleanoIndicativo se o pagamento foi antecipado
SplitCobrancaRequest--
ClientePagamentosIdTextoId do seller
ValorNúmeroValor pertencente ao seller na transação
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!