HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Crear Beneficiaries

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
beneficiaries
array of objects
required

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

Beneficiaries*
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json