TRtrytoku
Beneficiaries

Actualizar metadata de un Beneficiary

Changed on

Fusiona claves en la metadata de un Beneficiary sin reemplazarla por completo.

Las claves enviadas se escriben sobre la metadata existente: las que ya estaban con otro valor se sobrescriben y las que no vienen en la solicitud se conservan. No hay forma de borrar una clave por esta vía.

El campo metadata es obligatorio. Cada clave se escribe como una ruta anidada, así que una clave vacía, que empiece con $ o que contenga un punto se rechaza con 422.

Límite de tasa: 1000 solicitudes por hora. Al superarlo, la API responde 429. Ver Límites de tasa.

patch/payouts-beneficiary/{id_beneficiary}/metadata

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/payouts-beneficiary/{id_beneficiary}/metadata
  • Auth
    API key in header x-api-key

Path parameters

id_beneficiarystring uuid required

Identificador del Beneficiary.

Request body

metadataobject required

Claves que se fusionan en la metadata del Beneficiary.

Example request

{
  "metadata": {
    "centro_costo": "CC-2200",
    "responsable": "tesoreria"
  }
}

Response

El Beneficiary con su metadata ya fusionada.

country_codestring required

País del Beneficiary, en formato ISO.

created_atstring date-time required

Momento en que se creó el Beneficiary.

created_bystring nullable

Correo del usuario de la webapp que creó el Beneficiary. Vacío cuando la carga vino de una integración por API key.

emailstring nullable

Correo de contacto del Beneficiary.

external_idstring required

Identificador del Beneficiary en el sistema de origen.

id_beneficiarystring required

Identificador del Beneficiary.

id_beneficiary_batchstring required

Identificador del lote de carga en que se creó el Beneficiary.

metadataobject

Datos libres que la Organization asocia al Beneficiary.

namestring required

Nombre o razón social del Beneficiary.

organization_idstring required

Identificador de la Organization dueña del Beneficiary.

phonestring nullable

Teléfono de contacto del Beneficiary.

typesBeneficiaryType[] required

Categorías con que la Organization clasifica al Beneficiary según la relación que tiene con él. Son etiquetas descriptivas: puede llevar varias y ninguna cambia cómo se le paga ni qué validaciones se le aplican.

updated_atstring date-time required

Momento de la última modificación del Beneficiary.

Example response

{
  "country_code": "MX",
  "created_by": "ana.perez@example.com",
  "email": "pagos@example.com",
  "external_id": "PROV-000123",
  "id_beneficiary": "8c1d5e02-47ab-4f39-9d6c-2b0a7f4e1c83",
  "id_beneficiary_batch": "5d9f2b71-0c3e-4a86-b1f7-6e8d24a0c5b9",
  "metadata": {
    "centro_costo": "CC-2200"
  },
  "name": "Comercializadora Andina",
  "organization_id": "org_7Qk2mVx0LcRt9BdN-3sYaEuHiPjW1Zf4",
  "phone": "+525512345678",
  "types": [
    "VENDOR"
  ]
}

Changes