Saques

Validar Chave Pix

POST/v1/wallet/dict
Base URL Produção:https://api.validapay.com.br
Base URL Sandbox:https://sandbox.validapay.com.br

Autenticação

bearerAuthorizationstring · header · obrigatório

Envie no header:

Authorization: Bearer {{token}}

Verifica se uma chave Pix é válida e retorna os dados do titular antes de realizar uma transferência.

Consultar chave PIX (DICT)

Valida e retorna os dados cadastrados para uma chave PIX no Diretório de Identificadores de Contas Transacionais (DICT) do Banco Central. Use esta rota para confirmar se uma chave existe e exibir o nome do titular ao usuário antes de realizar uma transferência.

CampoObrig.TipoDescrição
pixKeystringChave PIX a ser consultada
pixKeyTypestringTipo da chave: CPF CNPJ EMAIL PHONE EVP

Body

application/json

Content-Type:application/json
{
  "pixKey": "joao@email.com",
  "pixKeyType": "EMAIL"
}

Schema

FieldTypeRequiredDescription
pixKey
string-
-
pixKeyType
string-
-

Headers

NameTypeValueRequired
Content-Type-application/jsonOptional
const url = 'https://sandbox.validapay.com.br/v1/wallet/dict';

const options = {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {{token}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "pixKey": "joao@email.com",
  "pixKeyType": "EMAIL"
})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

200200
{
  "pixKey": "joao@email.com",
  "pixKeyType": "EMAIL",
  "owner": {
    "name": "João da Silva",
    "taxId": "***.456.789-**",
    "type": "NATURAL_PERSON"
  },
  "account": {
    "ispb": "12345678",
    "bankName": "Banco X",
    "branch": "0001",
    "accountNumber": "123456-7",
    "accountType": "CACC"
  }
}
404404
{
  "code": "PIX_KEY_NOT_FOUND"
}