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:

NombreTipoDescripci贸nRequerido
goverment_idstringIdentificador personal del Customer seg煤n su nacionalidad. Por ejemplo: para Chile RUT, para M茅xico CURP.:radio-button: Si
mailstringCorreo que se utilizar谩 para contactar al Customer.:radio-button: Si
namestringNombre por el cual nos referimos al Customer en los mensajes.:white-circle: No
phone_numberstringN煤mero de tel茅fono del Customer para contactarlo por SMS y Whatsapp:white-circle: No
pac_mandate_idstringIdentificador del mandato que se pondr谩 al inscribir el PAC asociado al customer.:white-circle: No
default_agentstringCorreo del asistente que tendr谩 asignado por defecto responder al Customer en caso de que este responda alg煤n mensaje.:white-circle: No
send_mailbooleanFlag 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.