Aceite do acordo legal

Este endpoint permite ao parceiro enviar ao Bankly o consentimento do cliente referente ao acordo legal apresentado.

Atualmente, somente deverá ser enviado o aceite dos termos e condições de uso da conta.

🚧

Importante

Recordamos que o documento de termos e condições de uso deve ser aplicado para cada conta individualmente.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

• O parceiro Bankly tenha obtido o documento do acordo legal por meio do endpoint Obtenção do documento (acordo legal) e o tenha disponibilizado para o consentimento do cliente;
• O cliente tenha formalizado a aceitação do acordo legal.

Requisição (Request)

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/legal-agreements/accept

--request POST \
--url 'https://api-mtls.sandbox.bankly.com.br/legal-agreements/accept' \
--header 'Authorization: Bearer {Token}' \
--header 'api-version: 1.0' \
--data '{
    "acceptance": {
        "document": {
            "value": "47742663023"
        },
        "account": {
            "number": "15164",
            "branch": "0001"
        }
    },
    "type": "TERMS_AND_CONDITIONS_OF_USE"
}'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

{
    "acceptance": {
        "document": {
            "value": "47742663023"
        },
        "account": {
            "number": "15164",
            "branch": "0001"
        }
    },
    "type": "TERMS_AND_CONDITIONS_OF_USE"
}

Resposta (Response)

O status code 200 indicará que a solicitação foi aceita com sucesso.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

{
    "id": "aae3ada7-9c4a-4184-b46e-1ab8d8009a4b"
}

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. O evento é: