Conceptos Clave

Contactos y Cuentas Bancarias

Gestión de información de clientes y proveedores

Contactos y Cuentas Bancarias

Los Contactos representan a tus clientes o proveedores en el sistema Koywe, almacenando su información y cuentas bancarias vinculadas para operaciones de pago.

¿Qué son los Contactos?

Un Contacto es una persona o entidad comercial con la que interactúas a través de pagos:

  • Clientes que te pagan (PAYIN)
  • Proveedores a los que tú pagas (PAYOUT)
  • Ambos en escenarios de marketplace

¿Por qué Usar Contactos?

Seguimiento

Rastrea el historial de pagos por cliente o proveedor

Cumplimiento

Almacena información KYC/cumplimiento (documentos, IDs fiscales)

Pagos Simplificados

Vincula cuentas bancarias para pagos recurrentes fáciles

Reportes

Genera reportes por contacto o tipo de negocio


Estructura de Contacto

Campos Requeridos

1{
2 "email": "cliente@ejemplo.com", // Opcional pero recomendado
3 "fullName": "Juan Pérez", // Nombre legal completo
4 "countrySymbol": "CO", // Código de país
5 "businessType": "PERSON" // PERSON, COMPANY, etc.
6}

Campos Opcionales

1{
2 "phone": "+573001234567", // Número de teléfono
3 "documentType": "CC", // Tipo de documento de ID
4 "documentNumber": "1234567890", // Número de documento de ID
5 "taxIdType": "NIT", // Tipo de ID fiscal
6 "taxIdNumber": "900123456", // Número de ID fiscal
7 "address": {
8 "street": "Calle 123",
9 "city": "Bogotá",
10 "state": "Cundinamarca",
11 "zipCode": "110111",
12 "country": "CO"
13 }
14}

Crear Contactos

Creación Básica de Contacto

1async function createContact(token, orgId, merchantId, contactData) {
2 const response = await axios.post(
3 `https://api-sandbox.koywe.com/api/v1/organizations/${orgId}/merchants/${merchantId}/contacts`,
4 {
5 email: contactData.email,
6 phone: contactData.phone,
7 fullName: contactData.fullName,
8 countrySymbol: contactData.country,
9 documentType: contactData.documentType,
10 documentNumber: contactData.documentNumber,
11 businessType: 'PERSON' // o 'COMPANY'
12 },
13 {
14 headers: {
15 'Authorization': `Bearer ${token}`,
16 'Content-Type': 'application/json'
17 }
18 }
19 );
20
21 return response.data;
22}
23
24// Uso - Crear contacto de cliente
25const customer = await createContact(token, orgId, merchantId, {
26 email: 'cliente@ejemplo.com',
27 phone: '+573001234567',
28 fullName: 'Juan Pérez',
29 country: 'CO',
30 documentType: 'CC',
31 documentNumber: '1234567890'
32});
33
34console.log('Contacto creado:', customer.id);

Respuesta:

1{
2 "id": "cnt_abc123",
3 "email": "cliente@ejemplo.com",
4 "phone": "+573001234567",
5 "fullName": "Juan Pérez",
6 "countrySymbol": "CO",
7 "documentType": "CC",
8 "documentNumber": "1234567890",
9 "businessType": "PERSON",
10 "createdAt": "2025-11-13T10:00:00Z",
11 "merchantId": "mrc_xyz789"
12}

Tipos de Documento por País

Colombia (CO)

Tipo de DocumentoCódigoDescripciónEjemplo
Cédula de CiudadaníaCCID Nacional1234567890
Cédula de ExtranjeríaCEID Extranjero1234567
NITNITID Fiscal (empresas)900123456-1

Brasil (BR)

Tipo de DocumentoCódigoDescripciónEjemplo
CPFCPFID Fiscal Individual123.456.789-00
CNPJCNPJID Fiscal de Empresa12.345.678/0001-90

México (MX)

Tipo de DocumentoCódigoDescripciónEjemplo
RFCRFCID FiscalXAXX010101000
CURPCURPRegistro de PoblaciónABCD123456HDFXXX09

Chile (CL)

Tipo de DocumentoCódigoDescripciónEjemplo
RUTRUTID Fiscal11.111.111-1

Argentina (AR)

