Saltar al contenido principal
PATCH
/
v1
/
dict
/
entries
/
{entry_id}
Actualizar una Entrada
curl --request PATCH \
  --url https://plugin-pix-indirect.api.lerian.net/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 '
{
  "account": {
    "branch": "0001",
    "number": "123456789",
    "type": "TRAN"
  },
  "owner": {
    "name": "John Doe",
    "tradeName": "Johns Store"
  }
}
'
{ "id": "019c96a0-0c0c-7221-8cf3-13313fb60081", "key": "john.doe@example.com", "keyType": "EMAIL", "status": "ACTIVE", "account": { "branch": "0001", "number": "123456789", "participant": "12345678", "type": "TRAN" }, "owner": { "name": "John Doe", "taxIdNumber": "12345678901", "type": "NATURAL_PERSON" }, "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-01-15T10:30:00Z" }

Autorizaciones

​
Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Encabezados

​
X-Account-Id
string
requerido

Identificador único de la Cuenta del Ledger Midaz (formato UUID).

​
X-Reason
enum<string>
requerido

Especifica la razón para la actualización de la entrada de clave Pix. Valores válidos: USER_REQUESTED, BRANCH_TRANSFER, RECONCILIATION.

Opciones disponibles:
USER_REQUESTED,
BRANCH_TRANSFER,
RECONCILIATION

Parámetros de ruta

​
entry_id
string
requerido

Identificador único de la entrada Pix (formato UUID).

Cuerpo

application/json
​
account
object
requerido

Información de cuenta actualizada.

​
owner
object
requerido

Información de propietario actualizada.

​
metadata
object

Mapa opcional de clave-valor para actualizar atributos personalizados.

Respuesta

Entrada actualizada exitosamente en DICT y base de datos local.

​
id
string

Identificador único de la entrada (formato UUID).

Ejemplo:

"019c96a0-0c0c-7221-8cf3-13313fb60081"

​
key
string

Valor de la clave Pix.

Ejemplo:

"john.doe@example.com"

​
keyType
string

Tipo de clave Pix.

Ejemplo:

"EMAIL"

​
status
string

Estado de la entrada (ACTIVE, INACTIVE).

Ejemplo:

"ACTIVE"

​
account
object
​
owner
object
​
createdAt
string<date-time>

Marca de tiempo de creación.

Ejemplo:

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

​
updatedAt
string<date-time>

Marca de tiempo de última actualización.

Ejemplo:

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