1. Habilita tu acceso

Solicita acceso API y habilitacion de los servicios. Si aplica, registra la IP de tu servidor.

2. Obtiene un token

Autenticate en POST /api/auth/token. Usa data.access_token hasta su vencimiento indicado en data.expires_in. Mantén tus credenciales privadas.

curl --request POST 'https://back.copdigital.co/api/auth/token' \
  --header 'Content-Type: application/json' \
  --data '{"usuario":"TU_USUARIO","password":"TU_CLAVE"}'

3. Consulta antes de operar

Usa Authorization: Bearer TU_TOKEN. Consulta primero los catalogos o el historial. Las compras, recargas y transferencias no son simulaciones: pueden afectar saldo real.

4. Confirma y concilia

Guarda la referencia y el trace_id. Confirma el resultado con el estado de la respuesta; HTTP 200 por si solo no confirma un pago.

Timeouts y reintentos

Si no recibes respuesta, consulta la operacion antes de repetirla. Si no puedes confirmar su estado, contacta a soporte con su referencia.

Errores y limites

401: revisa o renueva la autenticacion. 403: revisa permisos y restricciones. 409: interpreta el codigo de error; puede indicar pendiente o duplicado. 422: corrige los campos. 429: reduce la frecuencia y respeta Retry-After si esta presente. Un error de red o 5xx no confirma que una operacion financiera no se haya ejecutado.

Request ejemplo

{
  "usuario": "cliente_demo",
  "password": "TuClaveSegura123"
}

Campos de respuesta

Response ejemplo

{
  "ok": true,
  "data": {
    "token_type": "Bearer",
    "access_token": "TOKEN_API_CLIENTE",
    "expires_in": 86400,
    "scopes": ["payments", "gen_hys"]
  }
}

Request generar

{
  "valor": 25000,
  "document": "123456789",
  "mail": "[email protected]",
  "name": "Carlos",
  "secondName": "Perez",
  "phone": "3001234567"
}

Campos de respuesta

Response generar

{
  "ok": true,
  "data": {
    "provider": "pse",
    "title": "PSE",
    "link": "https://proveedor-pse.com/pago/abc123",
    "reference": "1779040898962525",
    "provider_reference": "HASH_PSE_9A81BC",
    "helper": "Completa el pago desde el enlace PSE.",
    "return_mode": "internal"
  }
}

Response verificar

{
  "ok": true,
  "data": {
    "module": "gen_hys",
    "action": "verifypay",
    "terp": "PSE",
    "status": "applied",
    "amount": 25000,
    "cost": 0,
    "credit": 25000
  },
  "trace_id": "trc_pse_001"
}

QR COP

Request ejemplo

{}

Response generar

{
  "ok": true,
  "expired": false,
  "sid": "7049126",
  "total": 150,
  "created_at": 1779040898,
  "expire_at": 1779041198,
  "remaining": 300,
  "image_b64": "data:image/png;base64,...",
  "disclaimer": "Usa el QR antes del tiempo limite."
}

QR Bre-B

Request generar

{
  "valor": 25000
}

Response generar

{
  "ok": true,
  "data": {
    "provider": "qr_breb",
    "title": "QR Bre-B",
    "image": "data:image/png;base64,...",
    "reference": "BREB-287372123456",
    "provider_reference": "BREB-287372123456",
    "helper": "Escanea el QR y verifica la transaccion con la misma referencia.",
    "return_mode": "internal"
  }
}

Verificar QR COP

Request verificar

{
  "sid": "7049126"
}

Response verificar

{
  "ok": true,
  "data": {
    "status": "approved",
    "reference": "7049126",
    "amount": 25000,
    "fecha": "2026-06-05 10:22:14",
    "message": "Pago QR confirmado y saldo aplicado."
  }
}

Verificar QR Bre-B

Request verificar

{
  "sid": "BREB-287372123456"
}

Response verificar

{
  "ok": true,
  "data": {
    "status": "approved",
    "reference": "BREB-287372123456",
    "amount": 25000,
    "cost": 1300,
    "credit": 23700,
    "fecha": "2026-06-05 10:24:43",
    "message": "Pago QR Bre-B confirmado y saldo aplicado."
  }
}

Request cotizacion

{
  "valor": 5.3
}

Response cotizacion

{
  "ok": true,
  "data": {
    "currency": "USDT",
    "rate_cop": 3980,
    "initial_amount": 5.3,
    "gross_cop": 21094,
    "provider_transaction_cost_cop": 0,
    "platform_cost_cop": 0,
    "total_discount_cop": 0,
    "net_cop": 21094
  }
}

