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 {externalId} , el cliente se actualizará de lo contrario se insertará.

Solicitud

Campo

Tipo

Descripción

externalId

String

El identificador único del cliente del sistema/base de datos fuente. Si detectamos un registro con el mismo externalId, se actualizará; de lo contrario, se añadirá.

firstName

String

The first name of the customer. At least one of firstName, lastName, accountName, email, or mobilePhone is required.

lastName

String

The last name of the customer. At least one of firstName, lastName, accountName, email, or mobilePhone is required.

accountName

String

If the customer is a business, you may use this field as an extra identifier (Ex. 123 Main Street or ABC Company). At least one of firstName, lastName, accountName, email, or mobilePhone is required.

mobilePhone

String

The customers mobile phone number. Required if this customer is to be notified by text message. At least one of firstName, lastName, accountName, email, or mobilePhone is required.

String

The customers email address. Required if this customer is to be notified by email. At least one of firstName, lastName, accountName, email, or mobilePhone is required.

notes

String

Notas internas del cliente. Visible solo para el comerciante.

attachmentRefs

Una lista de adjuntos.

deleted

Boolean

Esta bandera representa si el registro ha sido eliminado y ya no está disponible para ser utilizado.

Sample Request

			
{
  "externalId": "39772634",
  "firstName": "John",
  "lastName": "Doe",
  "accountName": "",
  "mobilePhone": "111-222-3333",
  "email": "johndoe@abc.com",
  "notes": "World's best customer",
  "notificationOptions": {
    "notifyPhone": true,
    "notifyEmail": true
  },
  "deleted": false
}

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"
  ]
}