Alteração do usuário

Este endpoint permite realizar a alteração do usuário da conta pocket.

Pré-requisito

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

O cliente possua uma conta pocket ativa.

Requisição (Request)

Requisição HTTP

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

--request PATCH \
--header 'https://api-mtls.sandbox.bankly.com.br/pockets/1516482BRL/users' \
--header 'api-version: 2' \
--header 'Authorization: Bearer {authToken}' \
--header 'Content-Type: application/json' \
--data-raw '{
	"data": {
    "name": "**Maria Quitéria de Jesus**",
      "document":{
        "value": "09992220074",
        "type": "CPF"
        },
      	"birthDate": "1792-07-27T00:00:00Z"
      },
     "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:

Scope	Descrição
`pocket.update`	Concede acesso para a alteração do usuário das contas pockets.

Cabeçalhos (Headers)

Nome	Descrição
`api-version`	Obrigatório. A versão desta API é a 2.0.
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

Nome	Tipo	Descrição
`pocketNumber`	`path`	Obrigatório. Número da conta pocket.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`data`	`object`	Obrigatório. Objeto que contém informações sobre a conta pocket.
`data.name`	`string`	Obrigatório. Nome do novo usuário da pocket.
`data.document`	`object`	Obrigatório. Objeto que contém informações sobre o documento do novo usuário.
`data.document.value`	`string`	Obrigatório. Número do documento.
`data.document.type`	`string`	Obrigatório. Tipo do documento (CPF ou CNPJ).
`data.birthDay`	`string`	Obrigatório. Data de nascimento do usuário, no formato ISO 8601 - UTC.

{
    "data": {
       "name": "**Maria Quitéria de Jesus**",
       "document":{
           "value": "09992220074",
           "type": "CPF"
        },
        "birthDate": "1792-07-27T00:00:00Z"       
    },
    "metadata": {}
}

📘
Nota
O objeto metadata é um dicionário de metadados que possibilita o envio de dados adicionais na requisição. O uso desse campo é opcional.

Resposta (Response)

O status code 200 indicará que o usuário da conta pocket foi alterado com sucesso.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`data`	`object`	Objeto que contém informações sobre a conta pocket com novo usuário.
`data.number`	`string`	Número da conta pocket.
`data.label`	`string`	Nome da pocket.
`data.suffix`	`string`	Sufixo atribuído ao número da pocket. Exemplo: BRL.
`data.currency`	`string`	Código da moeda com base na ISO-4217. Exemplo: “BRL”.
`data.type`	`string`	Tipo da conta e sigla da moeda utilizada. Exemplo: POCKET_BRL.
`data.status`	`string`	Situação da conta pocket, que pode ser "ACTIVE", "DORMANT", 'LOCKED" e "CLOSED".
`data.reason`	`string`	Motivo da situação da conta pocket, que pode ser "HOLDER_REQUEST" (solicitação do titular) ou "COMMERCIAL_DISAGREEMENT" (desacordo comercial).
`data.category`	`string`	Categoria da conta.
`data.useCase`	`enum`	Especificação da finalidade da pocket, que pode ser “CORPORATE_EXPENSES” (despesas corporativas), “FLEXIBLE_BENEFITS” (benefícios diversos) e “BALANCE_SEGREGATION” (saldo reservado).
`data.createdAt`	`string`	Data de criação da pocket, no formato ISO 8601 - UTC.
`data.updatedAt`	`string`	Data de atualização da pocket, no formato ISO 8601 - UTC.
`data.user`	`objetc`	Objeto que contém informações sobre o novo usuário da conta pocket.
`data.user.name`	`string`	Nome do usuário.
`data.user.document`	`object`	Objeto que contém informações sobre o documento do usuário.
`data.user.document.value`	`string`	Número do documento.
`data.user.document.type`	`string`	Tipo do documento (CPF ou CNPJ).
`data.user.birthDate`	`string`	Data de nascimento do usuário, no formato ISO 8601 - UTC.
`data.account`	`object`	Objeto que contém informações sobre a conta de pagamento à qual a pocket está atrelada.
`data.account.branch`	`string`	Número da agência da conta de pagamento à qual a conta pocket está atrelada.
`data.account.number`	`string`	Número da conta de pagamento.
`data.account.status`	`string`	Situação da conta de pagamento que, nesse caso, será “ACTIVE”.
`data.account.reason`	`string`	Motivo da situação da conta de pagamento.
`data.account.createdAt`	`string`	Data de criação da conta de pagamento, no formato ISO 8601 - UTC.
`data.account.bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta pertence
`data.account.bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`data.account.bank.code`	`string`	Código do banco.
`data.account.bank.name`	`string`	Nome do banco.
`data.account.holder`	`object`	Objeto que contém informações sobre o titular da conta de pagamento.
`data.account.holder.document`	`object`	Objeto que contém informações sobre o documento do titular da conta de pagamento.
`data.account.holder.document.value`	`string`	Número do documento.
`data.account.holder.document.type`	`string`	Tipo de documento (CPF ou CNPJ).
`data.account.holder.type`	`string`	Tipo do cadastro do titular da conta de pagamento, que pode ser “CUSTOMER” ou “BUSINESS”.
`data.account.holder.name`	`string`	Nome do titular da conta de pagamento.
`data.account.holder.status`	`string`	Situação do cadastro do titular.
`data.account.holder.createdAt`	`string`	Data de criação do cadastro do titular, no formato ISO 8601 - UTC.
`links[]`	`array of objects`	Links de próximos estados válidos da entidade/recurso.
`links[].url`	`string`	URLs que podem ser utilizadas em um próximo estado da entidade.
`links[].rel`	`string`	Descrição de como a URL se relaciona com o recurso atual.
`links[].method`	`string`	Tipo de verbo que deve ser utilizado para acessar a URL.
`metadata`	`dictionary<string, object>`	Dicionário de metadados que trará dados adicionais da requisição.

