Documentation Powered by ReDoc

API Multicaja (Alpha) (0.10)

Download OpenAPI specification:Download

Prepago Multicaja - API Alpha

** Este es una API en alpha y por lo tanto sufrirá muchos cambios **

Mientras está en modo alpha, no mantendremos versiones anteriores

prepaid

Métodos públicos de la API de prepago

Carga una tarjeta

Carga una tarjeta

Notas

  • Valida que el usuario esté habilitado para cargar. Esto significa que el usuario debe estar validado hasta nivel 1 o nivel 2.
  • Valida que la carga no exceda los límites
  • Abona a la Cuenta de Traspaso Personal (CTP) y gatilla un proceso asíncrono que debita la CTP para abonar a la Tarjeta de Prepago.

Responderá 400 en los siguientes casos:

  • 101004: Si un parámetro es requerido y no se ha enviado.
  • 101007: Si un parámetro no cumple formato.

Responderá 401 en los siguientes casos:

  • 401: Si faltó incluir la key de suscripción en el header, o si la key es incorrecta.

Responderá 404 en los siguientes casos:

  • 102001: Si el cliente no está registrado en Tenpo.
  • 102003: Si el cliente no tiene prepago.

Responderá 422 en los siguientes casos:

  • 102002: Si el cliente está bloqueado o borrado.
  • 102004: Si el cliente está bloqueado o borrado de prepago.
  • 102015: Si el cliente está en una lista negra, por lo tanto no puede realizar la carga.
  • 106000: Si la tarjeta está expirada o tiene un bloqueo duro.
  • 106001: La procesadora rechazó la carga, verificar mensaje.
  • 106002: Si la tarjeta no existe.
  • 106011: Si la tarjeta está bloqueada.
  • 108000: Error al validar transacción.
  • 108001: El usuario en nivel 1 solo puede realizar 1 carga.
  • 108201: La carga supera el monto máximo de carga web.
  • 108202: La carga supera el monto máximo de carga pos.
  • 108203: La carga es menor al mínimo de carga.
  • 108204: La carga supera el monto máximo de cargas mensuales.
  • 108901: La carga supera el monto máximo de carga permitida.
  • 108902: El importe es menor al mínimo permitido.
  • 108903: Excedido límite diario en cajeros.
  • 108205 y 108206: La carga supera el monto máximo de primera carga.
  • 130005: Si es que se recibio una reversa para la carga previamente.
  • 140003: Si la cuenta está cerrada.
  • 140004: Si la cuenta está bloqueada.
  • 140005: Si la cuenta está inactiva.
  • 108909: Si el saldo es mayor al saldo permitido.

Responderá 500 en los siguientes casos:

  • Error imprevisto de sistema
header Parameters
Ocp-Apim-Subscription-Key
required
string

Key de subscripción requerido (es entregado por Tenpo)

Request Body schema: application/json

Detalle de la carga a realizar

amount
object (amount_and_currency_new)

Monto en una moneda específica

transaction_id
string

Identificador único que genera quien invoca a esta API

Consideraciones

  • Debe ser único dentro del día
  • Cargas con este dato repetido dentro del día serán rechazadas
  • Cuando quiera reversar la carga, se le pedirá este dato
rut
integer

El rut sin puntos, guión, ni dígito verificador

merchant_code
string <= 15 characters

Código de comercio MC. (máx. 15 dígitos)

merchant_category
integer

Código de actividad del comercio

merchant_name
string

Nombre del comercio

Responses

201

OK - Carga se realizará en los próximos segundos

400

Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado ó no cumple formato

401

Error de key, se lanza a cuando el key de suscripción no fue incluido en el header o está incorrecto

404

Cliente no existe o no tiene prepago

422

Carga no exitosa, revise error

500

Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema

post /prepaid/topup
https://api.multicaja.cl/v0.10-alpha/prepaid/topup

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount":
    {
    },
  • "transaction_id": "MC_12312309123",
  • "rut": 14569484,
  • "merchant_code": "0023434",
  • "merchant_category": 112,
  • "merchant_name": "Carnicería el tajo"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount":
    {
    },
  • "transaction_id": "MC_12312309123",
  • "id": 7783834,
  • "mc_voucher_type": "A",
  • "mc_voucher_data":
    [
    ],
  • "timestamps":
    {
    }
}

