Financial

Pré-requisitos

Antes de começar a utilizar a API, é fundamental compreender os requisitos de autenticação e obter as credenciais necessárias.
Certifique-se de revisar a seção de autenticação para garantir uma integração segura e bem-sucedida.

Listar cobranças existentes para o parceiro.

Permite listar as cobranças para o parceiro, incluindo boletos, faturas, débito em conta e cartão de crédito.

Produtos disponíveis

Lista de produtos disponíveis para listar cobranças existentes para o parceiro.

judicial-deposito-recursal: Judicial Depósito Recursal.
judicial-deposito-recursal-substituicao: Judicial Depósito Recursal Substituição.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/financial/v1/billings
Method	Get
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Query	policyNumber	string	Filtro por Identificador Único da Apólice/Endosso.
Query	payerDocumentNumber	array (string)	CPF/CNPJ do participante da apólice.
Query	status	string	Define qual status do boleto deve retornar (Pending, Paid).
Query	PaymentStartDate	string (date-time)	Filtro por período inicial da data de vencimento do boleto no formato (YYYY-MM-DDTHH:mm:ss).
Query	PaymentEndDate	string (date-time)	Filtro por período final da data de vencimento do boleto no formato (YYYY-MM-DDTHH:mm:ss).
Query	skip	number	Número de registros para iniciar a consulta.
Query	take	number	Número de registros que devem ser retornados.

Respostas (Response)

Status	Descrição	Tipo
200	Lista de cobranças pendentes para o parceiro.	Billing
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo:

        
               [
                 {
                    "billingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "type": "Boleto",
                    "status": "Pending",
                    "documents": [
                           {
                              "type": "Policy",
                              "number": "string",
                              "installmentNumber": 0
                            }
                    ],
                    "issueDate": "string",
                    "dueDate": "string",
		    "paymentDate": "string",
                    "amount": 0,
                    "commissionAmount": 0,
                    "payer": {
                            "documentNumer": "string",
                            "name": "string"
                     }
                 }
               ]

Consultar o documento da cobrança

Permite consultar o documento da cobrança a partir do ID da cobrança.

Produtos disponíveis

Lista de produtos disponíveis para consultar o documento da cobrança a partir do ID da cobrança.

judicial-deposito-recursal: Judicial Depósito Recursal.
judicial-deposito-recursal-substituicao: Judicial Depósito Recursal Substituição.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/financial/v1/billings/{billing_id}/document
Method	Get
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Documento da cobrança localizado com sucesso.	BLOB
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Prorrogar a data de vencimento da cobrança.

Permite prorrogar a data de vencimento da cobrança.

Produtos disponíveis

Lista de produtos disponíveis para prorrogar a data de vencimento da cobrança.

judicial-deposito-recursal: Judicial Depósito Recursal.
judicial-deposito-recursal-substituicao: Judicial Depósito Recursal Substituição.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/financial/v1/billings/{billing_id}/extend
Method	Post
Query	billing_id	ID da cobrança.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	BillingExtension

Exemplo:

        
            {
                "dueDate": "2000-01-01"
            }

Respostas (Response)

Status	Descrição	Tipo
200	Boleto localizadoo com sucesso.	Billing
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Consultar o documento da cobrança a partir do ID da apólice

Permite consultar o documento da cobrança a partir do ID da apólice.

Caso a emissão de uma apólice gere um boleto, é necessário aguardar o processamento da geração do documento. A média de processamento é de aproximadamente 5 minutos.

Produtos disponíveis

Lista de produtos disponíveis para consultar o documento da cobrança a partir do ID da apólice

garantia-bid: Garantia Bid.
garantia-performance: Garantia Performance.
judicial-trabalhista: Judicial Trabalhista.
judicial-civel: Judicial Cível.
garantia-estendida: Garantia Estendida.
judicial-deposito-recursal: Judicial Depósito Recursal.
judicial-deposito-recursal-substituicao: Judicial Depósito Recursal Substituição.
maquinas-equipamentos: Riscos Diversos de Maquinas Equipamentos.
benfeitorias: Riscos Diversos de Benfeitorias.
penhor-rural: Riscos Diversos de Penhor Rural.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/financial/v1/billings/by-policy/{policy_id}/document
Method	Get
Path	policy_id	ID da Apólice.
Query	installmentNumber	Número da parcela (utilizado para os produtos: maquinas-equipamentos, benfeitorias e penhor-rural).
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Documento da cobrança localizado com sucesso.	BLOB
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Condições de pagamento.

Essa operação permite consultar as condições de pagamento>

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/financial/v1/billings/{product_key}/pricing/{quote_id}
Method	Get
Query	quote_id	ID da proposta.
	product_key	Chave de identificação do produto. Riscos Diversos Maquinas Equipamentos maquinas-equipamentos
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Lista formas de Pagamento para o parceiro.	Pricing
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplos

Resposta condição de pagamento


[
    {
        "paymentType": "Boleto",
        "installments": 1,
        "firstInstallmentAmount": 1503.43,
        "othersInstallmentsAmount": 0,
        "TaxesAmount": 0,
        "PremiumAmount": 1503.43
    },
    {
        "paymentType": "Boleto",
        "installments": 2,
        "firstInstallmentAmount": 153.34,
        "othersInstallmentsAmount": 153.35,
        "TaxesAmount": 30.06,
        "PremiumAmount": 1533.49
    },
    {
        "paymentType": "AutomaticDebit",
        "installments": 1,
        "firstInstallmentAmount": 1503.43,
        "othersInstallmentsAmount": 0,
        "TaxesAmount": 0,
        "PremiumAmount": 1503.43
    }
]

