Configuração fornecedor pagamento boleto a prazo

Este endpoint é responsável por configurar o método de pagamento via boleto a prazo. Ele permite indicar se o fornecedor aceita pagamento a prazo, bem como o maior prazo aceito, considerando prazo de 30, 60, 90 dias, entre outros. Além disso, este endpoint cofigura informações sobre os encargos mensais aplicáveis, como juros.

Método: POST

URI do Endpoint: https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/supplierConfiguration/bankSlipLongTermConfiguration

Requisição e Tipos de Dados

Tipo de Conteúdo da Requisição: application/json

Corpo da Requisição:

Para esse endpoint existem vários tipos de requisição, para cada momento do pedido, vamos exemplificar aqui.

1. enable: Indica se o fornecedor aceita ou não pagamento com boleto a prazo.
2. maxPaymentTerm: Configura o prazo aceito.
3. fee: Configura os encargos mensais.

Exemplo de Requisição:

{
"enable": true,
"maxPaymentTerm": 600,
"fee": 0
}

Possíveis Respostas

Códigos de Resposta e seus significados:

Status Code	Descrição
200	Sucesso: A requisição foi bem-sucedida.
400	Bad Request: Erro de validação ou processamento da requisição. Verifique o corpo da requisição.
401	Unauthorized: Autenticação necessária e não fornecida.
403	Forbidden: A requisição foi autenticada, mas o usuário não tem permissões para a ação.
502	Bad Gateway: O servidor, atuando como gateway ou proxy, recebeu uma resposta inválida do servidor upstream.

Exemplos de Respostas:

• Sucesso (200):

{
  "message": "string"
}

• Erro (400):

{
  "statusCode": 400,
  "message": "Erro de validação.",
  "errors": {
    "additionalProp1": ["Erro específico 1"],
    "additionalProp2": ["Erro específico 2"],
    "additionalProp3": ["Erro específico 3"]
  }
}

Cómo Testar o Endpoint

Para testar este endpoint, você pode usar ferramentas como Postman ou cURL. Siga as instruções abaixo:

1. Abra o Postman.

2. Selecione o método POST e insira a URL do endpoint.

3. No corpo da requisição, insira o JSON do exemplo fornecido.

4. Envie a requisição e observe a resposta.

Importante

Para um teste bem-sucedido, certifique-se de que você tem as credenciais corretas (se necessário) e que o corpo da requisição está corretamente formatado conforme o exemplo.

Este documento serve como um guia básico para entender e testar o endpoint específico. Ajuste as seções conforme necessário para se adequar ao seu ambiente de negócios e práticas de desenvolvimento.