Saltar al contenido principal
GET
Get a Pix Entry

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id
string<uuid>
requerido

Account ID (UUID format)

Parámetros de ruta

entry_id
string
requerido

Entry ID (UUID format)

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"

holderId
string
requerido

Unique identifier of the customer who owns this PIX key

Ejemplo:

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

id
string
requerido

Unique identifier for this PIX key entry

Ejemplo:

"950e8400-e29b-41d4-a716-446655440000"

keyOwnershipDate
string<date-time>
requerido

When the customer became the owner of this PIX key

Ejemplo:

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

keyType
string
requerido

Type of this PIX key

Ejemplo:

"EMAIL"

keyValue
string
requerido

Actual PIX key that was registered

Ejemplo:

"john.doe@example.com"

metadata
object
requerido

Optional key-value pairs for custom attributes

owner
object
requerido

Owner information associated with this PIX key

requestId
string
requerido

Unique identifier for this creation request (for idempotency)

Ejemplo:

"680e8400-e29b-41d4-a716-446655440002"

status
string
requerido

Operational status of this PIX key

Ejemplo:

"ACTIVE"