Saltar al contenido principal
PATCH
Update a Pix Entry Data

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id
string<uuid>
requerido

Unique identifier of the Midaz Ledger Account (UUID format)

X-Reason
enum<string>
requerido

Specifies the reason for Pix key entry update. Valid values: USER_REQUESTED, BRANCH_TRANSFER, RECONCILIATION

Opciones disponibles:
USER_REQUESTED,
BRANCH_TRANSFER,
RECONCILIATION

Parámetros de ruta

entry_id
string<uuid>
requerido

Unique identifier of the Pix entry (UUID format)

Cuerpo

application/json
account
object
requerido

Updated account information

owner
object
requerido

Updated owner information

metadata
object

Optional key-value map for updating custom attributes (JSON Merge Patch semantics)

Respuesta

OK

account
object
requerido

Account information associated with this Pix key

createdAt
string<date-time>
requerido

Timestamp when the entity 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 of the Pix key entry

Ejemplo:

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

keyCreationDate
string<date-time>
requerido

Date when this Pix key was created on DICT

Ejemplo:

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

keyOwnershipDate
string<date-time>
requerido

Date when the customer became the owner of this Pix key

Ejemplo:

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

keyType
enum<string>
requerido

Type of Pix key that was created

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

"EMAIL"

keyValue
string
requerido

Pix key value that was registered

Ejemplo:

"john.doe@example.com"

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
enum<string>
requerido

Operational status of this Pix key

Opciones disponibles:
ACTIVE,
INACTIVE
Ejemplo:

"ACTIVE"

updatedAt
string<date-time>
requerido

Timestamp when the entity was last updated

Ejemplo:

"2024-01-20T14:45:00Z"

metadata
object

Custom key-value attributes associated with this entry