Cadastro de chaves

Este endpoint possibilita realizar o cadastro de chaves do tipo CPF, CNPJ, chave aleatória (EVP), telefone e e-mail.

A seguir, o formato de cada tipo de chave:

📘

Nota

Lembrando que a pessoa física pode cadastrar até cinco chaves para cada conta transacional. Já a pessoa jurídica pode registrar até 20 chaves.

Pré-requisitos

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

• O cliente possua uma conta ativa;
• A chave a ser cadastrada não esteja em uso nesta ou em outra instituição financeira.

Requisição (Request)

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/pix/entries

--request POST \
--uri 'https://api-mtls.sandbox.bankly.com.br/pix/entries' \ 
--header 'Accept: application/json' \ 
--header 'Content-Type: application/json' \ 
--header 'api-version: 1.0' \ 
--header 'x-correlation-id: {{GUID}}' \ 
--header 'Authorization: Bearer {{token}}' \ 
--data-raw '{ 
    "addressingKey": { 
        "type": "CPF", 
        "value": "47742663023" 
    }, 
    "account": { 
        "type": "CHECKING", 
        "branch": "0001", 
        "number": "502000027888",
        "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "Acesso Soluções De Pagamento SA - Instituição de Pagamento"
        }
    }
}'

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)

🚧

Importante

Para solicitação de cadastro de chaves do tipo e-mail e telefone, obrigatoriamente o parceiro precisa gerar o código para validação via TOTP antes da solicitação do cadastro. O hash gerado nessa etapa deve ser enviado no header x-bkly-transactional-hash.

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:

Chave de endereçamento

{ 
    "addressingKey": { 
        "type": "CPF", 
        "value": "47742663023" 
    }, 
    "account": { 
        "type": "CHECKING", 
        "branch": "0001", 
        "number": "15164" 
    } 
}

{ 
    "addressingKey": { 
        "type": "CNPJ", 
        "value": "12345678900000" 
    }, 
    "account": { 
        "type": "CHECKING", 
        "branch": "0001", 
        "number": "187453" 
    } 
}

{ 
    "addressingKey": { 
        "type": "EVP"
    }, 
    "account": { 
        "type": "CHECKING", 
        "branch": "0001", 
        "number": "187453" 
    } 
}

{ 
    "addressingKey": { 
        "type": "PHONE", 
        "value": "71911111111" 
    }, 
    "account": { 
        "type": "CHECKING", 
        "branch": "0001", 
        "number": "187453" 
    } 
}

{ 
    "addressingKey": { 
        "type": "EMAIL", 
        "value": "[email protected]" 
    }, 
    "account": { 
        "type": "CHECKING", 
        "branch": "0001", 
        "number": "187453" 
    } 
}

🚧

Importante

Em caso de cadastro de chave do tipo EVP, se o usuário quiser cadastrar mais de uma chave para a mesma conta, é necessário aguardar aproximadamente um minuto para um novo cadastro.

Resposta (Response)

O status code 201 indicará que a chave Pix foi cadastrada com sucesso.

👍

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

Este endpoint não possui eventos relacionados a ele.