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é-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- O cliente de nosso parceiro possua uma conta ativa.
Requisição
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:
| Scope | Descrição |
|---|---|
legal.agreements.accept | Concede acesso para realizar o aceite dos acordos. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
api-version | Versão da API. Atualmente estamos na versão 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
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:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
acceptance | object | Obrigatório. Objeto que deverá conter informações sobre o aceite realizado pelo cliente (titular da conta). | — |
acceptance.document | object | Obrigatório. Objeto que deverá conter informações sobre o documento do cliente. | — |
acceptance.document.value | string | Obrigatório. Número do documento (CPF ou CNPJ). | Tamanho máximo de 14 caracteres. |
acceptance.account | object | Obrigatório. Objeto que deverá conter informações sobre a conta do cliente. | — |
acceptance.account.number | string | Obrigatório. Número da conta. | Tamanho máximo de 13 caracteres. |
acceptance.account.branch | string | Obrigatório. Agência bancária. | Tamanho máximo de 4 caracteres. |
type | string | Tipo de acordo aceito pelo cliente. Importante: este campo não é obrigatório, porém se for enviado, informe o valor "TERMS_AND_CONDITIONS_OF_USE" (termos e condições de uso). | — |
{
"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:
| Nome | Tipo | Descrição | Número máximo de caracteres |
|---|---|---|---|
id | string | Identificador único do acordo legal aceito pelo cliente, no formato uuid. | 36 |
{
"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:
| Status code | Código | Mensagem | Descrição |
|---|---|---|---|
| 404 | — | — | Conta não encontrada. |
| 422 | AGREEMENT_ALREADY_ACCEPTED | Agreement already accepted for this account. | Acordo já foi aceito anteriormente. |
| 422 | ACCOUNT_DOES_NOT_BELONG_TO_HOLDER | Account does not belong to account holder | A conta não pertence ao titular informado. |
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 é:
| Nome do evento | Descrição |
|---|---|
| LEGAL_AGREEMENT_WAS_ACCEPTED | Este evento sinaliza que o acordo legal foi aceito pelo cliente. |
Updated about 1 month ago