Tipo de DocumentoCódigoDescripciónEjemplo
DNIDNIID Nacional12345678
CUITCUITID Fiscal20-12345678-9

Cuentas Bancarias

Vincular Cuentas Bancarias a Contactos

Para operaciones PAYOUT, necesitas vincular una cuenta bancaria al contacto:

Asociación Automática: Las cuentas bancarias se vinculan automáticamente con la información del contacto. El nombre del titular se toma del fullName del contacto. Los códigos bancarios pueden deducirse de los números de cuenta para la mayoría de los países.

1async function addBankAccountToContact(token, orgId, merchantId, contactId, bankData) {
2 const response = await axios.post(
3 `https://api-sandbox.koywe.com/api/v1/organizations/${orgId}/merchants/${merchantId}/contacts/${contactId}/bank-accounts`,
4 {
5 countrySymbol: bankData.country,
6 currencySymbol: bankData.currency,
7 bankCode: bankData.bankCode, // Opcional para la mayoría de países (deducido)
8 accountNumber: bankData.accountNumber,
9 accountType: bankData.accountType // Requerido para Colombia: 'checking' o 'savings'
10 },
11 {
12 headers: {
13 'Authorization': `Bearer ${token}`,
14 'Content-Type': 'application/json'
15 }
16 }
17 );
18
19 return response.data;
20}
21
22// Uso
23const bankAccount = await addBankAccountToContact(token, orgId, merchantId, 'cnt_abc123', {
24 country: 'CO',
25 currency: 'COP',
26 bankCode: 'BANCOLOMBIA',
27 accountNumber: '1234567890',
28 accountType: 'savings'
29});
30
31console.log('Cuenta bancaria agregada:', bankAccount.id);
32console.log('Nombre del titular auto-vinculado del contacto');

Requisitos por País: Consulta Cuentas Externas del Comercio para reglas de validación detalladas por país. Las cuentas bancarias de contactos siguen las mismas validaciones (CLABE para México, CCI para Perú, CVU/CBU para Argentina, etc.).


Recuperar Contactos

Listar Todos los Contactos

Node.js
1async function listContacts(token, orgId, merchantId, options = {}) {
2 const response = await axios.get(
3 `https://api-sandbox.koywe.com/api/v1/organizations/${orgId}/merchants/${merchantId}/contacts`,
4 {
5 params: {
6 search: options.search, // Opcional: buscar por nombre o email
7 limit: options.limit || 50,
8 page: options.page || 1
9 },
10 headers: { 'Authorization': `Bearer ${token}` }
11 }
12 );
13
14 return response.data;
15}
16
17// Uso
18const contacts = await listContacts(token, orgId, merchantId, {
19 search: 'juan',
20 limit: 20
21});
22
23console.log(`Se encontraron ${contacts.length} contactos`);

Obtener Contacto Específico

Node.js
1async function getContact(token, orgId, merchantId, contactId) {
2 const response = await axios.get(
3 `https://api-sandbox.koywe.com/api/v1/organizations/${orgId}/merchants/${merchantId}/contacts/${contactId}`,
4 {
5 headers: { 'Authorization': `Bearer ${token}` }
6 }
7 );
8
9 return response.data;
10}
11
12// Uso
13const contact = await getContact(token, orgId, merchantId, 'cnt_abc123');
14console.log('Contacto:', contact);

Obtener Cuentas Bancarias del Contacto

Node.js
1async function getContactBankAccounts(token, orgId, merchantId, contactId) {
2 const response = await axios.get(
3 `https://api-sandbox.koywe.com/api/v1/organizations/${orgId}/merchants/${merchantId}/contacts/${contactId}/bank-accounts`,
4 {
5 headers: { 'Authorization': `Bearer ${token}` }
6 }
7 );
8
9 return response.data;
10}
11
12// Uso
13const bankAccounts = await getContactBankAccounts(token, orgId, merchantId, 'cnt_abc123');
14console.log('Cuentas bancarias:', bankAccounts);

Actualizar Contactos

