Saltar al contenido principal
GET
Retrieve a Pix Key

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id
string<uuid>
requerido

Account ID (UUID format)

X-End-To-End-Id
string
requerido

End-to-end transaction identifier

Parámetros de ruta

key
string
requerido

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

Respuesta

OK

account
object
requerido

Account information associated with this PIX key

creationDate
string<date-time>
requerido

When this PIX key entry was created

Ejemplo:

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

endToEndId
string
requerido

Unique identifier for the end-to-end transaction tracking

Ejemplo:

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

key
string
requerido

PIX key value that was registered

Ejemplo:

"john.doe@example.com"

keyOwnershipDate
string<date-time>
requerido

When the customer became the owner of this PIX key

Ejemplo:

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

keyType
enum<string>
requerido

Type of this PIX key

Opciones disponibles:
CPF,
CNPJ,
EMAIL,
PHONE
Ejemplo:

"EMAIL"

owner
object
requerido

Owner information associated with this PIX key