Skip to main content
PATCH
Update a Pix Entry Data

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id
string<uuid>
required

Unique identifier of the Midaz Ledger Account (UUID format)

X-Reason
enum<string>
required

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

Available options:
USER_REQUESTED,
BRANCH_TRANSFER,
RECONCILIATION

Path Parameters

entry_id
string<uuid>
required

Unique identifier of the Pix entry (UUID format)

Body

application/json
account
object
required

Updated account information

owner
object
required

Updated owner information

metadata
object

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

Response

OK

account
object
required

Account information associated with this Pix key

createdAt
string<date-time>
required

Timestamp when the entity was created

Example:

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

holderId
string
required

Unique identifier of the customer who owns this Pix key

Example:

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

id
string
required

Unique identifier of the Pix key entry

Example:

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

keyCreationDate
string<date-time>
required

Date when this Pix key was created on DICT

Example:

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

keyOwnershipDate
string<date-time>
required

Date when the customer became the owner of this Pix key

Example:

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

keyType
enum<string>
required

Type of Pix key that was created

Available options:
EMAIL,
PHONE,
CPF,
CNPJ,
EVP
Example:

"EMAIL"

keyValue
string
required

Pix key value that was registered

Example:

"john.doe@example.com"

owner
object
required

Owner information associated with this Pix key

requestId
string
required

Unique identifier for this creation request (for idempotency)

Example:

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

status
enum<string>
required

Operational status of this Pix key

Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

updatedAt
string<date-time>
required

Timestamp when the entity was last updated

Example:

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

metadata
object

Custom key-value attributes associated with this entry