Request generar

{
  "valor": 5.3
}

Response generar

{
  "ok": true,
  "data": {
    "provider": "binance",
    "title": "Binance",
    "image": "https://public.bnbstatic.com/qr/abc123.png",
    "reference": "PREPAY_ID_BINANCE",
    "provider_reference": "MERCHANT_TRADE_123",
    "helper": "Usa el QR de Binance y luego verifica el prepay id.",
    "return_mode": "internal"
  }
}

Request verificar

{
  "data": "PREPAY_ID_BINANCE"
}

Response verificar

{
  "ok": true,
  "data": {
    "status": "approved",
    "reference": "PREPAY_ID_BINANCE"
  }
}

Request generar

{
  "valor": 25000,
  "return_url": "https://tu-app.com/pagos/resultado",
  "logoBase64": "iVBORw0KGgoAAAANSUhEUgAAA..."
}

Response generar

{
  "ok": true,
  "data": {
    "provider": "prix",
    "title": "Prix",
    "link": "https://checkout.prix.com/payment-link/abc123",
    "reference": "1779040898962525",
    "provider_reference": "PRIX_HASH_123",
    "helper": "Abre el link de cobro y consulta el estado por reference.",
    "return_mode": "redirect"
  }
}

{"Terp":"PRIX","data":"REFERENCIA_DEVUELTA_AL_GENERAR"}

Request estado

{
  "reference": "1779040898962525"
}

Response estado

{
  "ok": true,
  "data": {
    "module": "gen_hys",
    "action": "prix_status",
    "reference": "1779040898962525",
    "provider_reference": "PRIX_HASH_123",
    "status": "success",
    "status_raw": "completed",
    "paid_amount": 25000,
    "cost": 0,
    "credit": 25000
  },
  "trace_id": "trc_prix_001"
}

Request cotizacion

{
  "valor": 100,
  "money": "MXN"
}

Response cotizacion

{
  "ok": true,
  "data": {
    "currency": "MXN",
    "initial_amount": 100,
    "gross_cop": 35000,
    "provider_transaction_cost_cop": 1500,
    "platform_cost_cop": 400,
    "total_discount_cop": 1900,
    "net_cop": 33100
  }
}

Request generar

{
  "valor": 100,
  "money": "MXN",
  "return_url": "https://tu-app.com/pagos/resultado"
}

Response generar

{
  "ok": true,
  "data": {
    "provider": "supra",
    "title": "Supra",
    "link": "https://checkout.supra.com/pay/abc123",
    "reference": "1779040898962525",
    "provider_reference": "SUPRA_ID_9988",
    "helper": "Abre el link y luego verifica con el id del proveedor.",
    "return_mode": "redirect",
    "currency": "MXN"
  }
}

Request verificar

{
  "idver": "ID_PAGO_SUPRA"
}

Response verificar

{
  "ok": true,
  "data": {
    "status": "approved",
    "reference": "1779040898962525",
    "provider_reference": "ID_PAGO_SUPRA"
  }
}

Request cotizacion

{
  "valor": 35000
}

Response cotizacion

{
  "ok": true,
  "data": {
    "currency": "COP",
    "initial_amount": 35000,
    "gross_cop": 35000,
    "provider_transaction_cost_cop": 3000,
    "platform_cost_cop": 850,
    "total_discount_cop": 3850,
    "net_cop": 31150
  }
}

Request generar

{
  "valor": 35000,
  "return_url": "https://tu-app.com/pagos/resultado",
  "webhook_url": "https://tu-app.com/webhooks/copdigital"
}

Webhook enviado

{
  "ok": true,
  "data": {
    "module": "gen_hys",
    "action": "verifypay",
    "terp": "EFIPAY",
    "status": "applied",
    "amount": 35000,
    "cost": 2225,
    "credit": 32775,
    "reference": "1779040898962525",
    "provider_reference": "ID_PAGO_EFIPAY",
    "fecha": "2026-07-24 10:30:00"
  },
  "trace_id": "trc_efipay_001"
}

Response generar

{
  "ok": true,
  "data": {
    "provider": "efipay",
    "title": "Efipay",
    "link": "https://checkout.efipay.com/payment/abc123",
    "reference": "1779040898962525",
    "provider_reference": "EFIPAY_ID_7788",
    "helper": "Abre el link y luego verifica con el id del proveedor.",
    "return_mode": "internal"
  }
}

Request verificar