Reversa una carga

Reversa una carga que a) coincida en todos los campos de prepaid_topup_new y b) se haya recibido en las últimas 24 horas.

Responderá 201 en los siguientes casos:

  • Si la carga se recibió, en cuyo caso iniciara el proceso de reversa.

Responderá 202 en los siguientes casos:

  • 130001: Si la carga nunca se recibió, en cuyo caso se dejara registro de la reversa en caso de recibir la carga mas adelante.
  • 130003: Si la reversa fue recibida previamente para su procesamiento.

Responderá 400 en los siguientes casos:

  • 101004: Si un parámetro es requerido y no se ha enviado.
  • 101007: Si un parámetro no cumple formato.

Responderá 401 en los siguientes casos:

  • 401: Si faltó incluir la key de suscripción en el header, o si la key es incorrecta.

Responderá 404 en los siguientes casos:

  • 102001: Si el cliente no está registrado en Tenpo.
  • 102003: Si el cliente no tiene prepago.

Responderá 410 en los siguientes casos:

  • 130004: Si es que la carga fue recibida y no está reversada, pero el plazo para reversarla ya expiró.

Responderá 422 en los siguientes casos:

  • 130002: Si es que la carga fue recibida y la información de la reversa no concuerda.
header Parameters
Ocp-Apim-Subscription-Key
required
string

Key de subscripción requerido (es entregado por Tenpo)

user-timezone
string

La zona horaria del cliente (default America/Santiago)

Request Body schema: application/json

Detalle de la carga a realizar

amount
object (amount_and_currency_new)

Monto en una moneda específica

transaction_id
string

Identificador único que genera quien invoca a esta API

Consideraciones

  • Debe ser único dentro del día
  • Cargas con este dato repetido dentro del día serán rechazadas
  • Cuando quiera reversar la carga, se le pedirá este dato
rut
integer

El rut sin puntos, guión, ni dígito verificador

merchant_code
string <= 15 characters

Código de comercio MC. (máx. 15 dígitos)

merchant_category
integer

Código de actividad del comercio

merchant_name
string

Nombre del comercio

Responses

201

OK - Proceso de reversa iniciado

202

OK - Reversa recibida previamente

400

Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado

401

Error de key, se lanza a cuando el key de suscripción no fue incluido en el header o está incorrecto

404

Cliente no existe o no tiene prepago

410

Plazo para reversar expirado

422

Información de reversa no concuerda con la carga

500

Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema

post /prepaid/topup/reverse
https://api.multicaja.cl/v0.10-alpha/prepaid/topup/reverse

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount":
    {
    },
  • "transaction_id": "MC_12312309123",
  • "rut": 14569484,
  • "merchant_code": "0023434",
  • "merchant_category": 112,
  • "merchant_name": "Carnicería el tajo"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 1024,
  • "message": "El cliente no pasó la validación"
}

Retira dinero de una tarjeta

Debita una tarjeta

Notas

  • Valida que el usuario esté habilitado para retirar.
  • Valida que el retiro no exceda los límites
  • Debita la Tarjeta de Prepago y abona a la Cuenta de Traspaso Personal (CTP), luego debita la CTP y abona a la cuenta de destino.

Responderá 400 en los siguientes casos:

  • 101004: Si un parámetro es requerido y no se ha enviado.
  • 101007: Si un parámetro no cumple formato.

Responderá 401 en los siguientes casos:

  • 401: Si faltó incluir la key de suscripción en el header, o si la key es incorrecta.

Responderá 404 en los siguientes casos:

  • 102001: Si el cliente no está registrado en Tenpo.
  • 102003: Si el cliente no tiene prepago.