Node.js
1async function updateContact(token, orgId, merchantId, contactId, updates) {
2 const response = await axios.put(
3 `https://api-sandbox.koywe.com/api/v1/organizations/${orgId}/merchants/${merchantId}/contacts/${contactId}`,
4 updates,
5 {
6 headers: {
7 'Authorization': `Bearer ${token}`,
8 'Content-Type': 'application/json'
9 }
10 }
11 );
12
13 return response.data;
14}
15
16// Uso - Actualizar teléfono o dirección
17const updated = await updateContact(token, orgId, merchantId, 'cnt_abc123', {
18 phone: '+573009876543',
19 address: {
20 street: 'Calle 456',
21 city: 'Medellín'
22 }
23});

Requisitos de Validación

Persona vs Empresa

Para PERSON (individual):

  • Usa tipos de documento individual (CC, DNI, CPF, etc.)
  • businessType: "PERSON"
  • Nombre completo del individuo

Para COMPANY (empresa):

  • Usa tipos de documento de empresa (NIT, CNPJ, CUIT, etc.)
  • businessType: "COMPANY"
  • Nombre legal de la empresa

Formatos de Número de Documento

Los números de documento deben coincidir con el formato esperado para cada país:

  • Colombia CC: 6-10 dígitos
  • Brasil CPF: 11 dígitos (con o sin formato)
  • México RFC: 12-13 caracteres
  • Chile RUT: Formato XX.XXX.XXX-X

Mejores Prácticas

Cuándo Crear Contactos

Crear contactos para:

  • Clientes haciendo pagos (PAYIN) - para seguimiento y cumplimiento
  • Proveedores recibiendo pagos (PAYOUT) - requerido para vinculación de cuenta bancaria
  • Transacciones recurrentes con la misma entidad

Reutilizar Contactos

Reutiliza contactos existentes para el mismo cliente/proveedor para:

  • Mantener historial de pagos
  • Evitar registros duplicados
  • Simplificar reconciliación
Node.js
1// Verificar si el contacto existe antes de crear
2async function getOrCreateContact(token, orgId, merchantId, email) {
3 // Intentar encontrar existente
4 const contacts = await listContacts(token, orgId, merchantId, { search: email });
5
6 if (contacts.length > 0) {
7 return contacts[0]; // Devolver existente
8 }
9
10 // Crear nuevo si no se encuentra
11 return await createContact(token, orgId, merchantId, {
12 email: email,
13 // ... otros campos
14 });
15}

Privacidad de Datos

Consideraciones de Seguridad:

  • Almacena solo información necesaria
  • Sigue regulaciones GDPR/protección de datos
  • No almacenes datos sensibles en campos de metadata
  • Implementa controles de acceso apropiados

Escenarios Comunes

Escenario 1: Pago de Cliente E-Commerce

1// 1. Crear contacto de cliente
2const customer = await createContact(token, orgId, merchantId, {
3 email: 'cliente@ejemplo.com',
4 fullName: 'María García',
5 country: 'CO',
6 documentType: 'CC',
7 documentNumber: '1234567890',
8 phone: '+573001234567'
9});
10
11// 2. Crear orden PAYIN vinculada al contacto
12const order = await createPayinOrder(token, orgId, merchantId, {
13 contactId: customer.id,
14 amount: 50000,
15 currency: 'COP',
16 // ... otros campos
17});

Escenario 2: Pago a Proveedor

1// 1. Crear contacto de proveedor
2const provider = await createContact(token, orgId, merchantId, {
3 email: 'proveedor@ejemplo.com',
4 fullName: 'Servicios ABC SAS',
5 country: 'CO',
6 documentType: 'NIT',
7 documentNumber: '900123456-1',
8 businessType: 'COMPANY'
9});
10
11// 2. Agregar cuenta bancaria del proveedor
12const bankAccount = await addBankAccountToContact(token, orgId, merchantId, provider.id, {
13 country: 'CO',
14 currency: 'COP',
15 bankCode: 'BANCOLOMBIA',
16 accountNumber: '1234567890',
17 accountType: 'checking'
18 // holderName auto-vinculado de provider.fullName
19});
20
21// 3. Crear orden PAYOUT
22const payout = await createPayoutOrder(token, orgId, merchantId, {
23 contactId: provider.id,
24 destinationAccountId: bankAccount.id, // Vincular a cuenta bancaria
25 amount: 500000,
26 currency: 'COP'
27});

Próximos Pasos