{
  "idver": "ID_PAGO_EFIPAY"
}

Response verificar

{
  "ok": true,
  "data": {
    "status": "approved",
    "provider_reference": "ID_PAGO_EFIPAY"
  }
}

Request ejemplo

{
  "Terp": "QR",
  "data": "7049126"
}

Campos de respuesta

Response ejemplo

{
  "ok": true,
  "data": {
    "module": "gen_hys",
    "action": "verifypay",
    "terp": "QR",
    "status": "applied",
    "amount": 25000,
    "cost": 0,
    "credit": 25000
  },
  "trace_id": "trc_verify_001"
}

Request ejemplo

{
  "fecha1": "2026-05-01",
  "fecha2": "2026-05-19",
  "Terp": "PSE"
}

Respuesta

Response ejemplo

{
  "ok": true,
  "data": {
    "rows": [
      {
        "reference": "1779040898962525",
        "status": "approved",
        "amount": 25000
      }
    ]
  }
}

Movimientos

Request ejemplo

{
  "fecha1": "2026-06-01",
  "fecha2": "2026-06-05"
}

Response ejemplo

{
  "ok": true,
  "data": {
    "count": 1,
    "rows": [
      {
        "id": 25,
        "idTransaction": "1778858151875649",
        "producto": "Recarga",
        "valor": 10000,
        "fecha": "2026-06-05 10:15:00 AM",
        "hasTicket": true
      }
    ]
  },
  "trace_id": "abc123"
}

Ticket por movimiento

Request ejemplo

{
  "id": 25
}

Response ejemplo

{
  "ok": true,
  "data": {
    "id": 25,
    "title": "Comprobante digitalcopdig",
    "fields": [
      { "label": "Idtransaccion", "value": "1778858151875649" },
      { "label": "Producto", "value": "Recarga" }
    ],
    "text_lines": [
      "Idtransaccion: 1778858151875649",
      "Producto: Recarga"
    ]
  },
  "trace_id": "abc123"
}

Recarga Colombia

Codigos de operador para recargas Colombia

Request ejemplo

{
  "flow": "recarga",
  "opc": 1,
  "operador": "cl",
  "celular": "3001234567",
  "valor": 10000,
  "idtrans": "1778858151875649"
}

Request ejemplo usando proveedor 2

{
  "flow": "recarga",
  "opc": 2,
  "operador": "cl",
  "celular": "3001234567",
  "valor": 10000,
  "idtrans": "1778858151875650",
  "originCash": 0
}

Response ejemplo

{
  "ok": true,
  "data": {
    "idtrans": "1780711896633001",
    "estado": "00",
    "respuesta": "Transaccion exitosa",
    "date": "2026-06-05 09:11:38 PM",
    "info": "aa-bb-cc-dd",
    "codigoauth": "123456",
    "codop": "123456"
  },
  "trace_id": "abc123"
}

Recarga Mexico

Request catalogo MX

{
  "flow": "catalog_tae"
}

Response catalogo MX

{
  "ok": true,
  "data": {
    "rows": [
      {
        "idOffer": 1234,
        "carrier": "Telcel",
        "amount": 50000,
        "type": 0
      }
    ]
  },
  "trace_id": "abc123"
}

Request ejemplo

{
  "flow": "recarga",
  "carrier": 1234,
  "telefono": "5512345678",
  "type": 0,
  "walletType": "BL",
  "idtrans": "1778858151875649"
}

Response ejemplo

{
  "ok": true,
  "data": {
    "module": "gen_hys",
    "action": "recargas-mx",
    "flow": "recarga",
    "provider": {
      "idtx": "1778858151875649",
      "idtrans": "1778858151875649",
      "date": "2026-06-05 10:15:00 AM",
      "message": "Transaccion exitosa",
      "walletType": "BL",
      "walletLabel": "Saldo MX",
      "profitEnabled": true
    }
  },
  "trace_id": "abc123"
}

Request servicio MX ejemplo

{
  "flow": "services_pay",
  "sku": 2501,
  "referencia": "1234567890",
  "monto": 35000,
  "telefono": "5512345678",
  "idtrans": "1778858151875649"
}

Response servicio MX ejemplo

{
  "ok": true,
  "data": {
    "provider": {
      "idtrans": "1778858151875649",
      "message": "Transaccion exitosa"
    }
  },
  "trace_id": "abc123"
}

Listar paquetes

Codigos de operador Colombia

Codigos de operador Venezuela

Request ejemplo

