List PIX Keys

List PIX keys for a bank account.

Endpoint

GET /pix/key/list

Authentication

Merchant Credential. See Authentication.

Request headers

Name	In	Type	Required	Description	Example
X-Nonce	header	string	Yes		a9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e
X-Merchant-Id	header	string	Yes		2492265300
X-Timestamp	header	string	Yes		1638123456
Digest	header	string	Yes		SHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q=
Authorization	header	string	Yes		Signature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY="

Query parameters

Name	In	Type	Required	Description	Example
bankAccount	query	number	No	Bank account number	401050
bankBranch	query	number	No	Branch number, 4 digits	1

Response

HTTP 200 — Success

Field	Type	Required	Description
status	integer	Yes
data	array	Yes

Response example

{
  "status": 200,
  "data": [
    {
      "key": "dccd9074-XXXX-XXXXX-232851c81804",
      "name": "GK XXXXXXE LTDA",
      "document": "51***4290001**"
    },
    {
      "key": "989549be-1487-XXXX-XXXXX--c821f2db000f",
      "name": "GK XXXXXX LTDA",
      "document": "51***4290001**"
    }
  ]
}