Consultar todas as chaves Pix de uma conta

Importante:

Para usar esta API, é necessário estar autenticado e incluir seu token de autenticação no cabeçalho da requisição. Consulte a documentação de Autenticação na plataforma para mais informações.

Autenticação.

O Sistema Cliente deve utilizar esta API para listar as Chaves de Endereçamento associadas a uma Conta Transacional e a um Cliente do PSP. Antes de consumir esta API, é importante que o Sistema Cliente verifique se o Cliente final que está requisitando a consulta possui autorização para essa ação e se é o titular da Conta Transacional ou tem poderes legais para operá-la.

Como utilizar?

Para utilizar essa funcionalidade, siga estes passos simples. Abaixo, você encontrará exemplos de como realizar o processo de abertura de conta.

Requisição de exemplo

Consultar todas as chaves Pix de uma conta

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"account":"0000002","accountType":"CORRENTE","agency":"0001","cpfCnpj":"41014420000104","ispb":"11165756","personType":"FISICA"}

Responses

200

successful

No content

401

authorization failed

422

validation failed

500

unknown server error

post

/internal/api/v1/keys/list

HTTPcURLJavaScriptPython

POST /internal/api/v1/keys/list HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "account": "0000002",
  "accountType": "CORRENTE",
  "agency": "0001",
  "cpfCnpj": "41014420000104",
  "ispb": "11165756",
  "personType": "FISICA"
}

No content

JSON Retorno Sucesso

[
	{
		"name": "DAVI CONSULIN",
		"key": "[phone]",
		"keyType": "CELULAR",
		"dateCreateKey": "2023-10-04T12:38:38.727Z",
		"dateInitKey": "2023-10-04T12:38:38.723Z"
	},
	{
		"name": "DAVI CONSULIN",
		"key": "41014420000104",
		"keyType": "CNPJ",
		"dateCreateKey": "2023-10-04T16:42:12.600Z",
		"dateInitKey": "2023-09-28T12:48:26.515Z"
	},
	{
		"name": "DAVI CONSULIN",
		"key": "6acae863-5d86-43df-80c5-2210aedb2e80",
		"keyType": "ENDEREÇO VIRTUAL DE PAGAMENTO",
		"dateCreateKey": "2024-02-19T03:07:27.491Z",
		"dateInitKey": "2024-02-19T03:07:27.491Z"
	},
	{
		"name": "DAVI CONSULIN",
		"key": "[email protected]",
		"keyType": "E-MAIL",
		"dateCreateKey": "2023-11-14T19:25:41.354Z",
		"dateInitKey": "2023-11-14T19:25:41.352Z"
	}
]