Dicionário

Billing

Contém informações de uma cobrança.

Campo	Tipo	Regras	Descrição
billingId	string (uuid)	Opcional	Identificador único da cobrança.
type	string (BillingType)	Somente leitura	Tipo da cobrança.
status	string (BillingStatus)	Somente leitura	Situação da cobrança.
documents	array de BillingDocument	Opcional	Documentos associados à cobrança.
issueDate	string (Date)	Opcional	Data de emissão da cobrança.
dueDate	string (Date)	Opcional	Data de vencimento da cobrança.
paymentDate	string (Date)	Opcional	Data de pagamento do Boleto.
amount	number	Opcional	Valor da cobrança.
commissionAmount	number	Opcional	Valor da comissão associada à cobrança.
payer	BillingPayer	Opcional	Informações da pessoa responsável pelo pagamento da cobrança.

BillingDocument

Contém informações de um documento associado a uma cobrança.

Campo	Tipo	Regras	Descrição
type	string (DocumentType)	Somente leitura	Tipo do documento.
number	string	Opcional	Número do documento associado à cobrança.
installmentNumber	number (Int32)	Opcional	Número da parcela da apólice associada à cobrança.

BillingStatus

Situação da cobrança.

Pending: A cobrança está em aberto, aguardando pagamento.
Paid: A cobrança foi paga pelo parceiro.

BillingType

Tipos de cobrança.

Boleto: Cobrança através de boleto bancário.
Invoice: Cobrança através de fatura.
CreditCard: Cobrança através de cartão de crédito.
Debit: Cobrança através de débito em conta.

DocumentType

Tipos de documento associado à cobrança.

Policy: Apólice.
Proposal: Proposta.

BillingExtension

Contém informações para prorrogação de um boleto.

Campo	Tipo	Regras	Descrição
dueDate	string (Date)	Obrigatório	Nova da de vencimento da cobrança.

BillingPayer

Contém informações do pagador de uma cobrança.

Campo	Tipo	Regras	Descrição
documentNumer	string	Opcional	CPF/CNPJ do pagador da cobrança.
name	string	Opcional	Nome do pagador da cobrança.

Pricing

Contém informações do parcelamento.

Campo	Tipo	Regras	Descrição
paymentType	string (PaymentType)	Opcional	Forma de pagamento da apólice.
installments	integer	Opcional	Número de parcelas que será dividido o pagamento da apólice. Os produtos possuem regras específicas para a quantidade de parcelas que pode ser divido o pagamento.
firstInstallmentAmount	number	Opcional	valor primeira parcela.
othersInstallmentsAmount	number	Opcional	valor das outras parcelas.
taxesAmount	number	Opcional	Valor Taxa dos Juros.
premiumAmount	number	Opcional	Valor total do premio.

PaymentType

Lista as possíveis formas de pagamento da apólice.

Invoice: Pagamento através de fatura.
Boleto: Pagamento através de boleto.
AutomaticDebit: Pagamento através de débito em conta.

Resolução de erros

Código	Erro	Descrição	Solução
400	Bad Request	Invalid secret in Authorization header	O client_secret informado no header é inválido. Verifique se o client_secret informado é o mesmo da APP e se o header Authorization está sendo passado conforme especificado.
401	Unauthorized	Could not find a required APP in the request, identified by HEADER client_id.	O client_id informado no header é inválido. Verifique se o client_id informado é o mesmo da APP e se o header Authorization está sendo passado conforme especificado.
404	Not Found	Not Found	Provavelmente a URL sendo chamado não está correta. Verifique se está conforme especificado.
415	Unsupported Media Type	Content type not supported	O header Content-Type não está sendo informado conforme esperado. O correto é application/json.
429	Too Many Requests	Too Many Requests	O consumidor estourou o limite de requisições por tempo. Aguarde um pouco para tentar novas requisições.
500	Internal Server Error	Internal Server Error	Erro não esperado, algo está quebrado na API. Por favor aguarde ou entre em contato com o time de suporte.

Estrutura da mensagem de erro

ErrorResult

Representa um resultado de erro na chamada da plataforma.

Campo	Tipo	Regras	Descrição
errors	array de ErrorMessage	Opcional	Lista de erros da solicitação.

ErrorMessage

Contém informações de um erro.

Campo	Tipo	Regras	Descrição
code	string	Opcional	Código de identificação do erro.
message	string	Opcional	Descrição do erro.

Idioma

Undefined

Financial

Formulário de busca

Financial

Pré-requisitos

Listar cobranças existentes para o parceiro.

Produtos disponíveis

Requisição (Request)

Respostas (Response)

Consultar o documento da cobrança

Produtos disponíveis

Requisição (Request)

Respostas (Response)

Prorrogar a data de vencimento da cobrança.

Produtos disponíveis

Requisição (Request)

Respostas (Response)

Consultar o documento da cobrança a partir do ID da apólice

Produtos disponíveis

Requisição (Request)

Respostas (Response)

Condições de pagamento.

Requisição (Request)

Respostas (Response)

Exemplos

Resposta condição de pagamento

Dicionário

Billing

BillingDocument

BillingStatus

BillingType

DocumentType

BillingExtension

BillingPayer

Pricing

PaymentType

Resolução de erros

Estrutura da mensagem de erro

ErrorResult

ErrorMessage

Menu do rodapé