Responderá 422 en los siguientes casos:

  • 102002: Si el cliente está bloqueado o borrado.
  • 102004: Si el cliente está bloqueado o borrado de prepago.
  • 102053: Si la clave ingresada no coincide.
  • 102015: Si el cliente está en una lista negra, por lo tanto no puede realizar la carga.
  • 103001: Si la cuenta bancaria seleccionada no está asociada al cliente.
  • 106000: Si la tarjeta está expirada o tiene un bloqueo duro.
  • 106001: La procesadora rechazó el retiro, verificar mensaje.
  • 106002: Si la tarjeta no existe.
  • 106011: Si la tarjeta está bloqueada.
  • 108000: Error al validar transacción.
  • 108301: El retiro supera el monto máximo de un retiro web.
  • 108302: El retiro supera el monto máximo de un retiro pos.
  • 108303: El monto de retiro es menor al monto mínimo de retiros.
  • 108304: El retiro supera el monto máximo de retiros mensuales.
  • 108901: El retiro supera el monto máximo de un retiro.
  • 108902: El importe es menor al mínimo permitido.
  • 108903: Excedido límite diario en cajeros.
  • 140003: Si la cuenta está cerrada.
  • 140004: Si la cuenta está bloqueada.
  • 140005: Si la cuenta está inactiva.
  • 108909: Si el saldo es mayor al saldo permitido.

Responderá 500 en los siguientes casos:

  • Error imprevisto de sistema
header Parameters
Ocp-Apim-Subscription-Key
required
string

Key de subscripción requerido (es entregado por Tenpo)

Request Body schema: application/json

Detalle del retiro a realizar

amount
object (amount_and_currency_new)

Monto en una moneda específica

transaction_id
string

Identificador único que genera quien invoca a esta API

Consideraciones

  • Debe ser único dentro del día
  • Cargas con este dato repetido dentro del día serán rechazadas
  • Cuando quiera reversar la carga, se le pedirá este dato
rut
integer

El rut sin puntos, guión, ni dígito verificador

merchant_code
string <= 15 characters

Código de comercio MC. (máx. 15 dígitos)

merchant_category
integer

Código de actividad del comercio

merchant_name
string

Nombre del comercio

password
integer

La clave del usuario

Responses

201

OK - Retiro realizado

400

Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado ó no cumple formato

401

Error de key, se lanza a cuando el key de suscripción no fue incluido en el header o está incorrecto

404

Cliente no existe o no tiene prepago

422

Retiro no exitoso, revise error

500

Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema

post /prepaid/withdrawal
https://api.multicaja.cl/v0.10-alpha/prepaid/withdrawal

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount":
    {
    },
  • "transaction_id": "MC_12312309123",
  • "rut": 14569484,
  • "merchant_code": "0023434",
  • "merchant_category": 112,
  • "merchant_name": "Carnicería el tajo",
  • "password": 132465
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount":
    {
    },
  • "transaction_id": "MC_12312309123",
  • "id": 7783834,
  • "mc_voucher_type": "A",
  • "mc_voucher_data":
    [
    ],
  • "timestamps":
    {
    }
}

Reversa un retiro

Reversa un retiro que a) coincida en todos los campos de prepaid_withdrawal_new y b) se haya recibido en las últimas 24 horas.

Responderá 201 (éxito) en los siguientes casos:

  • Si el retiro se recibió, en cuyo caso iniciara el proceso de reversa.

Responderá 202 en los siguientes casos:

  • 130001: Si el retiro nunca se recibió, en cuyo caso se dejara registro de la reversa en caso de recibir el retiro mas adelante.
  • 130003: Si la reversa fue recibida previamente para su procesamiento.

Responderá 400 en los siguientes casos:

  • 101004: Si un parámetro es requerido y no se ha enviado.
  • 101007: Si un parámetro no cumple formato.

Responderá 401 en los siguientes casos:

  • 401: Si faltó incluir la key de suscripción en el header, o si la key es incorrecta.

Responderá 404 en los siguientes casos:

  • 102001: Si el cliente no está registrado en Tenpo.
  • 102003: Si el cliente no tiene prepago.

Responderá 410 en los siguientes casos:

  • 130004: Si es que el retiro fue recibido y no está reversado, pero el plazo para reversarlo ya expiró.

Responderá 422 en los siguientes casos:

  • 130002: Si es que el retiro fue recibido la información de la reversa no concuerda.
header Parameters
Ocp-Apim-Subscription-Key
required
string

