Documentation Powered by ReDoc

API Prepaid (1.0)

Download OpenAPI specification:Download

API-PREPAID

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

Mientras está en modo alpha, no mantendremos versiones anteriores

prepaid

Operaciones contra contratos y tarjetas.

Cash-in y emite tarjeta

Cash-in de tarjeta

Notas

  • Si no se proporciona account_id y card_id se buscara el contrato principal y la tarjeta principal y se asocia la carga a ellos.
  • Si el usuario no tiene contratos se le crea uno y se le emite su primera tarjeta.
  • Requiere un web service en api-users que retorne (Nombre, Apellido, Tipo Doc,Num Doc, Nivel).

    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á 404 en los siguientes casos:

  • 102001: Si el cliente no existe en el ws de api-users.

Responderá 422 en los siguientes casos:

  • 102004: Si el cliente está bloqueado o borrado de prepago.
  • 106000: Si la tarjeta está expirada o tiene un bloqueo duro.
  • 106001: La procesadora rechazó el Cash-in, verificar mensaje.
  • 108000: Transacción duplicada CDT.
  • 108201: El Cash-in supera el monto máximo de Cash-in web.
  • 108202: El Cash-in supera el monto máximo de Cash-in pos.
  • 108203: El Cash-in es menor al mínimo de Cash-in.
  • 108204: El Cash-in supera el monto máximo de Cash-in mensuales.
  • 130005: Si es que se recibio una reversa para la Cash-in previamente.

Responderá 500 en los siguientes casos:

  • Error imprevisto de sistema
path Parameters
user_id
required
string <uuid>

ID del Cliente

Request Body schema: application/json

Detalle del Cash-in 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
merchant_code
required
string <= 15 characters

Código de comercio de la Red.

merchant_category
integer

Código de actividad del comercio

merchant_name
string

Nombre del comercio

Responses

201

OK - Cash-in 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

404

Cliente no existe

422

Cash-in no exitosa, revise error

500

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

post /prepaid/{user_id}/cash_in
https://api-prepaid.cl/v1/prepaid/{user_id}/cash_in

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount":
    {
    },
  • "transaction_id": "12312309123",
  • "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": "12312309123",
  • "id": 7783834,
  • "mc_voucher_type": "A",
  • "mc_voucher_data":
    [
    ],
  • "timestamps":
    {
    }
}

Reversa un Cash-in

Reversa un Cash-in que:

  1. Coincida en todos los campos de prepaid_topup_new.
  2. Se haya recibido en las últimas 24 horas.

Responderá 201 en los siguientes casos:

  • Si el Cash-in se recibió, en cuyo caso iniciara el proceso de reversa.

Responderá 202 en los siguientes casos:

  • 130001: Si el Cash-in nunca se recibió, en cuyo caso se dejara registro de la reversa en caso de recibirlo más adelante.
  • 130003: Si la reversa fue recibida previamente para su procesamiento.

Responderá 410 en los siguientes casos:

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

Responderá 422 en los siguientes casos:

  • 130002: Si es que el Cash-in fue recibido y el monto y moneda no concuerda.
path Parameters
user_id
required
string <uuid>

ID del Cliente

Request Body schema: application/json

Detalle del Cash-in 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
merchant_code
required
string <= 15 characters

Código de comercio de la Red.

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

404

Cliente no existe o no tiene prepago

410

Plazo para reversar expirado

422

Información de reversa no concuerda con el Cash-in

500

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

post /prepaid/{user_id}/cash_in/reverse
https://api-prepaid.cl/v1/prepaid/{user_id}/cash_in/reverse

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount":
    {
    },
  • "transaction_id": "12312309123",
  • "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"
}

Cash-out de dinero

Debita una tarjeta

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á 404 en los siguientes casos:

  • 102001: Si el cliente no existe.
  • 102003: Si el cliente no tiene prepago.

Responderá 422 en los siguientes casos:

  • 102004: Si el cliente está bloqueado o borrado de prepago.
  • 106000: Si la tarjeta está expirada o tiene un bloqueo duro.
  • 106001: La procesadora rechazó el retiro, verificar mensaje.
  • 108000: Transacción duplicada CDT.
  • 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.

Responderá 500 en los siguientes casos:

  • Error imprevisto de sistema
path Parameters
user_id
required
string <uuid>

ID del Cliente

Request Body schema: application/json

Detalle del Cash-out 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
merchant_code
required
string <= 15 characters

Código de comercio de la Red.

merchant_category
integer