{
    "data": {
        "number": "1516482BRL",
        "label": "Despesas familiares",
        "suffix": "BRL",
        "currency": "BRL",
        "type": "POCKET_BRL",
        "status": "ACTIVE",
        "reason": "HOLDER_REQUEST",
        "category": "POCKET",
        "useCase": "BALANCE_SEGREGATION",
        "createdAt": "2022-12-01T02:27:59.3638Z",
        "updatedAt": "2022-12-01T03:42:57.7091935Z",
        "user": {
            "name": "Maria Quitéria de Jesus",
            "document": {
                "value": "09992220074",
                "type": "CPF"
            },
            "birthDate": "1792-07-27T00:00:00Z"
        },
        "account": {
            "number": "15164",
            "branch": "0001",
            "status": "ACTIVE",
            "reason": "HOLDER_REQUEST",
            "createdAt": "2022-11-16T16:52:48.5972Z",
            "bank": {
                "ispb": "13140088",
                "code": "332",
                "name": "Acesso Soluções De Pagamento S.A."
            },
            "holder": {
                "document": {
                    "value": "47742663023",
                    "type": "CPF"
                },
                "type": "CUSTOMER",
                "name": "Nísia Floresta",
                "status": "ACTIVE",
                "createdAt": "2022-10-07T01:59:10.2588"
            }
        }
    },
    "links": [
        {
            "url": "/pockets/249378136BRL",
            "rel": "get_pocket",
            "method": "GET"
        }
    ],
    "metadata": {}
}

👍
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
422	POCKET_ACCOUNT_INVALID_STATUS	Pocket status {status} is invalid to handle this operation.	A conta pocket apresenta status inválido para essa operação.

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. Os eventos são:

Nome do evento	Descrição
`POCKET_ACCOUNT_USER_WAS_CHANGED`	Comunica que o usuário da conta pocket foi alterado.

Alteração do usuário

Pré-requisito

Requisição (Request)

Requisição HTTP

Autorização

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Corpo da requisição (Body)

📘
Nota

Resposta (Response)

👍
Dica

Erros

Eventos

Pré-requisito

Requisição (Request)

Requisição HTTP

Autorização

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Corpo da requisição (Body)

📘Nota

Resposta (Response)

👍Dica

Erros

Eventos

📘
Nota

👍
Dica