Pular para o conteúdo principal
GET
Retrieve a Pix Key

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Account-Id
string<uuid>
obrigatório

Account ID (UUID format)

X-End-To-End-Id
string
obrigatório

End-to-end transaction identifier

Parâmetros de caminho

key
string
obrigatório

Pix key value (CPF, CNPJ, Email, or Phone)

Resposta

OK

account
object
obrigatório

Account information associated with this PIX key

creationDate
string<date-time>
obrigatório

When this PIX key entry was created

Exemplo:

"2024-01-15T10:30:00Z"

endToEndId
string
obrigatório

Unique identifier for the end-to-end transaction tracking

Exemplo:

"550e8400-e29b-41d4-a716-446655440003"

key
string
obrigatório

PIX key value that was registered

Exemplo:

"john.doe@example.com"

keyOwnershipDate
string<date-time>
obrigatório

When the customer became the owner of this PIX key

Exemplo:

"2024-01-15T10:30:00Z"

keyType
enum<string>
obrigatório

Type of this PIX key

Opções disponíveis:
CPF,
CNPJ,
EMAIL,
PHONE
Exemplo:

"EMAIL"

owner
object
obrigatório

Owner information associated with this PIX key