{
  "flow": "paquetes_list",
  "operador": "pc"
}

Request ejemplo Venezuela

{
  "flow": "venquetes_list",
  "operador": "dtvn"
}

Response ejemplo

{
  "ok": true,
  "data": {
    "operador": "pc",
    "count": 2,
    "rows": [
      {
        "practi_code": 2451,
        "product_desc": "Paquete 15 dias",
        "sell": 15000,
        "percentage": 0
      }
    ]
  },
  "trace_id": "abc123"
}

Comprar paquete

Request ejemplo

{
  "flow": "paquete",
  "operador": "pc",
  "paquete": 2451,
  "celular": "3001234567",
  "idtrans": "1778858151875649"
}

Request compra Venezuela

{
  "flow": "venpaquete",
  "operador": "dtvn",
  "paquete": 9012,
  "celular": "4121234567",
  "idtrans": "1778858151875651"
}

Response ejemplo

{
  "ok": true,
  "data": {
    "idtrans": "1780711896633001",
    "estado": "00",
    "respuesta": "Transaccion exitosa",
    "date": "2026-06-05 09:11:38 PM",
    "info": "aa-bb-cc-dd",
    "codigoauth": "123456",
    "codop": "123456"
  },
  "trace_id": "abc123"
}

Proveedor 1

Consulta por operador. En la compra, paquete debe ser el practi_code devuelto por el catalogo.

Codigos de operador

Request catalogo ejemplo

{
  "flow": "pines_list",
  "operador": "nx"
}

Response catalogo ejemplo

{
  "ok": true,
  "data": {
    "operador": "nx",
    "count": 1,
    "rows": [
      {
        "practi_code": "101001",
        "product_desc": "Pin Netflix",
        "sell": 20000,
        "validity": "30 dias"
      }
    ]
  },
  "trace_id": "abc123"
}

Request compra ejemplo

{
  "flow": "pines",
  "celular": "3001234567",
  "operador": "nx",
  "paquete": 101001,
  "idtrans": "1778858151875649"
}

Response ejemplo

{
  "ok": true,
  "data": {
    "idtrans": "1780711896633001",
    "estado": "00",
    "respuesta": "Transaccion exitosa",
    "date": "2026-06-05 09:11:38 PM",
    "info": "aa-bb-cc-dd",
    "codigoauth": "123456",
    "codop": "123456"
  },
  "trace_id": "abc123"
}

Proveedor 2

Consulta la lista, valida el detalle del producto y envia los campos solicitados en extraInputs.

Codigos de ganancia por producto

Request lista ejemplo

{
  "flow": "pines_prove2_list"
}

Response lista ejemplo

{
  "ok": true,
  "data": {
    "count": 1,
    "rows": [
      {
        "id": "101001",
        "name": "Wifi Premium",
        "operator_code": "wifb",
        "sell": 1500
      }
    ]
  },
  "trace_id": "abc123"
}

Request detalle ejemplo

{
  "flow": "pines_prove2_producto",
  "productId": 101001
}

Response detalle ejemplo

{
  "ok": true,
  "data": {
    "productId": 101001,
    "name": "Wifi Premium",
    "amount": 1500,
    "Inputs": [
      {
        "name": "customerCellphone",
        "label": "Celular",
        "required": true
      }
    ]
  },
  "trace_id": "abc123"
}

Request compra ejemplo

{
  "flow": "pines_prove2_pago",
  "productId": 101001,
  "catalogProductId": 101001,
  "celular": "3001234567",
  "extraInputs": {
    "productId": 101001,
    "customerCellphone": "3001234567",
    "customerEmail": "[email protected]",
    "amount": 1500
  },
  "idtrans": "1778858151875649"
}

Response ejemplo

{
  "ok": true,
  "data": {
    "idtrans": "019e9ab1-b1d8-777b-9bf6-3cae010c5f0a",
    "respuesta": "Exitoso",
    "date": "2026-06-05 09:09:57 PM",
    "requestFeedback": true,
    "producto": "Netflix",
    "telefono": "3008711364",
    "valor": 20000,
    "pin": "uf1bt3"
  },
  "trace_id": "abc123"
}

Consultar catalogo

Devuelve los productos activos para vender. El precio viene en COP y debe usarse para mostrar el valor antes de confirmar la compra.

Request ejemplo

GET /enlace-disney/products
Authorization: Bearer TOKEN_API_CLIENTE
Content-Type: application/json

Campos de respuesta

Response ejemplo

