Simulação de reconhecimento de pedido de reivindicação

No fluxo de reivindicação de posse ou portabilidade de chave Pix, o Bankly ou a instituição financeira detentora da chave receberá o pedido de reivindicação e deverá fazer o seu reconhecimento (acknowledgement).

Como em produção o processo de reconhecimento ou recusa de pedido é automático por parte do Bankly, disponibilizamos em sandbox o endpoint de simulação de reconhecimento de pedido de reivindicação.

Desse modo, nosso parceiro poderá simular o fluxo completo de reivindicação de posse ou portabilidade de chaves.

Pré-requisito

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

Um pedido de reivindicação de posse ou portabilidade de chaves tenha sido criado.

Requisição

Requisição HTTP

POST https://api.sandbox.bankly.com.br/pix/stub/claim/acknowledge

curl --location 
--request POST 'https://api.sandbox.bankly.com.br/pix/stub/claim/acknowledge' \
--header 'accept: application/json' \
--header 'api-version: 1' \
--header 'Content-Type: application/json' \
--header 'x-bkly-pix-user-id: 47742663023' \
--header 'Authorization: Bearer Token' \
--data-raw '{
    "claimId": "47ce6878-c73f-4fad-a94b-3474d2e5b6e2",
    "claimType": "PORTABILITY",
    "addressingKey": {
        "type": "PHONE",
        "value": "+5523415162342"
    },
    "claimer": {
        "branch": "0001",
        "number": "15164",
        "bankISPB": "13140088",
        "holder": {
            "documentNumber": "47742663023"
        }
    },
    "donor": {
        "branch": "0001",
        "number": "540108",
        "bankISPB": "13140088",
        "holder": {
            "documentNumber": "47742663023"
        }
    },
    "status": "OPEN",
    "createdAt": "2023-01-11T14:38:47.2359473Z",
    "resolutionLimitDate": "2023-01-18T14:38:47.2359473Z", 
    "conclusionLimitDate": "2023-01-25T14:38:47.2359473Z" 
}'

Autorização

Por se tratar de um endpoint de simulação, a requisição não exige o uso de scope.

Cabeçalhos (Headers)

Nome	Descrição	Especificação
`api-version`	Obrigatório. Versão da API. Atualmente estamos na versão 1.0.	---
`Authorization`	Obrigatório. Token de autorização do tipo Bearer e formato JWT.	---
`x-bkly-pix-user-id`	Obrigatório. Informe o número do documento do cliente que está fazendo a requisição.	Insira apenas números, sem formatação.

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
`claimId`	`string`	Obrigatório. Identificador único do pedido. Este valor é retornado na criação de pedido de reivindicação de chave.	---
`claimType`	`string`	Obrigatório. Tipo do pedido, que pode ser portabilidade (PORTABILITY) ou reivindicação (OWNERSHIP).	---
`addressingKey`	`object`	Obrigatório. Objeto que contém as informações sobre a chave reivindicada.	--
`addressingKey.type`	`string`	Obrigatório. Tipo de chave de endereçamento do DICT. Exemplo: CPF, CNPJ, EMAIL, PHONE ou EVP.	---
`addressingKey.value`	`string`	Obrigatório. Valor da chave.	---
`claimer`	`object`	Obrigatório. Objeto que contém os dados do reivindicador da chave.	---
`claimer.branch`	`string`	Obrigatório. Número da agência bancária.	---
`claimer.number`	`string`	Obrigatório. Número da conta.	---
`claimer.bankISPB`	`string`	Obrigatório. ISPB da instituição financeira.	---
`claimer.holder`	`object`	Obrigatório. Objeto que contém informações sobre o titular da conta.	---
`claimer.holder.documentNumber`	`string`	Obrigatório. Número do documento do titular da conta.	Insira somente números, sem formatação.
`donor`	`object`	Obrigatório. Objeto que contém os dados do doador da chave.	---
`donor.branch`	`string`	Obrigatório. Número da agência bancária.	---
`donor.number`	string	Obrigatório. Número da conta.	---
`donor.bankISPB`	`string`	Obrigatório. ISPB da instituição financeira.	---
`donor.holder`	`object`	Obrigatório. Objeto que contém informações sobre o titular da conta.	---
`donor.holder.documentNumber`	`string`	Obrigatório. Número do documento do titular da conta.	Insira somente números, sem formatação.
`status`	`string`	Obrigatório. Situação do pedido.	---
`createdAt`	`string`	Obrigatório. Data em que o pedido foi realizado.	Formato YYYY-MM-DDTHH:mm:SS.
`resolutionLimitDate`	`string`	Obrigatório. Data limite para o doador de portabilidade realizar ações, como concluir ou cancelar o pedido de reivindicação.	Formato YYYY-MM-DDTHH:mm:SS.
`conclusionLimitDate`	`string`	Obrigatório. Data limite para o doador de posse e o reivindicador (tanto de posse como de portabilidade) confirmarem ou cancelarem o pedido.	Formato YYYY-MM-DDTHH:mm:SS.

🚧
Importante
Para garantir que a simulação funcione, no campo status, o parceiro deve informar o valor “OPEN”, e nos campos createdAt, resolutionLimitDate e conclusionLimitDate deve inserir as datas retornadas na requisição de criação pedido de reivindicação de chave Pix.

{
    "claimId": "47ce6878-c73f-4fad-a94b-3474d2e5b6e2",
    "claimType": "PORTABILITY",
    "addressingKey": {
        "type": "PHONE",
        "value": "+5523415162342"
    },
    "claimer": {
        "branch": "0001",
        "number": "15164",
        "bankISPB": "13140088",
        "holder": {
            "documentNumber": "47742663023"
        }
    },
    "donor": {
        "branch": "0001",
        "number": "540108",
        "bankISPB": "13140088",
        "holder": {
            "documentNumber": "47742663023"
        }
    },
		"status": "OPEN",
    "createdAt": "2023-01-11T14:38:47.2359473Z",
    "resolutionLimitDate": "2023-01-18T14:38:47.2359473Z", 
    "conclusionLimitDate": "2023-01-25T14:38:47.2359473Z" 
}

Resposta (Response)

O status code 201 indicará que a simulação foi realizada com sucesso.

Erros

Este endpoint não retorna erros. Caso ocorra algum problema na requisição, o evento a seguir não será disparado e o status da portabilidade não será alterado para WAITING_RESOLUTION.

Eventos

Após simular a requisição, caso obtenha sucesso, o parceiro receberá o evento PIX_CLAIM_WAS_ACKNOWLEDGED, que indica que o pedido de reivindicação foi reconhecido.

Trata-se do mesmo evento que é disparado no fluxo real, após o reconhecimento do pedido de reivindicação por parte da outra instituição financeira, mas com dados fictícios.

📘
Nota
Lembre-se de que é preciso configurar o webhook para receber o evento.