Update a Pix Entry Data

Use this endpoint to update an existing Pix entry data associated with an account.

PATCH /v1/dict/entries/{entry_id}

Update a Pix Entry Data

cURL

curl --request PATCH \
  --url https://api.example.com/v1/dict/entries/{entry_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Reason: <x-reason>' \
  --data @- <<EOF
{
  "account": {
    "branch": "0001",
    "number": "123456789",
    "openingDate": "2020-01-15T10:30:00Z",
    "participant": "12345678",
    "type": "TRAN"
  },
  "owner": {
    "name": "Jane Doe",
    "tradeName": "Jane's Business"
  },
  "metadata": {}
}
EOF

200

{
  "account": {
    "branch": "0001",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "number": "123456789",
    "openingDate": "2020-01-15T10:30:00Z",
    "participant": "12345678",
    "type": "TRAN"
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "holderId": "550e8400-e29b-41d4-a716-446655440001",
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "keyCreationDate": "2024-01-15T10:30:00Z",
  "keyOwnershipDate": "2024-01-15T10:30:00Z",
  "keyType": "EMAIL",
  "keyValue": "[e-mail]",
  "owner": {
    "document": "52998224725",
    "name": "John Doe",
    "tradeName": "John's Business",
    "type": "NATURAL_PERSON"
  },
  "requestId": "680e8400-e29b-41d4-a716-446655440002",
  "status": "ACTIVE",
  "updatedAt": "2024-01-20T14:45:00Z",
  "metadata": {}
}

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

Show child attributes

owner · object · requerido

Updated owner information

Show child attributes

metadata · object

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

Show child attributes

Respuesta

200

application/json

OK

account · object · requerido

Account information associated with this Pix key

Show child attributes

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:

"[e-mail]"

owner · object · requerido

Owner information associated with this Pix key

Show child attributes

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

Show child attributes