{
  "ok": true,
  "data": {
    "products": [
      {
        "id": 1,
        "name": "Disney Basic",
        "description": "Acceso Disney Basic mensual",
        "price": 19900
      },
      {
        "id": 2,
        "name": "Disney Premium",
        "description": "Acceso Disney Premium mensual",
        "price": 24900
      }
    ],
    "count": 2
  },
  "trace_id": "trc_ed_catalog_001"
}

Comprar producto

La compra descuenta el saldo del integrador, registra la venta multiproducto y devuelve el enlace de activacion cuando la operacion es exitosa.

Request ejemplo

{
  "data": {
    "reference": "1781065879040292",
    "customerName": "Pedro Marin",
    "email": "[email protected]",
    "productId": 2
  }
}

Campos de respuesta

Response ejemplo

{
  "ok": true,
  "data": {
    "result": "success",
    "reference": "1781065879040292",
    "provider_id": "019eafcc-9073-75c9-bb0e-aace0c952d50",
    "link": "https://disney.apiws.co/activate/TOKEN_DE_ACTIVACION",
    "activation_url": "https://disney.apiws.co/activate/TOKEN_DE_ACTIVACION",
    "movement_id": 12544,
    "product": {
      "id": 2,
      "name": "Disney Premium",
      "description": "Acceso Disney Premium mensual",
      "price": 24900
    },
    "customer": {
      "name": "Pedro Marin",
      "email": "[email protected]"
    },
    "ganancia": 747,
    "porcentaje": 3,
    "saldo_anterior": 3233603.44,
    "saldo_actual": 3208703.44
  },
  "trace_id": "trc_ed_buy_001"
}

Consultar estado

Usalo cuando la compra queda en duda por timeout, corte de red o cierre inesperado de la conexion. No descuenta saldo; solo consulta el resultado ya procesado.

Request ejemplo

{
  "data": {
    "reference": "1781065879040292",
    "id": ""
  }
}

Response ejemplo

{
  "ok": true,
  "data": {
    "provider": "enlace_disney",
    "result": "success",
    "is_success": true,
    "reference": "1781065879040292",
    "provider_id": "019eafcc-9073-75c9-bb0e-aace0c952d50",
    "transaction_id": "019eafcc-9073-75c9-bb0e-aace0c952d50",
    "email": "[email protected]",
    "link": "https://disney.apiws.co/activate/TOKEN_DE_ACTIVACION",
    "activation_url": "https://disney.apiws.co/activate/TOKEN_DE_ACTIVACION"
  },
  "trace_id": "trc_ed_status_001"
}

Cuándo consultar estado

Errores comunes

Buenas practicas

Catalogo de convenios

Request ejemplo

{
  "flow": "facturas_convenio_consulta",
  "busqueda": "energia"
}

Response ejemplo

{
  "ok": true,
  "data": {
    "count": 1,
    "rows": [
      {
        "id": "501004",
        "nombre": "Convenio ejemplo",
        "tipo": "2",
        "provider_label": "Proveedor 2"
      }
    ]
  },
  "trace_id": "abc123"
}

Proveedor 1

Request preconsulta

{
  "flow": "facturas_consulta",
  "opc": 1,
  "idConv": 474736649,
  "extConvenio": "1234567890"
}

Response preconsulta

{
  "ok": true,
  "data": {
    "referencia": "1234567890",
    "valorPago": 150820,
    "idPre": "474736649",
    "nconvenio": "Convenio ejemplo",
    "date": "2026-06-05 09:20:00 PM"
  },
  "trace_id": "abc123"
}

Request pago

{
  "flow": "facturas_pago",
  "opc": 1,
  "idPre": "474736649",
  "reference": "1234567890",
  "valor": 150820,
  "celular": "3001234567",
  "extraInputs": {
    "__agreementType": "2"
  },
  "idtrans": "1780711896633001"
}

Response pago

{
  "ok": true,
  "data": {
    "idtrans": "1780711896633001",
    "estado": "00",
    "respuesta": "Transaccion exitosa",
    "date": "2026-06-05 09:20:10 PM",
    "codigoauth": "123456",
    "codop": "123456",
    "producto": "Pago de factura"
  },
  "trace_id": "abc123"
}

Proveedor 2

Request preconsulta

{
  "flow": "facturas_consulta",
  "opc": 2,
  "idConv": 501004,
  "celular": "3001234567",
  "extraInputs": {
    "reference": "1234567890"
  }
}

Response preconsulta

