API Reference

Crear clientes

El endpoint se utiliza para registrar un nuevo cliente en el sistema de pagos . Los datos proporcionados en el JSON contienen información necesaria para identificar y contactar al cliente. Al enviar estos datos al endpoint, el sistema registrará al cliente con los detalles proporcionados.

Objeto Json

{
    "businessName": "Juan perez",
    "document": "1082749257",
    "typeDocumentId": 2,
    "dv": 0,
    "emailNotification": "[email protected]",
    "indicativeContact": "+57",
    "phoneContact": "3026508000",
    "categoryId": 3,
    "thirdPartyType": "CLIENTE"
}

Explicacion

  • businessName:

    • Descripción: Nombre comercial o nombre de la persona.
    • Ejemplo: "Juan"
    • Uso: Este campo representa el nombre del cliente que se está creando.
  • document:

    • Descripción: Número del documento de identificación del cliente.
    • Ejemplo: "1082749257"
    • Uso: Este campo almacena el número de identificación único del cliente.
  • typeDocumentId:

    • Descripción: Identificador del tipo de documento de identificación.
    • Ejemplo: 2
    • Uso: Este campo indica el tipo de documento (por ejemplo, cédula de ciudadanía, pasaporte, etc.). El valor 2 debe corresponder a un tipo específico según la implementación del sistema.
  • dv:

    • Descripción: Dígito de verificación.
    • Ejemplo: 0
    • Uso: Utilizado para validar la autenticidad del número de identificación en algunos países. En este caso, el valor es 0, lo que puede significar que no se aplica o que no es necesario para el tipo de documento especificado.
  • emailNotification:

    • Descripción: Correo electrónico para notificaciones.
    • Ejemplo: "[email protected]"
    • Uso: Este campo se utiliza para enviar notificaciones por correo electrónico al cliente.
  • indicativeContact:

    • Descripción: Indicativo del país para el número de teléfono.
    • Ejemplo: "+57"
    • Uso: Este campo representa el código de país para el número de teléfono. En este ejemplo, +57 es el indicativo de Colombia.
  • phoneContact:

    • Descripción: Número de teléfono de contacto.
    • Ejemplo: "3026508000"
    • Uso: Este campo almacena el número de teléfono del cliente para contactos o notificaciones.
  • categoryId:

    • Descripción: Identificador de la categoría del cliente.
    • Ejemplo: 3
    • Uso: Este campo categoriza al cliente en un grupo específico según la implementación del sistema. El valor 3 debe corresponder a una categoría definida en el sistema.
  • thirdPartyType:

    • Descripción: Tipo de tercero.
    • Ejemplo: "CLIENTE"
    • Uso: Este campo indica el tipo de entidad que se está creando. En este caso, "CLIENTE" especifica que el tercero es un cliente.
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!