Código de actividad del comercio

merchant_name
string

Nombre del comercio

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

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/{user_id}/cash_out
https://api-prepaid.cl/v1/prepaid/{user_id}/cash_out

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount":
    {
    },
  • "transaction_id": "12312309123",
  • "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": "12312309123",
  • "id": 7783834,
  • "mc_voucher_type": "A",
  • "mc_voucher_data":
    [
    ],
  • "timestamps":
    {
    }
}

Reversa un Cash-out

Reversa un Cash-out que:

  1. Coincida en todos los campos de prepaid_withdrawal_new.
  2. Se haya recibido en las últimas 24 horas.

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

  • Si el Cash-out se recibió, en cuyo caso iniciara el proceso de reversa.

Responderá 202 en los siguientes casos:

  • 130001: Si el Cash-out nunca se recibió, en cuyo caso se dejara registro de la reversa en caso de recibirlo más adelante.
  • 130003: Si la reversa fue recibida previamente para su procesamiento.

Responderá 410 en los siguientes casos:

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

Responderá 422 en los siguientes casos:

  • 130002: Si es que el Cash-out fue recibido y el monto y moneda no concuerda.
path Parameters
user_id
required
string <uuid>

ID del Cliente

Request Body schema: application/json

Detalle del Cash-out 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
merchant_code
required
string <= 15 characters

Código de comercio de la Red.

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

404

Cliente no existe o no tiene prepago

410

Plazo para reversar expirado

422

Información de reversa no concuerda con el Cash-out

500

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

post /prepaid/{user_id}/cash_out/reverse
https://api-prepaid.cl/v1/prepaid/{user_id}/cash_out/reverse

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount":
    {
    },
  • "transaction_id": "12312309123",
  • "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"
}

Retiro generico de dinero

Debita una tarjeta Utilizado para Recarga y Pago de cuenta

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á 404 en los siguientes casos:

  • 102001: Si el cliente no existe.
  • 102003: Si el cliente no tiene prepago.

Responderá 422 en los siguientes casos:

  • 102004: Si el cliente está bloqueado o borrado de prepago.
  • 106000: Si la tarjeta está expirada o tiene un bloqueo duro.
  • 106001: La procesadora rechazó el retiro, verificar mensaje.
  • 108000: Transacción duplicada CDT.
  • 108304: El retiro supera el monto máximo de retiros mensuales.

Responderá 500 en los siguientes casos:

  • Error imprevisto de sistema
path Parameters
user_id
required
string <uuid>

ID del Cliente

Request Body schema: application/json

Detalle del withdraw a realizar

transaction_type_id
required
number
Enum: 3025 3026

Tipo de transaccion

transaction_reference_id
required
string

Id de tranasccion externo

transaction_description
string

Descripcion de transaccion

amount
required
object (amount_and_currency_new)

Monto en una moneda específica

merchant
required
object (merchant)

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

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/{user_id}/withdraw
https://api-prepaid.cl/v1/prepaid/{user_id}/withdraw

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transaction_type_id": 3025,
  • "transaction_reference_id": "1234567890",
  • "transaction_description": "Recarga en ...",
  • "amount":
    {
    },
  • "merchant":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "6f813496-ac93-4ee7-a14d-21cc07a2a2a0",
  • "account_id": "0cfd47de-b67f-41b0-9648-6a5af33cfac1",
  • "card_id": "dee33b24-80f1-4915-bd11-57e448ee7369",
  • "amount":
    {
    },
  • "id_transaction": "1234567890",
  • "status": "OK",
  • "timestamps":
    {
    },
  • "description": "Recarga en ..."
}

Reversa un retiro generico

Reversa un retiro generico Utilizado para Recarga y Pago de cuenta

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:

  • 130003: Si la reversa fue recibida previamente para su procesamiento.
path Parameters
user_id
required
string <uuid>

ID del Cliente

transaction_id
required
string <uuid>

ID de transaccion

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

404

Cliente no existe o no tiene prepago

422

Error de validacion

500

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

post /prepaid/{user_id}/withdraw/{transaction_id}/reverse
https://api-prepaid.cl/v1/prepaid/{user_id}/withdraw/{transaction_id}/reverse

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 a una cuenta bancaria

Debita una tarjeta

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á 404 en los siguientes casos:

  • 102001: Si el cliente no existe.
  • 102003: Si el cliente no tiene prepago.