Key de subscripción requerido (es entregado por Tenpo)

user-timezone
string

La zona horaria del cliente (default America/Santiago)

Request Body schema: application/json

Detalle de la carga a realizar

amount
object (amount_and_currency_new)

Monto en una moneda específica

transaction_id
string

Identificador único que genera quien invoca a esta API

Consideraciones

  • Debe ser único dentro del día
  • Cargas con este dato repetido dentro del día serán rechazadas
  • Cuando quiera reversar la carga, se le pedirá este dato
rut
integer

El rut sin puntos, guión, ni dígito verificador

merchant_code
string <= 15 characters

Código de comercio MC. (máx. 15 dígitos)

merchant_category
integer

Código de actividad del comercio

merchant_name
string

Nombre del comercio

password
integer

La clave del usuario

Responses

201

OK - Proceso de reversa iniciado

202

OK - Reversa recibida previamente

400

Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado

401

Error de key, se lanza a cuando el key de suscripción no fue incluido en el header o está incorrecto

404

Cliente no existe o no tiene prepago

410

Plazo para reversar expirado

422

Información de reversa no concuerda con el retiro

500

Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema

post /prepaid/withdrawal/reverse
https://api.multicaja.cl/v0.10-alpha/prepaid/withdrawal/reverse

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount":
    {
    },
  • "transaction_id": "MC_12312309123",
  • "rut": 14569484,
  • "merchant_code": "0023434",
  • "merchant_category": 112,
  • "merchant_name": "Carnicería el tajo",
  • "password": 132465
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 1024,
  • "message": "El cliente no pasó la validación"
}

Lista las cargas de un cliente

Retorna un listado con todas las cargas que ha realizado el cliente, junto a su estatus

path Parameters
user_id
required
integer

ID del Cliente

query Parameters
page
integer

Página

Responses

200

OK - Búsqueda exitosa

400

Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado

404

Cliente no existe o no tiene prepago

500

Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema

get /prepaid/{user_id}/topup
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}/topup

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Notificación (Callback)

Mensaje invocado por el procesador/emisor

Notifica una transacción ocurrida en una tarjeta de prepago

Para invocar este servicio se debe incluir el API Key en el header X-API-KEY

Responderá 401 en los siguientes casos:

  • API Key faltante o invalido.

Responderá 400 en los siguientes casos:

  • 101004: Si faltan parametros en el header o body. Ver información del error para mas detalle.

Responderá 422 en los siguientes casos:

  • 101007: Si el atributo base64_data no es un Base64 valido.
Request Body schema: application/json

Transacción

header
object (raw_transaction_header_new)

Encabezado de transacción notificada en vivo por el procesador (Request)

body
object (raw_transaction_body_new)

Campos interpretados de transacción notificada en vivo por el procesador (Request)

base64_data
string

String concatenado con todos los campos disponibles, codificado en base 64

Responses

202

OK

400

Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado

401

Unauthorized

422

El mensaje raw_transaction_new tiene un error

500

Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema

post /prepaid/processor/notification
https://api.multicaja.cl/v0.10-alpha/prepaid/processor/notification

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "header":
    {
    },
  • "body":
    {
    },
  • "base64_data": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvS4=="
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 1024,
  • "message": "El cliente no pasó la validación"
}

Retorna el saldo de un cliente prepago

Retorna el saldo del cliente prepago

Responderá 404 con código de error en los siguientes casos:

  • 102001: Si el cliente no existe
  • 102003: Si el cliente no está registrado en prepago

Responderá 422 con código de error en los siguientes casos:

  • 102002: Cliente bloqueado o borrado
  • 102004: Cliente prepago bloqueado o borrado
  • 106007: Si cliente no tiene saldo o tiene saldo expirado y además tiene una carga pendiente
  • 106008: Si cliente no tiene saldo o tiene saldo expirado y además tiene una carga en proceso
  • 109002: Saldo no disponible (significa que no tenia saldo en cache o su saldo estaba expirado y fallo al consultar el nuevo saldo a tecnocom)
path Parameters
user_id
required
integer

ID del Cliente

Responses

200

OK - Saldo obtenido

400

Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado

404

