API Reference

Crear

El endpoint de registro de tercero y usuario permite crear un nuevo tercero en el sistema. Este proceso es esencial para asegurar que todos los datos relevantes de los terceros y usuarios se capturen y gestionen correctamente.

Parámetros para el Endpoint

A continuación se detallan los parámetros necesarios para registrar un nuevo tercero y usuario:

Objeto para el envío de datos.

{  
    "tradeName": "OFFICWEE COL",  
    "legalName": "OFFIC",  
    "document": "324232323",  
    "typeDocumentId": "3",  
    "dv": "7",  
    "emailNotification": "[email protected]",  
    "indicativeContact": "+57",  
    "phoneContact": "3000090987",  
    "categoryId": "3",  
    "address": "7217 NW 2nd Ave",
    "thirdDirectory": {  
        "name": "juan C",  
        "lastName": "Armeria",  
        "document": "55625685",  
        "typeDocumentId": 1,  
        "emailNotification": "[email protected]",  
        "indicativeContact": "+57",  
        "phoneContact": "30000909875",  
        "categoryId": 3,  
        "address": "7217 NW 2nd Ave",
        "thirdCredentials": {  
            "type": "CARD",  
            "fullName": "Pepito Perez",   
            "accountNumber": "99999999",  
            "expirationDate": "203112"  
        }  
    }  
}

Explicación de tabla.
PN: Persona Natural
PJ: Persona Jurídica

PARÁMETRODESCRIPCIÓNPNPJ
nameNombre de pila de la persona.X
lastNameApellido de la persona.X
tradeNamesolo cuando el tipo de documento es 3(NIT)
Nombre bajo el que se desarrolla la actividad comercial. En este caso, podría ser el nombre de un negocio o emprendimiento.
X
legalNamesolo cuando el tipo de documento es 3(NIT)
Nombre oficial registrado ante las autoridades. En este caso, podría ser la razón social de una empresa.
X
documentNúmero de documento del tercero principal.XX
typeDocumentIdID del tipo de documento del tercero principal.XX
dvDígito de verificación del documento (solo si el tipo de documento lo requiere).X
emailNotificationDirección de correo electrónico para notificaciones del tercero principal.XX
indicativeContactIndicativo de país para el número de teléfono de contacto del tercero principal.XX
phoneContactNúmero de teléfono de contacto del tercero principal.XX
categoryIdID de la categoría del tercero principal.XX
addressDirección física del usuario tercero principal.XX
thirdDirectory.nameNombre de pila de la persona.X
thirdDirectory.lastNameApellido de la persona.X
thirdDirectory.tradeNamesolo cuando el tipo de documento es 3(NIT)
Nombre bajo el que se desarrolla la actividad comercial. En este caso, podría ser el nombre de un negocio o emprendimiento.
X
thirdDirectory.legalNamesolo cuando el tipo de documento es 3(NIT)
Nombre oficial registrado ante las autoridades. En este caso, podría ser la razón social de una empresa.
X
thirdDirectory.documentDocumento del usuario tercero.XX
thirdDirectory.typeDocumentIdID del tipo de documento del usuario tercero.XX
thirdDirectory.dvDígito de verificación del documento del usuario tercero (solo si el tipo de documento lo requiere).X
thirdDirectory.emailNotificationDirección de correo electrónico para notificaciones del usuario tercero.XX
thirdDirectory.indicativeContactIndicativo de país para el número de teléfono de contacto del usuario tercero.XX
thirdDirectory.phoneContactNúmero de teléfono de contacto del usuario tercero.XX
thirdDirectory.categoryIdID de la categoría del usuario tercero.XX
thirdDirectory.addressDirección física del usuario tercero.XX
thirdDirectory.thirdCredentials.typeTipo de credencial utilizada para las transacciones (ej., tarjeta, cuenta bancaria).XX
thirdDirectory.thirdCredentials.fullNameNombre completo del titular de la credencial del usuario tercero.XX
thirdDirectory.thirdCredentials.accountNumberNúmero de cuenta o tarjeta del usuario tercero.XX
thirdDirectory.thirdCredentials.expirationDateFecha de expiración de la tarjeta del usuario tercero en formato YYYYMM.XX

Campos de respuesta

CampoDescripción
errorIndica si hubo un error. 0 significa que no hubo error.
messageMensaje descriptivo del resultado de la operación.
dataContiene la información relacionada con el registro guardado.
data.uuidUUID del tercero, identificador único.
data.thirdBankUuidUUID del método de pago del tercero.

Notas Adicionales:

Cumplimiento PCI DSS: Para capturar y procesar los datos de la tarjeta de crédito, es necesario cumplir con los estándares de seguridad PCI DSS (Payment Card Industry Data Security Standard). Asegúrese de que su integración cumpla con estas normas para garantizar la seguridad de los datos de la tarjeta.

SDK y Webapp (White Label): Si no cumple con los requisitos PCI DSS es decir no cuenta con una AOC válida, ofrecemos un SDK y un sitio web marca blanca que simplifican la integración y aseguran el cumplimiento con las normas de seguridad. Contáctenos para obtener más información y asistencia con estas herramientas.

¿Qué es un AOC (Attestation of Compliance)?
Una atestación de cumplimiento o AOC (Attestation of Compliance) es un documento que da fe de los resultados de la evaluación de PCI DSS e incluye la firma de un auditor profesional certificado por PCI DSS

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!