PIX Keys

Cadastrar chave Pix em ambiente homologado

Solicita o cadastro de uma chave Pix para a conta referenciada nos headers de conta.

POST/integration/v1/pix/key

Corpo da requisição

Campo	Tipo	Descrição
pixType*	integer	Tipo da chave Pix: 1=CPF/CNPJ, 2=EMAIL, 3=PHONE, 4=EVP.
key	string	Chave Pix. O formato depende do tipo: - CPF/CNPJ (1): somente dígitos, sem máscara — ex.: `12345678909`. - E-mail (2): endereço literal — ex.: `fulano@empresa.com.br`. - Telefone (3): formato E.164, com código do país — ex.: `+5511999999999`. - Aleatória/EVP (4): UUID — ex.: `4f9f1d18-a87e-4667-9c43-8b0123456789`. Obrigatório para EMAIL e PHONE. Para EVP (aleatória) pode ser omitido — a chave é gerada pelo PSP.
notify	boolean	Exemplo: true
metadata	object	Exemplo: {"correlationId":"pix-key-001"}

Exemplo de requisição

curl -X POST https://apiapp.dev.ideabank.com.br/integration/v1/pix/key \
  -H "Authorization: Bearer $TOKEN" \
  -H "tenantid: $TENANT_ID" -H "hostdevelop: apiapp.dev.ideabank.com.br" -H "Content-Type: application/json" \
  -d '{
  "pixType": 2,
  "key": "+5511999999999",
  "notify": true,
  "metadata": {
    "correlationId": "pix-key-001"
  }
}'

Exemplo de resposta (200)

{
  "key": "+5511999999999",
  "type": 2,
  "status": 2,
  "name": "Empresa Cliente LTDA",
  "taxIdentifier": "12345678000195",
  "bank": "Idea+Cash PSP",
  "endToEndId": "E18236120202406111234S9X8Y7Z6W5V4U3",
  "txId": "TX1234567890ABCDEF1234567890",
  "qrCodeType": "DYNAMIC",
  "description": "Recebimento de cobrança Pix",
  "availableRefundAmount": 150.25
}

Códigos de resposta

HTTP	Descrição
200	Chave Pix cadastrada com sucesso
401
403
409
422
500

Fonte

Esta página é gerada a partir do Swagger oficial. Para o payload autoritativo, consulte também a especificação viva.

← Voltar para o índice