Cadastro Chave de PIX do Proprietario

Realiza o cadastro de chave PIX do Proprietario

Request

• ENDPOINT: Pix/CadastrarChaveProprietario
• VERBO: POST

Índice	Chave	Descrição	Elem.	Tipo	Ocor.	Tam.	Versão
1	CNPJAplicacao	CNPJ para autenticação	E	Caractere	1-1	14	1.0
2	Token	Gerado a partir do CNPJ de autenticação para validar permissões de acesso	E	Caractere	1-1	100	1.0
3	CPFCNPJProprietario	CPF/CNPJ do Proprietário	E	Caractere	1-1	14	1.0
4	Chave*	Chave PIX	E	Caractere	1-1	100	1.0
5	Tipo	Enum de tipo de chave PIX, podendo ser: 0: CPF; 1: CNPJ; 2: Telefone; 3: Email; 4: Evp (Aleatória); 5: Agencia e Conta.	E	Inteiro	1-1	10	1.0
6	DocumentoUsuarioAudit	Documento do usuário que está realizando a operação	E	Caractere	1-1	14	1.0
7	NomeUsuarioAudit	Nome do usuário que está realizando a operação	E	Caractere	1-1	60	1.0
8	Agencia	Agência da conta para cadastro da chave PIX quando o tipo informado for 5.	E	Caractere	1-1	20	1.0
9	Conta	Conta para cadastro da chave PIX quando o tipo informado for 5. Informar também o dígito verificador junto, sem espaço e sem hífen.	E	Caractere	1-1	20	1.0
10	CodBanco	Código do banco para cadastro da chave PIX quando o tipo informado for 5.	E	Caractere	1-1	3	1.0

*Obs: Todos os campos são obrigatórios a menos que o tipo da chave seja Evp (aleatoria), Nesse caso o campo chave é opcional.

Modelo de Json - Request

{
  "CnpjAplicacao": "",
  "Token": "",
  "CPFCNPJProprietario": "",
  "Chave": "",
  "Tipo": 0,
  "DocumentoUsuarioAudit": "",
  "NomeUsuarioAudit": ""
}

Modelo de Json - Request - Tipo 5 (Agência e conta)

{
  "Token": "jdhdhdjdndbddbshfbsugbusbgabgab",
  "CNPJAplicacao": "12345678901234",
  "DocumentoUsuarioAudit": "0000000000",
  "CPFCNPJProprietario": "0000000000000000",
  "Chave": null,
  "Tipo": 5,
  "Agencia": "12548",
  "Conta": "65842",
  "CodBanco": "001"
}

Obs: Para o tipo 5, todos os campos Agencia, Conta e CodBanco são obrigatórios. No campo Conta, o dígito verificador deve ser enviado junto ao número da conta, sem separação por espaço ou hífen.

Response

Índice	Chave	Descrição	Elem.	Tipo	Ocor.	Tam.	Versão
1	Sucesso	True: Caso não tenha acontecido nenhuma exceção ou validação no processo False: Qualquer validação ou exceção não tratada pelo sistema que impediu o processo de ser concluído	E	Booleano	1-1	True/False	1.0
2	Mensagem	Mensagem de retorno	E	Caractere	1-1	200	1.0

Modelo de Json - Response

{
  "Sucesso": true,
  "Mensagem": ""
}