{
  "ok": true,
  "data": {
    "referencia": "1234567890",
    "valorPago": 150820,
    "idPre": "501004",
    "pagoParcial": 0,
    "amountEditable": false,
    "amount": {
      "amount": 150000,
      "cost": 820,
      "incentive": 0
    },
    "sign": "SIGN_PRECONSULTA",
    "inputs": [],
    "date": "2026-06-05 09:21:00 PM"
  },
  "trace_id": "abc123"
}

Request pago

{
  "flow": "facturas_pago",
  "opc": 2,
  "idPre": "501004",
  "reference": "1234567890",
  "valor": 150820,
  "celular": "3001234567",
  "extraInputs": {
    "reference": "1234567890",
    "amount": 150820
  },
  "sign": "SIGN_PRECONSULTA",
  "idtrans": "019e9ab1-b1d8-777b-9bf6-3cae010c5f0a"
}

Response pago

{
  "ok": true,
  "data": {
    "idtrans": "019e9ab1-b1d8-777b-9bf6-3cae010c5f0a",
    "respuesta": "Exitoso",
    "date": "2026-06-05 09:21:15 PM",
    "requestFeedback": true,
    "reference": "1234567890",
    "amount": 150820,
    "producto": "Pago de factura"
  },
  "trace_id": "abc123"
}

Resumen de comisiones

Apuesta deportiva

Request ejemplo

{
  "flow": "apuesta",
  "celular": "1012345678",
  "telefono": "3001234567",
  "operador": "lk",
  "valor": 20000,
  "name": "Cliente Demo",
  "idtrans": "1778858151875649",
  "originCash": 0
}

Response ejemplo

{
  "ok": true,
  "data": {
    "provider": {
      "transactionId": "SPT001",
      "message": "Exitoso"
    }
  },
  "trace_id": "abc123"
}

Recarga especial

Request ejemplo

{
  "celular": "1012345678",
  "operador": "Betplay",
  "idtrans": "1778858151875649",
  "descript": "BetPlay",
  "identidad": "1012345678",
  "valor": 30000
}

Response ejemplo

{
  "ok": true,
  "data": {
    "provider": {
      "transactionId": "ESP001",
      "message": "Exitoso"
    }
  },
  "trace_id": "abc123"
}

Obligaciones

Request ejemplo

{
  "flow": "obligaciones_consulta",
  "productId": 701005,
  "extraInputs": {
    "customerQueryType": "1",
    "reference": "1234567890",
    "customerDocType": "CC",
    "customerDocument": "1012345678",
    "customerPaymentType": "1"
  }
}

Response ejemplo

{
  "ok": true,
  "data": {
    "amount": 25000,
    "amountEditable": false,
    "inputs": [
      { "name": "reference", "required": true, "value": "1234567890" },
      { "name": "amount", "required": true, "value": 25000 }
    ]
  },
  "trace_id": "abc123"
}

Bre-B resolver y depositar

Request resolve ejemplo

{
  "flow": "breb_key_resolve",
  "keyValue": "alias@entidad"
}

Response ejemplo

{
  "ok": true,
  "data": {
    "provider": {
      "status": "00",
      "resolveId": "BRB001",
      "cashinBaseCost": 1000,
      "cashinAdjustment": 300,
      "cashinCost": 1300,
      "cashinMaxAmount": 500000,
      "cashinDailyRemainingForKey": 2
    },
    "keyData": {
      "keyValue": "alias@entidad",
      "accountHolderName": "Cliente Demo",
      "bankName": "Banco Demo"
    }
  }
}

Request cashin ejemplo

{
  "flow": "breb_key_cashin",
  "keyValue": "alias@entidad",
  "resolveId": "BRB001",
  "valor": 50000,
  "idtrans": "1778858151875649",
  "note": "Transferencia Bre-B"
}

Response cashin ejemplo

{
  "ok": true,
  "data": {
    "provider": {
      "transactionId": "BRBCASH001",
      "amount": 50000,
      "baseCost": 1000,
      "costAdjustment": 300,
      "cost": 1300,
      "totalDebit": 51300,
      "message": "Transaccion exitosa"
    }
  }
}

Paso 1: consultar catalogo

Request catalogo

{
  "operador": "nx",
  "pais": "COLOMBIA",
  "reqt": "Crear",
  "format": "json"
}

Response JSON ejemplo

