Crear Beneficiaries
Changed onCrea 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.
Request
- Base URLhttps://api.trytoku.com
- URLhttps://api.trytoku.com/payouts-beneficiary
- AuthAPI key in header x-api-key
Headers
Correo del usuario autenticado que crea el Beneficiary, reenviado por la webapp. Opcional: las integraciones por API key no lo envían.
Request body
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.
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
- info
endpoint added
- info