Responderá 422 en los siguientes casos:

  • 102004: Si el cliente está bloqueado o borrado de prepago.
  • 106000: Si la tarjeta está expirada o tiene un bloqueo duro.
  • 106001: La procesadora rechazó el Cash-out, verificar mensaje.
  • 108000: Transacción duplicada CDT.
  • 108302: El Cash-out supera el monto máximo de un Cash-out pos.
  • 108303: El monto de Cash-out es menor al monto mínimo de Cash-out.
  • 108304: El Cash-out supera el monto máximo de Cash-out mensuales.

Responderá 500 en los siguientes casos:

  • Error imprevisto de sistema
path Parameters
user_id
required
string <uuid>

ID del Cliente

Request Body schema: application/json

Detalle del Cash-out 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
merchant_code
required
string <= 15 characters

Código de comercio de la Red.

merchant_category
integer

Código de actividad del comercio

merchant_name
string

Nombre del comercio

bank_id
integer

Codigo SBIF del banco

account_type
string
Enum: "vista" "corriente" "ahorro" "cuenta rut"

Tipo de cuenta

account_name
string

Nombre completo del destinatario

account_number
integer

Número de cuenta sin puntos, guiones, ni ceros a la izquierda

rut
string

El rut destinatario sin puntos

Responses

201

OK - Cash-out realizado

400

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

404

Cliente no existe o no tiene prepago

422

Cash-out no exitoso, revise error

500

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

post /prepaid/cl/{user_id}/defered_cash_out
https://api-prepaid.cl/v1/prepaid/cl/{user_id}/defered_cash_out

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount":
    {
    },
  • "transaction_id": "12312309123",
  • "merchant_code": "0023434",
  • "merchant_category": 112,
  • "merchant_name": "Carnicería el tajo",
  • "bank_id": 4,
  • "account_type": "vista",
  • "account_name": "Juan Perez",
  • "account_number": 0,
  • "rut": "12345678-9"
}

Response samples

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

Reversa un Cash-out

Reversa un retiCash-outro que:

  1. Coincida en todos los campos de prepaid_withdrawal_new.
  2. Se haya recibido en las últimas 24 horas.

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

  • Si el Cash-out se recibió, en cuyo caso iniciara el proceso de reversa.

Responderá 202 en los siguientes casos:

  • 130001: Si el Cash-out nunca se recibió, en cuyo caso se dejara registro de la reversa en caso de recibirlo más adelante.
  • 130003: Si la reversa fue recibida previamente para su procesamiento.

Responderá 410 en los siguientes casos:

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

Responderá 422 en los siguientes casos:

  • 130002: Si es que el Cash-out fue recibido y el monto y moneda no concuerda.
path Parameters
user_id
required
string <uuid>

ID del Cliente

Request Body schema: application/json

Detalle del Cash-out 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
merchant_code
required
string <= 15 characters

Código de comercio de la Red.

merchant_category
integer

Código de actividad del comercio

merchant_name
string

Nombre del comercio

bank_id
integer

Codigo SBIF del banco

account_type
string
Enum: "vista" "corriente" "ahorro" "cuenta rut"

Tipo de cuenta

account_name
string

Nombre completo del destinatario

account_number
integer

Número de cuenta sin puntos, guiones, ni ceros a la izquierda

rut
string

El rut destinatario sin puntos

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

404

Cliente no existe o no tiene prepago

410

Plazo para reversar expirado

422

Información de reversa no concuerda con el Cash-out

500

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

post /prepaid/cl/{user_id}/defered_cash_out/reverse
https://api-prepaid.cl/v1/prepaid/cl/{user_id}/defered_cash_out/reverse

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "amount":
    {
    },
  • "transaction_id": "12312309123",
  • "merchant_code": "0023434",
  • "merchant_category": 112,
  • "merchant_name": "Carnicería el tajo",
  • "bank_id": 4,
  • "account_type": "vista",
  • "account_name": "Juan Perez",
  • "account_number": 0,
  • "rut": "12345678-9"
}

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:

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

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

  • 109002: Saldo no disponible, significa que:
    • La cuenta no existe.
    • La cuenta no pertenece al usuario indicado.
    • No tenia saldo en cache o su saldo estaba expirado y fallo al consultar el nuevo saldo a tecnocom.
path Parameters
user_id
required
string <uuid>

ID del Cliente

account_id
required
string <uuid>

ID Contrato o Cuenta

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}/account/{account_id}/balance
https://api-prepaid.cl/v1/prepaid/{user_id}/account/{account_id}/balance

Response samples

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

Listado de tarjetas de una cuenta

