Encerramento de conta pocket

Este endpoint permite realizar o encerramento de uma conta pocket específica.

Quando o cliente solicita o encerramento de uma conta pocket, ocorrerá o encerramento técnico, que finaliza a conta pocket dentro da base de dados do Bankly e altera seu status para CLOSED.

Na sequência, será realizado o cancelamento completo, momento em que o saldo da conta pocket retorna para a conta de pagamento à qual ela está atrelada.

Requisição (Request)

Requisição HTTP

PATCH https://api-mtls.sandbox.bankly.com.br/pockets/{pocketNumber}/closure 

--request PATCH \
--url 'https://api-mtls.sandbox.bankly.com.br/pockets/1516482BRL/closure' \
--header 'accept: application/json' \
--header 'api-version: 2' \
--header 'authorization: Bearer' \
--header 'content-type: application/json' \
--data '
{
     "data": {
          "reason": "HOLDER_REQUEST"
     },
     "metadata": {}
}
'

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)

No path desta requisição, envie o seguinte campo:

Corpo da requisição (Body)

No body, envie o seguinte campo em formato JSON:

{
     "data": {
          "reason": "HOLDER_REQUEST"
     },
     "metadata": {}
}

📘

Nota

O objeto metadata exibido no exemplo é um dicionário de metadados e permite o envio de dados adicionais na requisição. O envio desse campo é opcional.

Resposta (Response)

O status code 204 indicará sucesso no processo de encerramento da pocket.

👍

Dica

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

Erros

Este endpoint pode retornar o seguinte erro, 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. Nesse caso, o evento é: