Cadastro de chaves

A seguir, o formato de cada tipo de chave:

Tipo	Exemplo
CPF	12345678901
CNPJ	12345678901234
Chave Aleatória (EVP)	123e4567-e89b-12d3-a456-426655440000

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

Cadastro de CPF e CNPJ

Etapas

Endpoint

Para o consumo do endpoint de cadastro de chaves do tipo CPF e CNPJ, é preciso preencher os seguintes campos obrigatórios:

x-correlation-id: informe um GUID v4, gerado randomicamente. A cada requisição, deve-se gerar um novo GUID v4;
addressingKey:
- type: informe o tipo de chave, que pode ser CPF, CNPJ ou EVP;
- value: preencha com o valor da chave a ser criada.
account:
- branch: informe o número da agência;
- number: preencha com o número da conta;
- type: informe o tipo de conta. "CHECKING" para conta-corrente, "SALARY" para conta-salário, "SAVINGS" para conta-poupança e "PAYMENT" para conta de pagamento.

--location --request POST 'https://api-mtls.sandbox.bankly.com.br/pix/entries' \ 
--header 'Accept: application/json' \ 
--header 'Content-Type: application/json' \ 
--header 'api-version: 1.0' \ 
--header 'Authorization: Bearer {{access_token}} 
--data-raw '{ 
    "addressingKey": { 
        "type": "CPF", 
        "value": "12345678900" 
    }, 
    "account": { 
        "type": "CHECKING", 
        "branch": "0001", 
        "number": "1234" 
    } 
}'

--location --request POST 'https://api.sandbox.bankly.com.br/pix/entries' \ 
--header 'Accept: application/json' \ 
--header 'Content-Type: application/json' \ 
--header 'api-version: 1.0' \ 
--header 'Authorization: Bearer {{access_token}} 
--data-raw '{ 
    "addressingKey": { 
        "type": "CNPJ", 
        "value": "12345678900000" 
    }, 
    "account": { 
        "type": "CHECKING", 
        "branch": "0001", 
        "number": "187453" 
    } 
}'

Retorno

Quando as chaves de CPF e CNPJ são cadastradas com sucesso, o retorno é 201.

Cadastro de chave aleatória (EVP)

Etapas

Endpoint

Para o cadastro de chave tipo EVP, informe todos os campos obrigatórios citados anteriormente, exceto o campo value.

Caso o usuário queira cadastrar mais de uma chave EVP para a mesma conta, é necessário aguardar aproximadamente um minuto para que seja possível criar uma nova chave.

--location --request POST 'https://api-mtls.sandbox.bankly.com.br/pix/entries' \ 
--header 'Accept: application/json' \ 
--header 'Content-Type: application/json' \ 
--header 'api-version: 1.0' \ 
--header 'Authorization: Bearer {{access_token}}' \
--data-raw '{ 
    "addressingKey": { 
        "type": "EVP"
    }, 
    "account": { 
        "type": "CHECKING", 
        "branch": "{{branchNumber}}", 
        "number": "{{accountNumber}}" 
    } 
}'

Retorno

O retorno 201 indicará que sua chave foi criada com sucesso.

Erros

Status code	Código	Descrição
400	INVALID_PARAMETER	O valor informado para a chave não corresponde ao tipo de chave informado.
422	ADDRESSING_KEY_VALUE_AND_ACCOUNT_HOLDER_DOCUMENT_ARE_DIFFERENT	Quando o tipo de chave for CPF ou CNPJ, a chave de endereçamento deve ser igual ao documento do detentor da conta no Bankly.
422	ADDRESSING_KEY_TYPE_IS_INVALID_FOR_ACCOUNT_HOLDER_TYPE	O tipo de chave de endereçamento não é válido para esse tipo de conta.
422	TARGET_ACCOUNT_DOES_NOT_EXIST	A chave CPF/CNPJ informada é referente a uma conta não existente.
422	INVALID_ACCOUNT_STATUS	A chave de endereçamento só pode ser associada a contas com status ACTIVE.
422	INVALID_ACCOUNT_HOLDER_STATUS	A chave de endereçamento só pode ser associada a clientes com seu registro em status APPROVED.
422	MAXIMUM_ENTRIES_COUNT_REGISTERED_FOR_ACCOUNT	A conta atingiu o número máximo de registro de chaves de endereçamento.
422	ENTRY_ALREADY_EXISTS_TO_SAME_HOLDER_AND_ANOTHER_ACCOUNT	Essa chave de endereçamento já é utilizada por esse cliente, mas em outra conta. Considere fazer uma requisição de portabilidade.
422	ENTRY_ALREADY_EXISTS_TO_ANOTHER_HOLDER	Essa chave de endereçamento está associada a outro cliente. Considere fazer a reivindicação da chave.
422	ENTRY_ALREADY_EXISTS_TO_SAME_ACCOUNT	Chave de endereçamento já cadastrada para essa conta.
422	ENTRY_ALREADY_EXISTS_TO_SAME_OWNER_INTO_ANOTHER_PLAYER	Essa chave de endereçamento está sendo utilizada em outra instituição por esse mesmo cliente. Considere fazer uma requisição de portabilidade.
422	EVP_ENTRY_CANNOT_REGISTER_SHORT_INTERVAL	Para cadastrar mais de uma chave do tipo EVP, é necessário um intervalo de, aproximadamente, um minuto.
422	INVALID_USER_ID	User id inválido. Valide se o header x-bkly-pix-user-id é um CPF ou CNPJ válido.
422	PERMISSION_NOT_GRANTED	Permissão não concedida para realizar a operação.

📘Nota

Cadastro de CPF e CNPJ

Etapas

Endpoint

Retorno

Cadastro de chave aleatória (EVP)

Etapas

Endpoint

Retorno

Erros

📘
Nota