Criar chave Pix

Esta documentação está obsoleta e não deve mais ser utilizada como referência. A nova versão atualizada está disponível em: 👉 https://desenvolvedores.globalscm.com.br/#tag/DICT-Internal/operation/DICT_NovaChavePOST

Recomendamos fortemente que você utilize apenas a documentação atualizada para garantir a integração correta com nossos sistemas.

Importante:

Para usar esta API, é necessário estar autenticado e incluir seu token de autenticação no cabeçalho da requisição. Consulte a documentação de Autenticação na plataforma para mais informações.

Autenticação.

O Sistema Cliente deve utilizar esta API para incluir uma Chave de Endereçamento. Antes de fazer uso desta API, é importante garantir que o Cliente final que está solicitando a inclusão da Chave:

• Seja o Titular da Conta Transacional ou tenha autoridade legal para operá-la.

• Possua autorização para solicitar essa ação.

Além disso, o Sistema Cliente deve assegurar que, caso a Chave de Endereçamento a ser incluída seja do tipo:

• Número de Telefone Celular, o Cliente seja o detentor do número.

• Endereço de E-mail, o Cliente seja o detentor do endereço de e-mail utilizado.

Como utilizar?

Para utilizar essa funcionalidade, siga estes passos simples. Abaixo, você encontrará exemplos de como realizar o processo de abertura de conta.

Requisição de exemplo

Criação de Chaves Pix - Clientes

post

Endpoint para criação de chaves de cliente.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

keyTypestring · enumOptional

Tipo de chave (CPFCNPJ, CELULAR, EMAIL).

Example: CPFPossible values:

reasonstring · enumOptional

Razão da criação da chave.

Example: SOLICITACAO_CLIENTEPossible values:

accountstringOptional

Número da conta associada à chave.

Example: 0000002

Responses

201

Chave criada com sucesso.

400

Requisição inválida.

401

Não autorizado. Token inválido ou ausente.

post

/internal/api/v1/keys/create

HTTPcURLJavaScriptPython

POST /internal/api/v1/keys/create HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "keyType": "CPF",
  "reason": "SOLICITACAO_CLIENTE",
  "account": "0000002"
}

No content

JSON Retorno Sucesso

{
    "key": "19da698e-0b52-45c4-92d1-dba3f90f6a4e",
    "dateCreateKey": "2024-03-02T18:09:06.785Z",
    "dateInitKey": "2024-03-02T18:09:06.785Z"
}

Detalhes sobre os parâmetro

1. keyType (Tipo de Chave): Este parâmetro indica o tipo de chave Pix a ser criada. No exemplo, "CELULAR" representa a utilização do número de celular como chave Pix.

2. key (Chave): Aqui é especificada a chave Pix em si. No exemplo, "[phone]" é o número de celular que está sendo utilizado como chave Pix.

3. ispb (Código ISPB): Este campo representa o Código ISPB da instituição financeira à qual a conta está associada. No exemplo, "11165756" é um exemplo de Código ISPB, sendo o código da GlobalSCM.

4. agency (Agência): A agência bancária associada à conta. No exemplo, "0001" representa o número da agência.

5. accountType (Tipo de Conta): Indica o tipo de conta bancária associada à chave Pix. No exemplo, "CONTA_CORRENTE" representa uma conta corrente.

6. account (Conta): Este é o número da conta bancária associada à chave Pix. No exemplo, "123456" é o número da conta.

7. dateOpenAccount (Data de Abertura da Conta): A data e hora em que a conta foi aberta. No exemplo, "2023-09-01T11:30:17.001Z" representa a data e hora de abertura da conta.

8. personType (Tipo de Pessoa): Indica se o titular da conta é uma pessoa física ou jurídica. No exemplo, "JURIDICA" representa uma pessoa jurídica.

9. cpfCnpj (CPF/CNPJ): Este campo é usado para fornecer o número de CPF (pessoa física) ou CNPJ (pessoa jurídica) do titular da conta. No exemplo, "64661297000119" é um exemplo de número de CNPJ.

10. name (Nome): O nome completo do titular da conta. No exemplo, "Fulano de tal" é o nome do titular.

11. reason (Motivo): Este campo indica o motivo pelo qual a chave Pix está sendo criada. No exemplo, "SOLICITACAO_CLIENTE" sugere que a criação da chave Pix foi solicitada pelo cliente.

Para o campo "keyType" (Tipo de Chave):

• CPF: Use este tipo quando a chave Pix for um número de CPF (Cadastro de Pessoa Física).

• CNPJ: Utilize este tipo quando a chave Pix for um número de CNPJ (Cadastro Nacional da Pessoa Jurídica).

• E_MAIL: Escolha este tipo quando a chave Pix for um endereço de e-mail.

• CELULAR: Utilize este tipo quando a chave Pix for um número de celular.

• EVP_ENDERECO_VIRTUAL_DE_PAGAMENTO: Este tipo é usado quando a chave Pix for um endereço virtual de pagamento.

Para o campo "accountType" (Tipo de Conta):

• CONTA_DE_PAGAMENTO: Este tipo é usado para contas de pagamento.

Para o campo "personType" (Tipo de Pessoa):

• FISICA: Utilize este tipo quando o titular da conta for uma pessoa física.

• JURIDICA: Escolha este tipo quando o titular da conta for uma pessoa jurídica.

Para o campo "reason" (Motivo):

• SOLICITACAO_CLIENTE: Este motivo indica que a criação da chave Pix foi solicitada pelo cliente.

• RECONCILIACAO: Utilize este motivo quando a criação da chave Pix for parte de um processo de reconciliação.