Editar chave Pix - INDIRETOS

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.

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

Alteração de Chaves Pix - Clientes

put

Endpoint para alteração de chaves Pix de cliente.

Authorizations

Path parameters

chavestringRequired

Chave que será alterada.

Header parameters

Chave-IdempotenciastringRequired

Chave de idempotência para garantir a unicidade da requisição.

Body

keystringOptional

Chave Pix a ser alterada.

Example: 12345678901

ispbstringOptional

ISPB da instituição financeira da chave a ser alterada.

Example: 00000000

newAgencystring | nullableOptional

Novo número da agência (opcional).

Example: 0001

newAccountTypestring · enum | nullableOptional

Novo tipo de conta (opcional).

Example: CONTA_CORRENTEPossible values:

newAccountstring | nullableOptional

Novo número da conta (opcional).

Example: 12345-6

dateOpenAccountstring · date-time | nullableOptional

Nova data e hora de abertura da conta (opcional).

Example: 2023-10-26T10:00:00Z

newNamestring | nullableOptional

Novo nome do titular (opcional).

Example: Novo Nome

newCompanyNamestring | nullableOptional

Novo nome fantasia da empresa (opcional).

Example: Nova Empresa Fantasia

reasonstring · enumOptional

Motivo da alteração da chave.

Example: SOLICITACAO_CLIENTEPossible values:

Responses

200

Chave alterada com sucesso.

400

Requisição inválida.

401

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

404

Chave não encontrada.

409

Conflito ao alterar a chave (ex. chave já existente com os novos dados).

500

Erro interno do servidor.

put

HTTPcURLJavaScriptPython

PUT /internal/api/v1/keys/dict/:{chave} HTTP/1.1
Host: sandbox.globalscm.app.br
Authorization: Bearer YOUR_SECRET_TOKEN
Chave-Idempotencia: text
Content-Type: application/json
Accept: */*
Content-Length: 250

{
  "key": "12345678901",
  "ispb": "00000000",
  "newAgency": "0001",
  "newAccountType": "CONTA_CORRENTE",
  "newAccount": "12345-6",
  "dateOpenAccount": "2023-10-26T10:00:00Z",
  "newName": "Novo Nome",
  "newCompanyName": "Nova Empresa Fantasia",
  "reason": "SOLICITACAO_CLIENTE"
}

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.