Cliente no existe o no tiene prepago

422

Valicación de cliente o saldo

500

Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema

get /prepaid/{user_id}/balance
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}/balance

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "balance":
    {
    },
  • "pca_main":
    {
    },
  • "pca_secondary":
    {
    },
  • "updated": true
}

Calculadora de carga

Calculadora simulación de carga

En caso de que una simulación tenga un error especifico, el mismo viene definido en los campos code y message

Responderá 404 en los siguientes casos:

  • 102001: Si el cliente no existe
  • 102003: Si el cliente no está registrado en prepago

Responderá 422 en los siguientes casos:

  • 108000: Error generico en CDT
  • 108203: Error en CDT (LA_CARGA_ES_MENOR_AL_MINIMO_DE_CARGA)
  • 108204: Error en CDT (LA_CARGA_SUPERA_EL_MONTO_MAXIMO_DE_CARGAS_MENSUALES)
  • 108206: Error en CDT (LA_CARGA_SUPERA_EL_MONTO_MAXIMO_DE_PRIMERA_CARGA)
  • 109000: Saldo supera el monto maximo
path Parameters
user_id
required
integer

ID del Cliente

Request Body schema: application/json

Requerimiento de calculo

amount
object (amount_and_currency_new)

Monto en una moneda específica

Responses

200

OK - Respuesta exitosa.

400

Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado

404

Cliente no existe o no tiene prepago

422

Error en validación

500

Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema

post /prepaid/{user_id}/simulation/topup
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}/simulation/topup

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "simulation_topup_web":
    {
    },
  • "simulation_topup_pos":
    {
    }
}

Calculadora de retiro

Calculadora de retiro

Responderá 404 en los siguientes casos:

  • 102001: Si el cliente no existe
  • 102003: Si el cliente no está registrado en prepago

Responderá 422 en los siguientes casos:

  • 108000: Error generico en CDT
  • 108301: Error en CDT (EL_RETIRO_SUPERA_EL_MONTO_MAXIMO_DE_UN_RETIRO_WEB)
  • 108302: Error en CDT (EL_RETIRO_SUPERA_EL_MONTO_MAXIMO_DE_UN_RETIRO_POS)
  • 108303: Error en CDT (EL_MONTO_DE_RETIRO_ES_MENOR_AL_MONTO_MINIMO_DE_RETIROS)
  • 108304: Error en CDT (EL_RETIRO_SUPERA_EL_MONTO_MAXIMO_DE_RETIROS_MENSUALES)
  • 109001: Saldo insuficiente
path Parameters
user_id
required
integer

ID del Cliente

Request Body schema: application/json

Requerimiento de calculo

amount
object (amount_and_currency_new)

Monto en una moneda específica

method
string
Enum: "POS" "WEB"

Responses

200

OK - Respuesta exitosa

400

Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado

404

Cliente no existe o no tiene prepago

422

Error en validación

500

Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema

post /prepaid/{user_id}/simulation/withdrawal
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}/simulation/withdrawal

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount":
    {
    },
  • "method": "POS"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fee":
    {
    },
  • "amount_to_discount":
    {
    }
}

Información de la tarjeta prepago

Retorna la información de la tarjeta prepago

Responderá 404 en los siguientes casos:

  • 102001: Si el cliente no existe
  • 102003: Si el cliente no está registrado en prepago

Responderá 422 en los siguientes casos:

  • 102002: Cliente bloqueado o borrado
  • 102004: Cliente prepago bloqueado o borrado
  • 106007: Si el cliente está registrado en prepago, pero no ha realizado la primera carga
  • 106008: Si cliente está registrado en prepago, ya realizo la primera carga y la misma esta en proceso
path Parameters
user_id
required
integer

ID del Cliente

Responses

200

OK - Información de la tarjeta prepago

404

Cliente no existe o no tiene tarjeta prepago

422

Cliente tiene primera carga en proceso

500

Error indeterminado

get /prepaid/{user_id}/card
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}/card

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "processor_user_id": "43438500955156352167",
  • "pan": "517608XXXXXX4840",
  • "name_on_card": "Pedro Perez",
  • "expiration_date": 202301,
  • "status": "ACTIVE",
  • "timestamps":
    {
    }
}