{
  "ok": true,
  "data": {
    "module": "gen_hys",
    "action": "create_service_catalog",
    "operator": "nx",
    "country": "COLOMBIA",
    "request_type": "Crear",
    "count": 1,
    "products": [
      {
        "id": "PKG001",
        "code": "PKG001",
        "operator": "nx",
        "category": "nx",
        "name": "Netflix Premium 30 dias",
        "description": "Netflix Premium 30 dias",
        "value": 30000,
        "currency": "COP"
      }
    ],
    "extra": {
      "requires_plan_selection": true,
      "requires_additional_data": false
    }
  },
  "trace_id": "trc_catalog_001"
}

Response HTML legacy ejemplo

<div class="ov-btn-grow-box3" id="PKG001" data-cost="30000" data-decr="Netflix Premium 30 dias">
  <span>Netflix Premium 30 dias</span>
  <h4>Valor: 30000</h4>
</div>

Paso 2: registrar solicitud

Request crear

{
  "email": "[email protected]",
  "clave": "ClaveSegura123*",
  "pais": "COLOMBIA",
  "req": "Crear",
  "operador": "nx",
  "paquete": "PKG001",
  "descript": "Servicio Netflix",
  "addition": "Plan Premium"
}

Request renovar

{
  "email": "[email protected]",
  "clave": "ClaveActual123*",
  "pais": "MEXICO",
  "req": "Renovar",
  "operador": "amz",
  "paquete": "PKG102",
  "descript": "Amazon 30 dias",
  "addition": "Cuenta principal"
}

Response crear

{
  "idtrans": "019f5d5e-6a61-4750-a4d2-6d1a4c5d6b7e",
  "response": "Espere de 5 - 10 minutos",
  "date": "2026-06-05 09:35:00 PM",
  "estado": "00",
  "addition": "Es importante validar el correo de cada cuenta creada."
}

Response error

{
  "ok": false,
  "error": "INSUFFICIENT_BALANCE",
  "message": "Saldo insuficiente.",
  "trace_id": "trc_create_001"
}

Codigos de operador

Reglas importantes

Reportar servicio especial

Permite reportar fallos de servicios especiales compatibles. El reporte queda asociado al usuario autenticado y a la cuenta entregada.

Request form-data

POST /gen_hys/report_plx/plex

[email protected]
textoplx=La cuenta no permite iniciar sesion desde la app.
[email protected]

Response exitoso

{
  "success": true,
  "message": "Reporte enviado con exito!"
}

Errores de reporte especial

Cuenta sin asociacion

{
  "success": false,
  "message": "Error la cuenta ya no se encuentra asociada a este usuario"
}

Reporte duplicado

{
  "success": false,
  "message": "Ya hay un reporte en espera de respuesta."
}

Patron comun

Request ejemplo

GET /gen_hys/pantalla/catalog
GET /gen_hys/pantalla/summary
POST /gen_hys/pantalla/purchase

Familias activas

Response ejemplo

{
  "ok": true,
  "data": {
    "families": ["pantalla", "pin", "cuenta"]
  }
}

Request

Sin body

Response ejemplo

{
  "ok": true,
  "data": {
    "module": "gen_hys",
    "action": "pantalla_catalog",
    "moneda": "COP",
    "saldo": 50000,
    "total_items": 1,
    "sections": [{"id":"netflix","label":"Netflix","items":[{"id":12345,"nombre":"Netflix 1 pantalla","precio":18000}]}]
  }
}

Request

Sin body

Response ejemplo

{
  "ok": true,
  "data": {
    "module": "gen_hys",
    "action": "pantalla_summary",
    "saldo": 50000,
    "moneda": "COP",
    "total_items": 1,
    "sections": [{"id":"netflix","label":"Netflix","count":1}]
  }
}

Request ejemplo

{
  "product_id": 12345,
  "quantity": 1,
  "cliente": "Cliente demo"
}

Campos de respuesta

Response ejemplo

{
  "ok": true,
  "data": {
    "module": "gen_hys",
    "action": "pantalla_purchase",
    "purchase": {"cant":1,"correo":"[email protected]","contrase":"CLAVE_DE_EJEMPLO","perfil":"Perfil 1","pin":"","pantallas":"1","total":18000,"saldo_restante":32000}
  },
  "trace_id": "abc123"
}

De catalogo a entrega

1. Consulta el catalogo de cuentas o pantallas.
2. Envia el ID elegido como product_id a la ruta de compra de la misma familia.
3. Lee la entrega en data.purchase. Si compras varias unidades, conserva el orden de los campos recibidos como arreglos.
4. Consulta tus ventas antes de repetir una compra sin respuesta.

Historial por fechas

{"fecha1":"2026-09-01","fecha2":"2026-09-30"}

