Onboarding

A API para consulta de condições comerciais possibilita que seja consultado os limites, permissões e acordos entre as partes para determinado produto Pottencial.

Você pode testar agora as chamadas das APIs da Pottencial utilizando o Postman:

• Collection Download
• Environment de Sandbox Download

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.

Consultar condições comerciais

Obtém condições comerciais para determinado produto Pottencial.

Requisição (Request)

Resposta (Response)

Exemplo

[
    {
        "key": "CommissionPercentage",
        "default": 0.23,
        "min": 0.23,
        "max": 0.3,
        "description": "Percentual de comissão"
    },
    {
        "key": "PaymentType",
        "default": "Boleto",
        "description": "Forma de pagamento"
    },
    {
        "key": "MaxInterestFreeInstallments",
        "default": 5,
        "description": "Número máximo de parcelas sem juros"
    },
    {
        "key": "MultiPaymentType",
        "default": [
            "Boleto",
            "Debit"
        ],
        "description": "Formas combinadas de pagamento (1ª e demais parcelas)"
    }
]

Consultar compromissos

Obtém compromissos disponíveis para determinado produto.

Requisição (Request)

Resposta (Response)

Exemplo

[
    {
        "name": "Empresa X S.A.",
        "documentNumber": "02299555000444",
        "defaultPercentage": 0,
        "minPercentage": 0,
        "maxPercentage": 0.25
    },
    {
        "name": "Empresa Y S.A.",
        "documentNumber": "00333311000111",
        "defaultPercentage": 0,
        "minPercentage": 0,
        "maxPercentage": 0.25
    }
]

Dicionário

CommercialConditionsResponse

AppointmentsResponse

Resolução de erros

ErrorResult

Representa um resultado de erro na chamada da plataforma.

ErrorMessage

Contém informações de um erro.