Crear Customers

📘

Esta sección explica el proceso de creación de Customers a través de la API REST de Toku. También puedes verlo en la documentación de la API aquí.

El primer paso para habilitar los pagos para tus clientes es registrarlos. A continuación se explica la creación de Customers utilizando la API REST de Toku.

Un Customer contiene la información de la persona, junto con sus medios de contacto. La creación de un Customer genera un id único de la forma cus_lq1wGjwgFyqQm4ACZx0QjE84qKm8fff, el cual se devuelve en la respuesta de la API. Este id se debe guardar, ya que se utiliza luego para la creación de Invoices para ese Customer, y para identificar las acciones que lleve a cabo el Customer en el Portal de Pagos, explicados en secciones posteriores.

A continuación, vemos cómo crear un Customer a traves de una request POST a la API.

POST /customer

Parámetros para crear Customer

Nombre

Tipo

Descripción

Requerido

goverment_id

string

Identificador personal del Customer según su nacionalidad.

:radio-button: Si

mail

string

Correo que se utilizará para contactar al Customer.

:radio-button: Si

name

string

Nombre por el cual nos referimos al Customer en los mensajes.

:white-circle: No

phone_number

string

Número de teléfono del Customer para contactarlo por SMS y Whatsapp.

:white-circle: No

pac_mandate_id

string

Identificador del mandato que se pondrá al inscribir el PAC asociado al customer.

:white-circle: No

default_agent

string

Correo del asistente que tendrá asignado por defecto el customer en caso de que este responda alguno de los correos que se le mandan.

:white-circle: No

send_mail

boolean

Flag que nos indica si quieres mandar automáticamente un correo al crear el customer. Se le enviará con la secuencia "Invitación inscripción medio de pago".

:white-circle: No

El Body del request debe ser de la siguiente forma:

{
  "goverment_id": "18579878K",
  "mail": "[email protected]",
  "name": "Jon Snow",
  "phone_number": "+56987654321",
  "pac_mandate_id": "196579888",
  "default_agent": "[email protected]",
   "send_mail": true
}

La respuesta recibida es de la forma:

{
  "id": "cus_lq1wGjwgFyqQm4ACZx0QjE84qKm8fffa",
  "goverment_id": "18579878K",
  "mail": "[email protected]",
  "name": "Jon Snow",
  "phone_number": "+56987654321",
  "pac_mandate_id": "196579888",
  "default_agent": "[email protected]",
}

Recuerda que debes capturar el campo id incluido en esta respuesta.


Siguientes pasos

Una vez creado el Customer, podemos pasar al siguiente paso, la creación de Invoices.