Add/Update Customer

The following endpoint can be used to add or update a customer within the Hyfin application. The customer mobile phone number and email address will be used to send payment requests to the customer.

Punto Final

The following endpoint can be used to add or update a customer. You must replace the {base_url} and {site_id} variable with the site id that was provided when the site was created.

POST

{base_url}/api/v4/site/{site_id}/customer/addUpdate

La misma ruta de acceso se utiliza para agregar o actualizar a cliente. Si a cliente ya existe con el {external_id} , el cliente se actualizará de lo contrario se insertará.

Solicitud

Campo

Tipo

Requerido

Descripción

external_id

String

The unique customer id from the source system/database. If we detect a record with the same `external_id`, it will be updated, otherwise it will be added.

first_name

String

El primer nombre del cliente.

last_name

String

El apellido del cliente.

account_name

String

Si el cliente es una empresa, puedes usar este campo como un identificador adicional (Ej. 123 Main Street o ABC Company).

mobile_phone

String

The customers mobile phone number. Required if `notification_options.notify_phone` is enabled.

String

The customers email address. Required if `notification_options.notify_email` is enabled.

notes

String

Notas internas del cliente. Visible solo para el comerciante.

active

Boolean

Si el registro del cliente está activo y disponible para ser utilizado.
Default = `true`

attachment_refs

Una lista de adjuntos.

Sample Request

			
				{
  "external_id": "39772634",
  "first_name": "John",
  "last_name": "Doe",
  "account_name": "",
  "mobile_phone": "111-222-3333",
  "email": "johndoe@abc.com",
  "notes": "World's best customer",
  "active": true,
  "notification_options": {
    "notify_phone": true,
    "notify_email": true
  }
}

Respuesta

Campo

Tipo

Descripción

success

Boolean

Whether the record was added or updated successfully.

action

String

Informs whether the record was added or updated. Will only be returned if `success` is `true`.
One of `added`, `updated`

_id

String

The auto generated id assigned to the record.

errors

String [ ]

A list of errors. Will only be returned if `success` is `false`.

Sample Response (Successful)

			
				{
  "success": true,
  "action": "added",
  "_id": "60f720d248f143332af022e0"
}

Sample Response (Failed)

			
				{
  "success": false,
  "errors": [
    "invalid field2",
    "missing field_name"
  ]
}