API Recargas (1.0.0)

Download OpenAPI specification:Download

La API de recargas de Multicaja es la que usan sus diferentes productos digitales para realizar recargas a través del Switch Transaccional de Multicaja.

Autenticación

Todos los requerimientos son autenticados usando un api-key incluido en el header x-api-key o apikey.

Errores

La API usa códigos HTTP estándares para indicar el éxito o fracaso de un requerimiento. El cuerpo del mensaje es json con el siguiente formato:

{
    "status": 400,
    "error": "Bad Request",
    "message": "Invalid property 'origin'",
    "path": "/recharges/v1/check",
    "timestamp": "2018-08-02T14:56:37.427"
}

Recargas

Operaciones disponibles para recargas

Obtener productos

Obtiene un listado de productos de recarga agrupados por operador

Responses

200

500

Server Error

get /products

https://api.multicaja.cl/recharges/v1/products

Response samples

Content type

application/json

Copy

Expand all Collapse all

[

{
- "id": 1,
- "order": 1,
- "code": "movistar",
- "name": "Movistar",
- "products":
  [
  - {
    "id": 1,
    "type":
    {
    "id": 1,
    "code": "bam",
    "name": "Banda Ancha Móvil",
    "order": 1
    },
    "amount":
    {
    "min": 750,
    "max": 25000,
    "multi":
    [
    [
    750,
    1000,
    2000
    ]
    ]
    },
    "suscriptor": "numero"
    }
  ]
}

]

Verificar factibilidad

Verificación de factibilidad de una recarga

Request Body schema: application/json

Datos de la recarga

origin required	string Texto que identifica la plataforma que está haciendo la recarga, es requerido por el Switch de Multicaja como dato de control
stan required	integer <int32> Identificador secuencial de la transacción, largo máximo 6 dígitos
product_id required	integer <int64> Identificador del producto a recargar
amount required	integer <int64> Monto a recargar
suscriptor required	string Número identificador de la recarga, dependiendo del producto puede ser un rut o un número de teléfono
commerce_id required	integer <int64> Identificador del comercio
branch_id required	integer <int64> Identificador de la sucursal
terminal_id required	integer <int64> Identificador del terminal

Responses

200

400

Alguno de los campos requeridos no viene o es inválido

500

Server Error

502

Error al comunicarse con el Switch Multicaja

504

Timeout al comunicarse con el Switch Multicaja

post /check

https://api.multicaja.cl/recharges/v1/check

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"origin": "RECARGACL",
"stan": 1,
"product_id": 1,
"amount": 1500,
"suscriptor": 995168137,
"commerce_id": 325,
"branch_id": 325,
"terminal_id": 317

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"response_code": "01",
"response_message": "TRANSACCION APROBADA",
"transaction_id": 795547062,
"authorization_id": "700000612259",
"created_at": "2018-03-16T16:38:31.28571",
"recharge":
{
- "suscriptor": "988598372",
- "amount": 1500,
- "operator": "Movistar",
- "type": "Telefonía Móvil"
}

}

Realizar recargar

Realiza una recarga con cargo al comercio informado

Request Body schema: application/json

Datos de la recarga

origin required	string Texto que identifica la plataforma que está haciendo la recarga, es requerido por el Switch de Multicaja como dato de control
stan required	integer <int32> Identificador secuencial de la transacción, largo máximo 6 dígitos
product_id required	integer <int64> Identificador del producto a recargar
amount required	integer <int64> Monto a recargar
suscriptor required	string Número identificador de la recarga, dependiendo del producto puede ser un rut o un número de teléfono
check_transaction_id required	integer <int64> Identificador de la transacción de verificación de factibilidad
commerce_id required	integer <int64> Identificador del comercio
branch_id required	integer <int64> Identificador de la sucursal
terminal_id required	integer <int64> Identificador del terminal

Responses

200

400

Alguno de los campos requeridos no viene o es inválido

500

Server Error

502

Error al comunicarse con el Switch Multicaja

504

Timeout al comunicarse con el Switch Multicaja

post /recharge

https://api.multicaja.cl/recharges/v1/recharge

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"origin": "RECARGACL",
"stan": 1,
"product_id": 1,
"amount": 1500,
"suscriptor": 995168137,
"check_transaction_id": 795547062,
"commerce_id": 325,
"branch_id": 325,
"terminal_id": 317

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"response_code": "01",
"response_message": "TRANSACCION APROBADA",
"transaction_id": 795547062,
"transaction_status": "APROBADA",
"authorization_id": "700000612259",
"created_at": "2018-03-16T16:38:31.28571"

}