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.
{
"name": "Saha",
"lastName": "Russel",
"document": "P128767Z444",
"typeDocumentId": 1,
"emailNotification": "[email protected]",
"indicativeContact": "+1",
"phoneContact": "123456789",
"categoryId": 3,
"addressData": {
"street": "calle 35 cr3aw #34-64",
"region": "CO-COR",
"city": "Manchester",
"country": "GBR",
"postalCode": "20500"
},
"credentials": {
"type": "BANK_ACCOUNT",
"fullName": "Perez Cortez",
"accountNumber": "6970093",
"accountNumberType": "DEFAULT",
"countryCode": "GBR",
"currencyCode": "GBP",
"accountType": "1",
"bankCode": "173",
"bankCodeType": "SORT_CODE",
"bankName": "Bank of America",
"BIC": "ADWADS32",
"branchCode": "123456"
}
}
Explicación de tabla.
PN: Persona Natural
PJ: Persona Jurídica
| PARÁMETRO | DESCRIPCIÓN | PN | PJ | Obligatoriedad |
|---|---|---|---|---|
| name | Nombre de pila de la persona. | X | Condicional | |
| lastName | Apellido de la persona. | X | Condicional | |
| tradeName | solo 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 | Condicional | |
| legalName | solo 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 | Condicional | |
| document | Número de documento del tercero principal. | X | X | Requerido |
| typeDocumentId | ID del tipo de documento del tercero principal. | X | X | Requerido |
| dv | Dígito de verificación del documento (solo si el tipo de documento lo requiere). | X | Condicional | |
| emailNotification | Dirección de correo electrónico para notificaciones del tercero principal. | X | X | |
| indicativeContact | Indicativo de país para el número de teléfono de contacto del tercero principal. | X | X | Requerido |
| phoneContact | Número de teléfono de contacto del tercero principal. | X | X | Requerido |
| categoryId | ID de la categoría del tercero principal. | X | X | Opcional |
| addressData | Información completa de la dirección del usuario. Incluye calle, ciudad, región, código postal y país. Este campo es obligatorio en entornos productivos.. | X | X | Requerido |
| addressData.street | Dirección o calle principal del domicilio. Ejemplo: "calle 35 cr3aw #34-64". | X | X | Requerido |
| addressData.city | Ciudad donde reside el usuario. Ejemplo: "Bogotá". | X | X | Requerido |
| addressData.region | Código de región o departamento siguiendo el estándar ISO 3166-2. Ejemplo: "CO-COR" (Córdoba, Colombia). | X | X | Requerido |
| addressData.postalCode | Código postal asociado a la dirección. Ejemplo: "23001". | X | X | Requerido |
| addressData.country | Código de país en formato ISO 3166-1 alfa-2. Ejemplo: "CO" (Colombia). | X | X | Requerido |
| credentials.type | Tipo de credencial utilizada para las transacciones (ej., tarjeta, cuenta bancaria). | X | X | Requerido |
| credentials.fullName | Nombre completo del titular de la credencial del usuario tercero. | X | X | Requerido |
| credentials.accountNumber | Número de cuenta o tarjeta del usuario tercero. | X | X | Requerido |
| credentials.accountNumberType | Tipo de identificador usado para la cuenta. | X | X | Requerido |
| credentials.countryCode | País donde está registrada la cuenta bancaria. ISO-3166 Alpha-3 | X | X | Requerido |
| credentials.currencyCode | Moneda asociada a la cuenta bancaria. ISO-4217 Alpha-3 | X | X | Requerido |
| credentials.accountType | Id del tipo de cuenta bancaria. | X | X | Condicional |
| credentials.bankCode | Código del banco de la cuenta receptora. ISO20022 | X | X | Condicional |
| credentials.bankCodeType | Tipo de código bancario utilizado. Ejemplo : 'SORT_CODE' | X | X | Condicional |
| credentials.bankName | Nombre del banco receptor. ISO20022 | X | X | Condicional |
| credentials.BIC | Código BIC/SWIFT del banco. | X | X | Condicional |
| credentials.branchCode | Código de la sucursal bancaria. | X | X | Condicional |
Campos de respuesta
| Campo | Descripción |
|---|---|
error | Indica si hubo un error. 0 significa que no hubo error. |
message | Mensaje descriptivo del resultado de la operación. |
data | Contiene la información relacionada con el registro guardado. |
data.uuid | UUID del tercero, identificador único. |
data.thirdBankUuid | UUID 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