Bloquea la tarjeta prepago

Bloquea la tarjeta prepago.

Si la tarjeta ya esta bloqueada este metodo no hace nada

Responderá 404 en los siguientes casos:

  • Si el cliente no existe
  • Si el cliente no está registrado en prepago

Responderá 422 en los siguientes casos:

  • Si el cliente está registrado en prepago, pero no ha realizado la primera carga
  • Si cliente está registrado en prepago, ya realizo la primera carga y la misma esta en proceso
path Parameters
user_id
required
integer

ID del Cliente

Responses

204

OK

404

Cliente no existe o no tiene tarjeta prepago

422

Cliente tiene primera carga en proceso

500

Error indeterminado

put /prepaid/{user_id}/card/lock
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}/card/lock

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 1024,
  • "message": "El cliente no pasó la validación"
}

Desbloquea la tarjeta prepago

Desbloquea la tarjeta prepago

Si la tarjeta esta activa este metodo no hace nada

Responderá 404 en los siguientes casos:

  • Si el cliente no existe
  • Si el cliente no está registrado en prepago

Responderá 422 en los siguientes casos:

  • Si el cliente está registrado en prepago, pero no ha realizado la primera carga
  • Si cliente está registrado en prepago, ya realizo la primera carga y la misma esta en proceso
path Parameters
user_id
required
integer

ID del Cliente

Responses

204

OK

404

Cliente no existe o no tiene tarjeta prepago

422

Cliente tiene primera carga en proceso

500

Error indeterminado

put /prepaid/{user_id}/card/unlock
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}/card/unlock

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 1024,
  • "message": "El cliente no pasó la validación"
}

Buscar usuario prepago

Retorna la información del usuario prepago por rut

Responderá 404 en los siguientes casos:

  • 102001: Si el cliente no existe
  • 102003: Si el cliente no está registrado en prepago
query Parameters
rut
required
integer

Rut sin puntos, guion ni digito verificador

Responses

200

OK - Información del usuario prepago

404

Cliente no existe o no tiene tarjeta prepago

500

Error indeterminado

get /prepaid/
https://api.multicaja.cl/v0.10-alpha/prepaid/

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 123456,
  • "user_id": 654321,
  • "rut": 11111111,
  • "status": "ACTIVE",
  • "user_level": "LEVEL_1",
  • "timestamps":
    {
    }
}

Información del usuario prepago

Retorna la información del usuario prepago

Responderá 404 en los siguientes casos:

  • 102001: Si el cliente no existe
  • 102003: Si el cliente no está registrado en prepago
path Parameters
user_id
required
integer

ID del Cliente

Responses

200

OK - Información del usuario prepago

404

Cliente no existe o no tiene tarjeta prepago

500

Error indeterminado

get /prepaid/{user_id}
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 123456,
  • "user_id": 654321,
  • "rut": 11111111,
  • "status": "ACTIVE",
  • "user_level": "LEVEL_1",
  • "timestamps":
    {
    }
}

Lista de transacciones

Retorna una lista con las transacciones del cliente

Responderá 404 en los siguientes casos:

  • 102001: Si el cliente no existe
  • 102003: Si el cliente no está registrado en prepago

Responderá 422 con código de error en los siguientes casos:

  • 102002: Cliente bloqueado o borrado
  • 102004: Cliente prepago bloqueado o borrado
  • 106007: Si el cliente está registrado en prepago, pero no ha realizado la primera carga
  • 106008: Si cliente está registrado en prepago, ya realizo la primera carga y la misma esta en proceso
path Parameters
user_id
required
integer

ID del Cliente

query Parameters
from
string <date>

Fecha desde (yyyy-mm-dd)

to
string <date>

Fecha hasta (yyyy-mm-dd)

count
integer

Total de registros a extraer, si no se envia significa que son todos los registros, si se envia solo se retornan la cantidad especificada

Responses

200

OK - Transacciones

400

Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado

404

Cliente no existe o no tiene tarjeta prepago

500

Error indeterminado

get /prepaid/{user_id}/transactions
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}/transactions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Carga fotos de verificacion de identidad

