PIX Transactions
Validar chave Pix para iniciação
Valida uma chave Pix antes da iniciação de pagamento e retorna os dados
GET/integration/v1/pix/key/validate
Parâmetros de query
| Campo | Tipo | Descrição |
|---|---|---|
| key* | string | Chave Pix a ser validada. Formato conforme o tipo: CPF/CNPJ somente dígitos; e-mail literal; telefone em E.164 (com +55); EVP em UUID. |
| pixKeyType* | integer | Tipo da chave: 1=CPF/CNPJ, 2=EMAIL, 3=PHONE, 4=EVP. |
Exemplo de requisição
curl -X GET https://apiapp.dev.ideabank.com.br/integration/v1/pix/key/validate \
-H "Authorization: Bearer $TOKEN" \
-H "tenantid: $TENANT_ID" -H "hostdevelop: apiapp.dev.ideabank.com.br"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 validada |
| 401 | |
| 403 | |
| 422 | |
| 500 |
Fonte
Esta página é gerada a partir do Swagger oficial. Para o payload autoritativo, consulte também a especificação viva.