GET /v1/pix/keys/{accountId}

Nosso endpoint de consulta de chave PIX permite que as empresas verifiquem facilmente quais chaves PIX estão registradas em suas contas no Agavos.

Ao usar nosso endpoint de consulta de chave PIX, as empresas podem obter rapidamente informações atualizadas sobre quais chaves PIX estão associadas a suas contas, o que simplifica o processo de recebimento de pagamentos por meio do PIX.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • code integer
    • data array[object]
      Hide data attributes Show data attributes array[object]
      • acccount string
      • key string
      • pixType string

        Values are PHONE, EMAIL, RANDOM, CNPJ, or CPF.

      • status string
GET /v1/pix/keys/{accountId} 
curl \
 -X GET https://sandbox.agavos.com.br/v1/pix/keys/{accountId} \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "code": 0,
  "data": [
    {
      "acccount": "123321312312312312",
      "key": "123-3214-1234-123-123",
      "pixType": "RANDOM",
      "status": "REGISTERED"
    },
    {
      "acccount": "12312421312312312312",
      "key": "teste@teste.com.br",
      "pixType": "EMAIL",
      "status": "REGISTERED"
    }
  ]
}
Response examples (200) 
{
  "code": 0,
  "data": [
    {
      "key": "123-3214-1234-123-123",
      "status": "REGISTERED",
      "pixType": "RANDOM",
      "acccount": "123321312312312312"
    },
    {
      "key": "teste@teste.com.br",
      "status": "REGISTERED",
      "pixType": "EMAIL",
      "acccount": "12312421312312312312"
    }
  ]
}