Retorna la lista de tarjetas de una cuenta

path Parameters
user_id
required
string <uuid>

ID del Cliente

account_id
required
string <uuid>

ID Contrato o Cuenta

Responses

200

OK - Lista de tarjetas prepago

500

Error indeterminado

get /prepaid/{user_id}/account/{account_id}/card
https://api-prepaid.cl/v1/prepaid/{user_id}/account/{account_id}/card

Response samples

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

Información de la tarjeta prepago

Retorna la información de la tarjeta prepago

Nota: Este servicio solo retornara informacion si el cliente posee tarjeta de Nivel 2.

Responderá 404 en los siguientes casos:

  • 102001: Si el cliente no existe
  • 102003: Si la tarjeta no es de Nivel 2

Responderá 422 en los siguientes casos:

  • 102002: Cliente bloqueado o borrado
  • 102004: Cliente prepago bloqueado o borrado
path Parameters
user_id
required
string <uuid>

ID del Cliente

account_id
required
string <uuid>

ID Contrato o Cuenta

card_id
required
string <uuid>

ID Tarjeta

Responses

200

OK - Información encriptada de la tarjeta prepago

404

Tarjeta no existe

422

Cliente tiene primera carga en proceso

500

Error indeterminado

get /prepaid/{user_id}/account/{account_id}/card/{card_id}
https://api-prepaid.cl/v1/prepaid/{user_id}/account/{account_id}/card/{card_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"-----BEGIN PGP MESSAGE-----\nVersion: BCPG v1.59\n\nhQEMA8lrFZvFE3EOAQgA1vKQ4i5a/pYl9EtHGPR+o5rcqY3ggQIijnOIJVVTI/Nj\nqYZ3937xoxQEvWn6D6LnDGjMT8Csz2ANuoZI4XGtrhvJhsh5DVda7QMBSe7akNUg\nIqW6t4vgvHHjpFD85npBgzBEa3KE/xQQMpY/jd75NYUl9UAdt3UM+iXizT1eIIK9\nUU0Y4eHY/xkWfPJTCt8O9wdDMjWax+ATE4JcgtAvkQ6y68h8EgHWYaJ0PkRXO/7t\nnRsPr7d0OqpP+Fi6sI/GNSyOi0tLe9WbPn4vzrZiUuSsaQEftA36yQ5KMT3LpOq3\nqNbY6HLoWSfF/uZ2Ra1Y17fYOW8ko7X/mOyCxVbtlNLB5AFTGflCQITw7WGoo25+\n2zglqkA7+GSLLFhEOvstJZTmRRM0X96NNJdwbTkCEdUurYgNjC+3vm4zDU1cYmMy\nwzR2DRHjO2jFjxKNArw+yjuI4MBte9Kz2T31UpwSs+iZndZxMspQqRCH3DZMrMKa\nTGI6xLNkrpzuZyz9tUdliKFMyURRJq8jAvtaYX5eaWt3AHHpa0KFdTi5aAPkAVAt\nFL8VzxHMJgQkXUdX061Cc9TUqSv872grCo8ozqhCq/NRJRdSyJobtOoFAC8Y3XJq\nnF4kShX1Q1ibwqx9jiQ1t4mYsYzrZ3vV3a3XVmjTx7d//maC9geNsonQD1F/ERyh\nMVQRIz2yVno5UOYZtQyyubeiFmdAcO2HgxfdYp/TKyHuMPcv1amxiEwrLqjj5Rmf\nZlKPmzbkgwclfdbilPB8e87WBLFNdnJq7UmMb7NpU8BsITp0QpoiSiSEQ/2DZZqW\nclJ3zZ+zachkp/1zoBlP8UgBS/XCN3VQLvL7Xf5p9OuiL/GOFVZRonLtwRnrq8i8\nOO8FrXwKDkllPb5TVPp9ShcHdm4q6tdYe6W3iKMuY8S81fg6mRVfCPN81m6o1L1V\nfg2L3xg8+PdZTcsGUTD/7xqnaQA78XfqKuVg5bCxgAvQ28MFz7/6RlpLoXNpA7tA\nUBf6tYnx3UYCCZ3r4DpR58aqOIqBs2z7gpv6zNQZ5LSPv07NFyhwkmx73J5ufXqA\nM8VnlBro900mWKyrf+GQxvzgHEZBdB/isXS0O0CfTctezi5V8wNhSj9Oiin8xcEB\nvnSSZ7y0x57JCK13vFwdCZRDVr6JUsvpabQbvePzO/bcpOimvVJd/LGk40KCU7mm\nIU5VfI8kC6vTwTqTULq2ztVsBIqOHvNYcl2NHsEhftlHzrVUjyU=\n=mE45\n-----END PGP MESSAGE-----\n"