Carga la informacion de las fotos de verificacion de identidad

  • CI lado frontal

  • CI lado posterior

  • Selfie con CI

    Responderá 400 en los siguientes casos:

  • 101004: Si falta un parametro requerido.

Responderá 404 en los siguientes casos:

  • 102001: Si el cliente no existe
  • 102003: Si el cliente no está registrado en prepago

Responderá 422 en los siguientes casos:

  • 102002: Si el cliente esta bloqueado o borrado.
  • 102004: Si el cliente prepago esta bloqueado o borrado.
path Parameters
user_id
required
integer

ID del Cliente

Request Body schema: application/json

Informacion de fotos

USER_CI_FRONTAL
object (prepaid_identity_verification_file_new)

Archivo para verificacion de identidad

USER_ID_BACK
object (prepaid_identity_verification_file_new)

Archivo para verificacion de identidad

USER_SELFIE
object (prepaid_identity_verification_file_new)

Archivo para verificacion de identidad

Responses

201

OK - Respuesta exitosa

400

Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado. Verificar detalle del error.

404

Cliente no existe o no tiene prepago

422

Error en validación. Verificar detalle del error.

500

Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema

post /prepaid/{user_id}/identity/files
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}/identity/files

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "USER_CI_FRONTAL":
    {
    },
  • "USER_ID_BACK":
    {
    },
  • "USER_SELFIE":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 1024,
  • "message": "El cliente no pasó la validación"
}

Busca un mensaje en la cola y lo reinjecta en la cola en la cual falló

Busca un mensaje en la cola y lo reinjecta en la cola en la cual falló las colas son

  • TopUp (Carga)

  • WithDrawal (Retiro)

  • PendingCreateCard (Obtencion de Datos y Creacion)

  • ReverseTopup (Reversa Carga)

  • ReverseWithdrawal (Reversa de Retiro)

  • SendMail(Envio mail Tarjeta)

  • PendingEmision (Alta Cliente)

  • IssuanceFee (Cobro de comision)

    Responderá 400 en los siguientes casos:

  • 101004: Si falta un parametro requerido.

Request Body schema: application/json

Informacion de la cola

id_queue
string

Id del mensaje de la cola a ser reinjectado

queues_name_type
string
Enum: "TopUp" "WithDrawal" "PendingCreateCard" "ReverseTopup" "ReverseWithdrawal" "SendMail" "PendingEmision" "IssuanceFee"

Responses

201

OK - Respuesta exitosa

400

Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado. Verificar detalle del error.

404

Cliente no existe o no tiene prepago

422

Error en validación. Verificar detalle del error.

500

Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema

post /prepaid/Queue
https://api.multicaja.cl/v0.10-alpha/prepaid/Queue

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id_queue": "xkfuqwofklasjf",
  • "queues_name_type": "TopUp"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 1024,
  • "message": "El cliente no pasó la validación"
}

Procesa la validación de identidad realizada en Freshdesk

Procesa la validación de identidad realizada en Freshdesk

path Parameters
user_id
required
integer

ID del Cliente

Request Body schema: application/json

Informacion de verificacion

is_ci_valid
string

¿Posee cédula vigente en Registro Civil?

user_photo_matches_ci
string

¿Concuerda la foto de la persona con la persona de la cédula identidad?

name_and_lastname_matches_ci
string

¿El nombre y primer apellido del cliente concuerda con los de la cédula de identidad?

new_name
string

Sobreescribir Nombre

new_lastname
string

Sobreescribir Apellido

is_gsintel_ok
string

¿Pasa la validación de Gesintel?

rut_matches_ci
string

¿El RUT concuerda con el de la cédula de identidad?

Responses

201

OK - Respuesta exitosa

post /prepaid/{user_id}/identity_verification
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}/identity_verification

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "is_ci_valid": "Si",
  • "user_photo_matches_ci": "Si",
  • "name_and_lastname_matches_ci": "No",
  • "new_name": "Jose",
  • "new_lastname": "Perez",
  • "is_gsintel_ok": "Si",
  • "rut_matches_ci": "Si"
}

Enviar correo al cliente

Envía comunicacion al email del cliente.

