Pular para o conteúdo principal
GET
Get a Pix Entry

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)

Parâmetros de caminho

entry_id
string
obrigatório

Entry ID (UUID format)

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"

holderId
string
obrigatório

Unique identifier of the customer who owns this PIX key

Exemplo:

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

id
string
obrigatório

Unique identifier for this PIX key entry

Exemplo:

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

keyOwnershipDate
string<date-time>
obrigatório

When the customer became the owner of this PIX key

Exemplo:

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

keyType
string
obrigatório

Type of this PIX key

Exemplo:

"EMAIL"

keyValue
string
obrigatório

Actual PIX key that was registered

Exemplo:

"john.doe@example.com"

metadata
object
obrigatório

Optional key-value pairs for custom attributes

owner
object
obrigatório

Owner information associated with this PIX key

requestId
string
obrigatório

Unique identifier for this creation request (for idempotency)

Exemplo:

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

status
string
obrigatório

Operational status of this PIX key

Exemplo:

"ACTIVE"