Reemisión de tarjeta

Esta llamada cierra la tarjeta informada con card_id y emite una nueva.

Responderá 404 en los siguientes casos:

  • 102001: Si el cliente no existe

Responderá 422 en los siguientes casos:

  • 102003: Si la tarjeta no es de Nivel 2
path Parameters
user_id
required
string <uuid>

ID del Cliente

account_id
required
string <uuid>

ID Contrato o Cuenta

card_id
required
string <uuid>

ID Tarjeta

Responses

200

OK - Información de la tarjeta prepago

404

Cliente o Tarjeta no existe

422

Si la tarjeta no es de Nivel 2

500

Error indeterminado

post /prepaid/{user_id}/account/{account_id}/card/{card_id}/reissue
https://api-prepaid.cl/v1/prepaid/{user_id}/account/{account_id}/card/{card_id}/reissue

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "a4579ad7-e016-4118-afbe-ea939e6c616b",
  • "pan": "517608XXXXXX4840",
  • "name_on_card": "Pedro Perez",
  • "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 o la tarjeta no existe.
path Parameters
user_id
required
string <uuid>

ID del Cliente

account_id
required
string <uuid>

ID Contrato o Cuenta

card_id
required
string <uuid>

ID Tarjeta

Responses

200

OK

404

Cliente no existe o no tiene tarjeta prepago

500

Error indeterminado

put /prepaid/{user_id}/account/{account_id}/card/{card_id}/lock
https://api-prepaid.cl/v1/prepaid/{user_id}/account/{account_id}/card/{card_id}/lock

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "a4579ad7-e016-4118-afbe-ea939e6c616b",
  • "pan": "517608XXXXXX4840",
  • "name_on_card": "Pedro Perez",
  • "status": "ACTIVE",
  • "timestamps":
    {
    }
}

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 o la tarjeta no existe.
path Parameters
user_id
required
string <uuid>

ID del Cliente

account_id
required
string <uuid>

ID Contrato o Cuenta

card_id
required
string <uuid>

ID Tarjeta

Responses

200

OK

404

Cliente no existe o no tiene tarjeta prepago

500

Error indeterminado

put /prepaid/{user_id}/account/{account_id}/card/{card_id}/unlock
https://api-prepaid.cl/v1/prepaid/{user_id}/account/{account_id}/card/{card_id}/unlock

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "a4579ad7-e016-4118-afbe-ea939e6c616b",
  • "pan": "517608XXXXXX4840",
  • "name_on_card": "Pedro Perez",
  • "status": "ACTIVE",
  • "timestamps":
    {
    }
}

Sube un usuario a nivel 2.

Sube a nivel 2 al usuario, permitiendole utilizar la tarjeta Mastercard. Si el usuario ya tiene nivel 2 retorna error.

Responderá 404 en los siguientes casos:

  • 102003: Si el cliente no existe.
  • 140002: Si la cuenta no existe.
  • 106002: Si el usuario no tiene tarjeta activa.

Responderá 422 en los siguientes casos:

  • 102017: Si el cliente ya tiene nivel 2.
path Parameters
user_id
required
string <uuid>

ID del Cliente

account_id
required
string <uuid>

ID Contrato o Cuenta

Responses

200

OK

404

Cliente no existe, cuenta no existe o no tiene tarjeta prepago

422

Cliente ya tiene nivel 2.

500

Error indeterminado

put /prepaid/{user_id}/account/{account_id}/upgrade_card
https://api-prepaid.cl/v1/prepaid/{user_id}/account/{account_id}/upgrade_card

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "a4579ad7-e016-4118-afbe-ea939e6c616b",
  • "pan": "517608XXXXXX4840",
  • "name_on_card": "Pedro Perez",
  • "status": "ACTIVE",
  • "timestamps":
    {
    }
}

Notificación de transacción (Callback del Procesador)

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-prepaid.cl/v1/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"
}

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

  • Cash-in
  • Cash-out
  • PendingCreateCard (Obtencion de Datos y Creacion)
  • Reverse_Cash_in
  • ReverseCash-out
  • PendingEmision (Alta Cliente)
  • IssuanceFee (Cobro de emisión)

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-prepaid.cl/v1/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"
}