Notas

  • Si el template indicado es Prepago/EnvioTarjeta, entonces se envia la tarjeta como adjunto al mail cliente.
path Parameters
user_id
required
integer

ID del usuario

Request Body schema: application/json

Correo electrónico a enviar

template
required
string

Tipo de correo electrónico a enviar

template_data
string

JSON con tantos pares llave-valor como requiera el template del correo a enviar

address
string

Correo electrónico al que se enviará este mensaje. Si no se incluye este campo, se usará el campo email.value del Cliente.

attachments
Array of objects (email_attachment_new)

Responses

202

Accepted

404

Cliente no existe

422

El mail contiene datos inválidos

post /prepaid/{user_id}/mail
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}/mail

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "template": "Prepago/ValidacionCorreo",
  • "template_data": "{'saludo': 'Estimado Pepito', 'despedida': 'Chao!'}",
  • "address": "pepito@gmail.com",
  • "attachments":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 1024,
  • "message": "El cliente no pasó la validación"
}

prepaid-signup

Registro de usuarios de prepago

Inicia un proceso de registro para obtener la tarjeta de prepago

Inicia un proceso de registro. Retorna prepaid_user, el que indica qué pasos se deben realizar.

Llamadas permitidas cuando el cliente está registrándose:

  # API-Prepaid
  POST /prepaid/signup
  GET  /prepaid/signup/{signup_id}

  # API-Users
  GET  /users/{user_id}
  POST /users/{user_id}/update_personal_data
  POST /users/{user_id}/validate_rut
  POST /users/{user_id}/validate_email
  PUT /users/{user_id}/mail
  POST /users/{user_id}/validate_cellphone
  PUT /users/{user_id}/sms
  POST /users/{user_id}/sign_contract
  POST /users/{user_id}/update_password # debe ser la última llamada
path Parameters
user_id
required
integer

ID del Cliente

Responses

200

OK - Usuario registrado en prepago.

400

Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado

404

Cliente no existe o no tiene prepago

500

Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema

post /prepaid/{user_id}/signup
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}/signup

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 123456,
  • "user_id": 654321,
  • "rut": 11111111,
  • "status": "ACTIVE",
  • "user_level": "LEVEL_1",
  • "timestamps":
    {
    }
}

Terminos y Condiciones

Informacion de los terminos y condiciones vigentes para Prepago

path Parameters
user_id
required
integer

ID del Cliente

Responses

200

OK

404

Cliente no existe o no tiene prepago

500

Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema

get /prepaid/{user_id}/signup/tac
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}/signup/tac

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "version": "v1.0",
  • "location": "/prepaid/terms_and_conditions_v10"
}

Aceptar Terminos y Condiciones

Aceptar los beneficios y los terminos y condiciones del producto Prepago

path Parameters
user_id
required
integer

ID del Cliente

Request Body schema: application/json

Detalle

version
string

Version de los terminos y condiciones aceptados por el usuario

benefits_accepted
boolean

Cliente acepta recibir beneficios relacionados con el producto prepago

Responses

200

OK

400

Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado

404

Cliente no existe o no tiene prepago

422

Error de validación de negocio, revise error

500

Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema

post /prepaid/{user_id}/signup/tac
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}/signup/tac

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "version": "v1.0",
  • "benefits_accepted": false
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 1024,
  • "message": "El cliente no pasó la validación"
}

prepaid_finish_signup

Termina un proceso de registro para obtener la tarjeta de prepago

Termina un proceso de registro. Retorna prepaid_user.

path Parameters
user_id
required
integer

ID del Cliente

Responses

200

OK - Usuario prepago.

400

Error en parámetros, se lanza a cuando un parámetro es requerido y no se ha enviado

422

Carga no exitosa, revise error

500

Error indeterminado, se lanza cuando ocurre un error imprevisto de sistema

post /prepaid/{user_id}/finish_signup
https://api.multicaja.cl/v0.10-alpha/prepaid/{user_id}/finish_signup

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 123456,
  • "user_id": 654321,
  • "rut": 11111111,
  • "status": "ACTIVE",
  • "user_level": "LEVEL_1",
  • "timestamps":
    {
    }
}