Solo consulta ventas del usuario autenticado. La respuesta utiliza aaData en la raiz. No uses credenciales administrativas para integrar a tus clientes.

Buscar cuentas para renovar

{"mode":"renew","busca":""}

Resultados en aaData. Filtra por correo con busca. Consulta renovable y valor_renovacion antes de confirmar.

Confirmar una renovacion

Requiere saldo y una cuenta propia renovable, entre 1 y 15 dias antes del vencimiento. Solicita confirmacion del cliente antes de enviar: descuenta saldo.

{"crreo":"[email protected]","idc":123,"pr":"Perfil 1","tip":"netflix","pantll2":"1","vg":5}

Exito: estado=1, con vence, valor, saldo_anterior y saldo_nuevo. Para otros estados, revisa message. HTTP 200 no garantiza renovacion exitosa.

Permite registrar un fallo sobre una venta multimedia del usuario autenticado. La venta debe existir y no debe tener un reporte abierto.

Request JSON sin evidencia

{
  "correo": "[email protected]",
  "tipo": "Netflix",
  "perfiles": "Perfil 1",
  "pantallas": "1",
  "mensaje": "El cliente indica que la cuenta no permite iniciar sesion."
}

Request form-data con evidencia

[email protected]
tipo=Netflix
perfiles=Perfil 1
pantallas=1
mensaje=El cliente adjunta captura del error de inicio de sesion.
[email protected]

Response y errores

Response exitosa

{
  "ok": true,
  "success": true,
  "code": "REPORTED",
  "message": "Fallo reportado correctamente.",
  "data": {
    "module": "gen_hys",
    "action": "report",
    "correo": "[email protected]",
    "idc": "",
    "evidencia": null
  },
  "trace_id": "abc123"
}

Consulta los reportes creados por el usuario autenticado para mostrar casos abiertos o resueltos.

Request ejemplo

{}

Response ejemplo

{
  "ok": true,
  "data": {
    "module": "gen_hys",
    "action": "report_history",
    "count": 1,
    "items": [
      {
        "id": 1452,
        "correo": "[email protected]",
        "usuario": "cliente_demo",
        "tipo": "Netflix",
        "perfiles": "Perfil 1",
        "pantallas": "1",
        "estado": "Espera",
        "fecha": "2026-07-01 14:35:10",
        "fechar": "2026-07-01 14:35:10"
      }
    ]
  },
  "trace_id": "abc123"
}

Consulta el hilo, estado y respuesta de soporte para una venta reportada.

Request ejemplo

{
  "correo": "[email protected]",
  "tipo": "Netflix",
  "perfiles": "Perfil 1",
  "pantallas": "1"
}

Response ejemplo

{
  "ok": true,
  "data": {
    "module": "gen_hys",
    "action": "report_thread",
    "count": 1,
    "items": [
      {
        "correo": "[email protected]",
        "usuario": "cliente_demo",
        "agente": "soporte",
        "tipo": "Netflix",
        "perfiles": "Perfil 1",
        "pantallas": "1",
        "estado": "Resuelto",
        "mensaje": "El cliente indica que la cuenta no permite iniciar sesion.",
        "respuesta": "Cuenta revisada y reemplazada.",
        "fecha": "2026-07-01 14:35:10",
        "fechar": "2026-07-01 15:02:44",
        "imagen1": "https://cdn.ejemplo.com/reportes/captura-error.png",
        "imagen2": ""
      }
    ]
  },
  "trace_id": "abc123"
}

Primero solicita el codigo en la plataforma del servicio; luego consultalo aqui con el correo de tu compra. Disponible para cuentas propias compatibles y con permiso gen_hys.

Request ejemplo

{
  "email": "[email protected]",
  "tipo": "netflix",
  "caso": "ininet"
}

Casos comunes

Responses ejemplo

Codigo encontrado

{
  "ok": true,
  "code": "CODE_OK",
  "message": "Codigo encontrado.",
  "data": {
    "code": "123456",
    "date": "2026-07-02 10:15:40"
  }
}

Enlace encontrado

{
  "ok": true,
  "code": "LINK_OK",
  "message": "Enlace encontrado.",
  "data": {
    "link": "https://www.netflix.com/account/travel/verify/abc123",
    "date": "2026-07-02 10:15:40"
  }
}

Errores frecuentes

Error ejemplo

{
  "ok": false,
  "code": "EMAIL_NOT_OWNED",
  "message": "Este correo no esta asociado a su cuenta.",
  "data": []
}