Inscribir medio de pago automático

Crear customer

📘

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.

Qué es un Customer

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 envía en la respuesta de la API. Este id debe ser guardado, 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.

Crear un Customer - POST /customer

A traves de un request POST a la API se puede crear un Customer, para lo que existen los siguientes parámetros:

Nombre

Tipo

Descripción

Requerido

goverment_id

string

Identificador personal del Customer según su nacionalidad. Por ejemplo: para Chile RUT, para México CURP.

: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

Correo del asistente que tendrá asignado por defecto responder al Customer en caso de que este responda algún mensaje.

:white-circle: No

default_agent

string

Correo del asistente que tendrá asignado por defecto responder al Customer en caso de que este responda algún mensaje.

: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

📘

External_id <> Goverment_id

En caso de no contar con el identificador nacional del cliente es posible utilizar el campo mail o un parámetro diferente que identifique de forma única al cliente, el que se denominará external_id. Este campo reemplace a la columna goverment_id requerida por default. Esta configuración debe realizarse por el equipo de Toku.

Formato del request y la respuesta que genera

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 ya que será el código al que se asociara la deuda y con el que podrás identificar los eventos que ocurran en Toku.

Escuchar via Webhook

Para saber si un pago fue realizado a través de Toku escuchar via Webhook el evento :

  • 'payment_method.attached': Customer ha inscrito un método de pago en la plataforma.
  • Aquí puedes inscribir tu url para escuchar webhooks.
  • Aquí puedes ver detalles de todos los webhooks que enviamos.