Beneficiaries

Crear Beneficiaries

Changed on

Crea varios Beneficiaries y sus Beneficiary Accounts en una sola solicitud.

Se usa para cargar de una vez el padrón de destinatarios de pago de la Organization. Cada fila se procesa por separado, así que una fila inválida no bota el resto: la respuesta informa por separado las creadas (beneficiaries_created, accounts_created), las omitidas (beneficiaries_omitted, accounts_omitted) y las fallidas (beneficiaries_errors, accounts_errors), cada una con su código estable.

Una fila cuyo external_id ya existe se reporta como omisión, no como error, y el registro existente queda intacto: reenviar la misma carga no duplica nada.

Todas las filas de una llamada comparten el id_beneficiary_batch que devuelve la respuesta. La creación además dispara, en segundo plano, la verificación bancaria de las cuentas nuevas y la inicialización de sus flujos de aprobación, por lo que las cuentas nacen en approval_flows_status: INITIALIZING y su verificación queda pendiente.

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

post/payouts-beneficiary

Request

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

Headers

x-user-emailstring nullable

Correo del usuario autenticado que crea el Beneficiary, reenviado por la webapp. Opcional: las integraciones por API key no lo envían.

Request body

beneficiariesobject[] required

Filas de Beneficiaries que se quieren crear. Cada una lleva sus datos de identidad y, opcionalmente, la lista accounts con sus Beneficiary Accounts.

Example request

{
  "beneficiaries": [
    {
      "accounts": [
        {
          "country_code": "MX",
          "currency_code": "MXN",
          "details": {
            "account_number": "002010077777777771",
            "type": "BANK_ACCOUNT"
          },
          "external_id": "CTA-000123"
        }
      ],
      "country_code": "MX",
      "email": "pagos@example.com",
      "external_id": "PROV-000123",
      "identity_document": {
        "number": "AAA010101AAA",
        "type": "RFC"
      },
      "name": "Comercializadora Andina",
      "types": [
        "VENDOR"
      ]
    }
  ]
}

Response

Resumen de la carga: filas creadas, omitidas y fallidas, con el id del lote.

accounts_created_countinteger required
accounts_failed_countinteger
accounts_omitted_countinteger
beneficiaries_created_countinteger required

Cantidad de Beneficiaries creados.

beneficiaries_failed_countinteger required

Cantidad de Beneficiaries que no se pudieron crear.

beneficiaries_omitted_countinteger required

Cantidad de Beneficiaries omitidos por existir previamente.

id_beneficiary_batchstring uuid required

Identificador del lote que agrupa todo lo creado en esta llamada.

Example response

{
  "accounts_created": [
    {
      "_id": "5eb7cf5a86d9755df3a6c593"
    }
  ],
  "beneficiaries_created": [
    {
      "_id": "5eb7cf5a86d9755df3a6c593"
    }
  ],
  "beneficiaries_created_count": 2,
  "beneficiaries_omitted_count": 1,
  "id_beneficiary_batch": "5d9f2b71-0c3e-4a86-b1f7-6e8d24a0c5b9"
}

Changes