Docs
Pix Key Validation v1

Paying Pix v1

Before sending money with our payment solution, it's important to ensure you are paying to the right person and no mistake is made with Pix Keys.

PixKeys refer to the alias or ID used by Pix to route the payment to the appropriate bank account. PixKeys can be of different forms CPF or CNPJ that are local personal or company Ids (to be used just with numbers and no special simbols), email, phone number (to be included with +55), and also a random key with numbers and letters.

With this endpoint, passing the pix key you will receive the name of the bank account owner for verification.

Path Parameters

pix_key
required
string

Alias or ID used by Pix to route the payment.

const pix_key = "mati@kamipay.io"
 
const url = `${baseURL}/v1/payments/pixKeyValidation?pix_key=${pixKey}`
 
const response = await fetch(url, {
      method: "GET",
      headers: {
      Authorization: `Bearer ${access_token}`,
      "Content-Type": "application/json",
    },
})

Response samples

{
  "msg": "valid pix_key",
  "reformated_key": "mati@kamipay.io",
  "name": "PAULO SERGIO"
}
Address BalanceCharge