API Pagos con tarjeta API Reference

Limitaciones

  • Sólo tarjetas de crédito Mastercard
  • Con cuotas emisor
  • Sin captura diferida
  • Todos los montos deben estar en pesos chilenos (ISO 4217 = CLP)
  • La API no soporta CORS
  • No está soportada la devolución ni reversa parcial.

Reglas de la API

  • El campo consumer_transaction_id debe ser único (incluso en días y transacciones distintas).
  • Todos los requerimientos deben ser realizados sobre HTTPS. Los requerimientos sobre HTTP fallarán.
  • Los campos del nodo carddeben ser encriptados utilizando el algoritmo AES-256. El procedimiento para compartir la llave se acordará en otro documento.
  • Todos los requerimientos son autenticados. Debe incluir el encabezado Api-Key: <key>.

Idempotencia

La API soporta idempotencia, por lo tanto puedes reintentar un requerimiento sin peligro de que el recurso se cree dos veces. Para esto debes incluir el encabezado Idempotency-Key: <key>, donde key es un identificador único de tu sistema o UUID. La clave tiene una validez de 24 horas.

  • NOTA: Si envías dos requerimientos con igual consumer_transaction_id y distinto Idempotency-Key, se entendrán como dos requerimientos diferentes y uno de ellos fallará dado que el campo consumer_transaction_id debe ser único.

Gestión de llaves

Los campos del nodo card se deben enviar encriptados por una llave simétrica utilizando el algoritmo AES-256. Para establecer la llave simétrica, el comsumidor de la API debe generar y enviar a Multicaja un componente de la llave con sus respectivos dígitos de chequeo. Multicaja generará y enviará otro componenente. Luego, ambos actores deberán cargar los componentes en sus HSMs, generando la llave final y verificando que los digitos de chequeo coincidan. Esta llave debe ser cambiada cada 3 años.

API Endpoint
https://api.multicaja.cl/card-payments/v0.2/
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: 0.2

Paths

Venta con tarjeta

POST /charges

Realiza un cargo en una tarjeta de crédito.

charge_req

Venta con tarjeta

Request Example
{
  "card": "mOoT6vkSI7z0ahhF7kN32cXAshL26UYHw0yzEef0KnFDbhtQRv6b1hoMkmdOCQsg",
  "additional_data": "object",
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg",
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "installments": null,
  "charge_type": {
    "card_on_file": false,
    "recurring": false
  },
  "merchant": {
    "local_tax_number": "96675670-5",
    "mcc": "5999",
    "name": "Store 1",
    "city": "Iquique",
    "country_code": "152",
    "merchant_code": "0023434"
  }
}
200 OK
charge_res

OK - Venta exitosa

400 Bad Request
error_obj

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

401 Unauthorized
error_obj

API Key no autorizada

402 Payment Required
error_obj

Transacción se intentó, pero falló.

500 Internal Server Error
error_obj

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

Response Example (200 OK) 
{
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg",
  "external_authorization_code": 1231232,
  "id": 7783834,
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  }
}
Response Example (400 Bad Request) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (401 Unauthorized) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (402 Payment Required) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (500 Internal Server Error) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}

Consulta de un cargo

GET /charges

Obtiene el objeto cargo

consumer_transaction_id: string
in query

Consulta de un cargo dado el consumer_transaction_id

200 OK
charge_all

OK - Venta exitosa

400 Bad Request
error_obj

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

401 Unauthorized
error_obj

API Key no autorizada

404 Not Found
error_obj

El recurso requerido no existe.

500 Internal Server Error
error_obj

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

Response Example (200 OK) 
{
  "status": "refunded",
  "failure_code": null,
  "failure_message": null,
  "amount_refunded": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "refunds": [
    {
      "consumer_transaction_id": "xhGXSPKviU83lln_xc9lc",
      "amount": {
        "value": "1000.00",
        "currency_code": "CLP"
      },
      "id": 7654320,
      "external_authorization_code": 1231232,
      "timestamps": {
        "created_at": "2018-01-14T15:27:42.669Z",
        "updated_at": "2018-03-02T10:03:12.123Z"
      }
    }
  ],
  "installments": null,
  "charge_type": {
    "card_on_file": false,
    "recurring": false
  },
  "merchant": {
    "local_tax_number": "96675670-5",
    "mcc": "5999",
    "name": "Store 1",
    "city": "Iquique",
    "country_code": "152",
    "merchant_code": "0023434"
  },
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg",
  "external_authorization_code": 1231232,
  "id": 7783834,
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  }
}
Response Example (400 Bad Request) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (401 Unauthorized) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (404 Not Found) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (500 Internal Server Error) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}

Reversa de una venta

POST /charges/reversal

Reversa en línea de una venta

reversal_req

Reversa de venta con tarjeta

Request Example
{
  "merchant": {
    "merchant_code": "0023434"
  },
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg"
}
200 OK
reversal_res

OK - Reversa exitosa

400 Bad Request
error_obj

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

401 Unauthorized
error_obj

API Key no autorizada

500 Internal Server Error
error_obj

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

Response Example (200 OK) 
{
  "id": 7783834,
  "status": "approved",
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  },
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg"
}
Response Example (400 Bad Request) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (401 Unauthorized) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (500 Internal Server Error) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}

Consulta de un cargo (NOT IMPLEMENTED)

GET /charges/{id}

Obtiene el objeto cargo

id: integer
in path

Consulta de un cargo

200 OK
charge_all

OK - Venta exitosa

400 Bad Request
error_obj

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

401 Unauthorized
error_obj

API Key no autorizada

404 Not Found
error_obj

El recurso requerido no existe.

500 Internal Server Error
error_obj

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

Response Example (200 OK) 
{
  "status": "refunded",
  "failure_code": null,
  "failure_message": null,
  "amount_refunded": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "refunds": [
    {
      "consumer_transaction_id": "xhGXSPKviU83lln_xc9lc",
      "amount": {
        "value": "1000.00",
        "currency_code": "CLP"
      },
      "id": 7654320,
      "external_authorization_code": 1231232,
      "timestamps": {
        "created_at": "2018-01-14T15:27:42.669Z",
        "updated_at": "2018-03-02T10:03:12.123Z"
      }
    }
  ],
  "installments": null,
  "charge_type": {
    "card_on_file": false,
    "recurring": false
  },
  "merchant": {
    "local_tax_number": "96675670-5",
    "mcc": "5999",
    "name": "Store 1",
    "city": "Iquique",
    "country_code": "152",
    "merchant_code": "0023434"
  },
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg",
  "external_authorization_code": 1231232,
  "id": 7783834,
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  }
}
Response Example (400 Bad Request) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (401 Unauthorized) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (404 Not Found) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (500 Internal Server Error) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}

Devolución de un cargo realizado a una tarjeta (NOT IMPLEMENTED)

POST /refunds

Devuelve total o parcialmante un cargo realizado a una tarjeta de crédito.

Devolución total

  • El objeto amount es opcional. En caso que se envíe, el campo value debe corresponder al monto total del cargo.

Devolución parcial

  • El objeto amount corresponde al monto que se quiere devolver. Debe ser mayor que cero y menor o igual al monto no devuelto de la venta.
  • Puedes realizar hasta 10 devoluciones parciales asociadas a la misma venta.
refund_req

Devolución de cargo

Request Example
{
  "consumer_transaction_id": "xhGXSPKviU83lln_xc9lc",
  "original_consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg",
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "additional_data": "object",
  "merchant": {
    "merchant_code": "0023434"
  }
}
200 OK
refund

OK - devolución exitosa

400 Bad Request
error_obj

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

401 Unauthorized
error_obj

API Key no autorizada

500 Internal Server Error
error_obj

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

Response Example (200 OK) 
{
  "consumer_transaction_id": "xhGXSPKviU83lln_xc9lc",
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "id": 7654320,
  "external_authorization_code": 1231232,
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  }
}
Response Example (400 Bad Request) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (401 Unauthorized) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (500 Internal Server Error) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}

Consulta de una devolución (NOT IMPLEMENTED)

GET /refunds

Obtiene el objeto devolución

consumer_transaction_id: string
in query

Consulta de una devolución dado el consumer_transaction_id

200 OK
refund

OK

400 Bad Request
error_obj

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

401 Unauthorized
error_obj

API Key no autorizada

404 Not Found
error_obj

El recurso requerido no existe.

500 Internal Server Error
error_obj

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

Response Example (200 OK) 
{
  "consumer_transaction_id": "xhGXSPKviU83lln_xc9lc",
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "id": 7654320,
  "external_authorization_code": 1231232,
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  }
}
Response Example (400 Bad Request) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (401 Unauthorized) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (404 Not Found) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (500 Internal Server Error) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}

Reversa de una devolución (NOT IMPLEMENTED)

POST /refunds/reversal

Reversa en línea de una devolución

reversal_req

Reversa de devolución

Request Example
{
  "merchant": {
    "merchant_code": "0023434"
  },
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg"
}
200 OK
reversal_res

OK - Reversa exitosa

400 Bad Request
error_obj

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

401 Unauthorized
error_obj

API Key no autorizada

500 Internal Server Error
error_obj

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

Response Example (200 OK) 
{
  "id": 7783834,
  "status": "approved",
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  },
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg"
}
Response Example (400 Bad Request) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (401 Unauthorized) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (500 Internal Server Error) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}

Consulta de una devolución (NOT IMPLEMENTED)

GET /refunds/{id}

Obtiene el objeto cargo

id: integer
in path

Consulta de una devolución

200 OK
refund

OK

400 Bad Request
error_obj

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

401 Unauthorized
error_obj

API Key no autorizada

404 Not Found
error_obj

El recurso requerido no existe.

500 Internal Server Error
error_obj

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

Response Example (200 OK) 
{
  "consumer_transaction_id": "xhGXSPKviU83lln_xc9lc",
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "id": 7654320,
  "external_authorization_code": 1231232,
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  }
}
Response Example (400 Bad Request) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (401 Unauthorized) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (404 Not Found) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (500 Internal Server Error) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}

Devolución batch de un cargo realizado a una tarjeta

POST /batch-refund

Devuelve total o parcialmante un cargo realizado a una tarjeta de crédito.

Devolución total

  • El objeto amount es opcional. En caso que se envíe, el campo value debe corresponder al monto total del cargo.

Devolución parcial (NOT IMPLEMENTED)

  • El objeto amount corresponde al monto que se quiere devolver. Debe ser mayor que cero y menor o igual al monto no devuelto de la venta.
  • Puedes realizar hasta 10 devoluciones parciales asociadas a la misma venta.
refund_req

Devolución de cargo

Request Example
{
  "consumer_transaction_id": "xhGXSPKviU83lln_xc9lc",
  "original_consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg",
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "additional_data": "object",
  "merchant": {
    "merchant_code": "0023434"
  }
}
200 OK
refund_batch_res

OK - devolución exitosa

400 Bad Request
error_obj

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

401 Unauthorized
error_obj

API Key no autorizada

500 Internal Server Error
error_obj

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

Response Example (200 OK) 
{
  "consumer_transaction_id": "xhGXSPKviU83lln_xc9lc",
  "status": "pending",
  "id": 7654320,
  "external_authorization_code": 1231232,
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  }
}
Response Example (400 Bad Request) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (401 Unauthorized) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (500 Internal Server Error) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}

Reversa de una devolución batch

POST /batch-refund/reversal

Reversa de una devolución

reversal_refund_batch_req

Reversa de devolución

Request Example
{
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "merchant": {
    "merchant_code": "0023434"
  },
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg"
}
200 OK
reversal_refund_batch_res

OK - Reversa exitosa

400 Bad Request
error_obj

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

401 Unauthorized
error_obj

API Key no autorizada

500 Internal Server Error
error_obj

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

Response Example (200 OK) 
{
  "external_authorization_code": 1231232,
  "id": 7783834,
  "status": "approved",
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  },
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg"
}
Response Example (400 Bad Request) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (401 Unauthorized) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Response Example (500 Internal Server Error) 
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}

Schema Definitions

reversal_refund_batch_req: object

Solicitud de devolución batch de una transacción (Request)

amount: amount_and_currency
Example
{
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "merchant": {
    "merchant_code": "0023434"
  },
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg"
}

reversal_refund_batch_res: object

Respuesta a devolucion batch de una transacción (Response)

external_authorization_code: integer

Identificador único de la transacción en el switch de la bandera

Example
{
  "external_authorization_code": 1231232,
  "id": 7783834,
  "status": "approved",
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  },
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg"
}

refund_batch_res: object

Solucitud de devolución batch (Response)

consumer_transaction_id: string

Identificador único de la transacción generado por el consumidor de la API

status: string

Estado de la solicitud. Al ser un procesamiento batch, la respuesta exitosa es ´pending´.

id: integer

Identificador único de la solicitud generado por Multicaja

external_authorization_code: integer

Identificador único de la transacción en el switch de la bandera

timestamps: timestamps
Example
{
  "consumer_transaction_id": "xhGXSPKviU83lln_xc9lc",
  "status": "pending",
  "id": 7654320,
  "external_authorization_code": 1231232,
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  }
}

refund_req: object

Solicitud de devolución (Request)

consumer_transaction_id: string

Identificador único de la transacción generado por el consumidor de la API

original_consumer_transaction_id: string

Identificador de la venta original, sobre la que se realizará la devolución.

amount: amount_and_currency
additional_data: addtitional_data
merchant: merchant_base
Example
{
  "consumer_transaction_id": "xhGXSPKviU83lln_xc9lc",
  "original_consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg",
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "additional_data": "object",
  "merchant": {
    "merchant_code": "0023434"
  }
}

refund: object

Solicitud de devolución (Response)

consumer_transaction_id: string

Identificador único de la transacción generado por el consumidor de la API

amount: amount_and_currency
id: integer

Identificador único de la devolución generado por Multicaja

external_authorization_code: integer

Identificador único de la transacción en el switch de la bandera

timestamps: timestamps
Example
{
  "consumer_transaction_id": "xhGXSPKviU83lln_xc9lc",
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "id": 7654320,
  "external_authorization_code": 1231232,
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  }
}

reversal_base: object

Solicitud de reversa de una transacción (Request)

consumer_transaction_id: string

Identificador único de la transacción que se quiere reversar.

Example
{
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg"
}

reversal_req: object

Solicitud de reversa de una transacción (Request)

merchant: merchant_base
Example
{
  "merchant": {
    "merchant_code": "0023434"
  },
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg"
}

reversal_res: object

Respuesta a solicitud de reversa de una transacción (Response)

id: integer

Código identificador de la compra en los sistemas de Multicaja

status: string

Estado de la reversa.

timestamps: timestamps
Example
{
  "id": 7783834,
  "status": "approved",
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  },
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg"
}

charge_req: object

Solicitud de venta (Request)

card: string

Datos de tarjeta encriptados

additional_data: addtitional_data
consumer_transaction_id: string

Identificador único de la transacción generado por el consumidor de la API

amount: amount_and_currency
installments: integer

cantidad de cuotas (cuotas emisor)

charge_type: charge_type
merchant: merchant
Example
{
  "card": "mOoT6vkSI7z0ahhF7kN32cXAshL26UYHw0yzEef0KnFDbhtQRv6b1hoMkmdOCQsg",
  "additional_data": "object",
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg",
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "installments": null,
  "charge_type": {
    "card_on_file": false,
    "recurring": false
  },
  "merchant": {
    "local_tax_number": "96675670-5",
    "mcc": "5999",
    "name": "Store 1",
    "city": "Iquique",
    "country_code": "152",
    "merchant_code": "0023434"
  }
}

charge_res: object

Respuesta a solicitud de venta (Response)

amount: amount_and_currency
consumer_transaction_id: string

Identificador único de la transacción generado por el consumidor de la API

external_authorization_code: integer

Identificador único de la transacción en el switch de la bandera

id: integer

Código identificador de la compra en los sistemas de Multicaja

timestamps: timestamps
Example
{
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg",
  "external_authorization_code": 1231232,
  "id": 7783834,
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  }
}

charge_all: object

Respuesta a solicitud de venta (Response)

status: string

Estado del cargo

failure_code: string

Código de error

failure_message: string

Mensaje de error

amount_refunded: amount_and_currency
refunds: refund
refund
installments: integer

cantidad de cuotas (cuotas emisor)

charge_type: charge_type
merchant: merchant
Example
{
  "status": "refunded",
  "failure_code": null,
  "failure_message": null,
  "amount_refunded": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "refunds": [
    {
      "consumer_transaction_id": "xhGXSPKviU83lln_xc9lc",
      "amount": {
        "value": "1000.00",
        "currency_code": "CLP"
      },
      "id": 7654320,
      "external_authorization_code": 1231232,
      "timestamps": {
        "created_at": "2018-01-14T15:27:42.669Z",
        "updated_at": "2018-03-02T10:03:12.123Z"
      }
    }
  ],
  "installments": null,
  "charge_type": {
    "card_on_file": false,
    "recurring": false
  },
  "merchant": {
    "local_tax_number": "96675670-5",
    "mcc": "5999",
    "name": "Store 1",
    "city": "Iquique",
    "country_code": "152",
    "merchant_code": "0023434"
  },
  "amount": {
    "value": "1000.00",
    "currency_code": "CLP"
  },
  "consumer_transaction_id": "crlfUYEBK14zotCTykezJkfg",
  "external_authorization_code": 1231232,
  "id": 7783834,
  "timestamps": {
    "created_at": "2018-01-14T15:27:42.669Z",
    "updated_at": "2018-03-02T10:03:12.123Z"
  }
}

timestamps: object

Fecha de creación y de última modificación (Response)

created_at: string (date-time)
updated_at: string (date-time)
Example
{
  "created_at": "2018-01-14T15:27:42.669Z",
  "updated_at": "2018-03-02T10:03:12.123Z"
}

amount_and_currency: object

Monto en una moneda específica

value: number

Monto en formato decimal

currency_code: string

Código ISO 4217 de la moneda

Example
{
  "value": "1000.00",
  "currency_code": "CLP"
}

merchant: object

Datos del comercio que origina el cargo

local_tax_number: string

Rol Único Tributario (RUT) del comercio

mcc: string

Código ISO 18245 asignado por la bandera al comercio

name: string

Nombre del comercio que aparece en extracto bancario

city: string

Ciudad en la que está ubicado el comercio

country_code: string

Código ISO 3166 del país. En conjunto con name y city, se uutilizan para formar el soft descriptor

Example
{
  "local_tax_number": "96675670-5",
  "mcc": "5999",
  "name": "Store 1",
  "city": "Iquique",
  "country_code": "152",
  "merchant_code": "0023434"
}

merchant_base: object

Datos del comercio que origina el cargo

merchant_code: string

Código de comercio

Example
{
  "merchant_code": "0023434"
}

charge_type: object

Tipo de cargo que se realiza. Indica si el pago es recurrente o no y si los datos de la tarjeta fueron digitados por el tarjetahabiente o es card on file.

card_on_file: boolean

Indica si card on file

recurring: boolean

Indica si el cargo es recurrente

Example
{
  "card_on_file": false,
  "recurring": false
}

addtitional_data: object

Objeto JSON con atributos adicionales para la transacción.

Example
"object"

error_obj: object

Error

code: string

Código que representa el error.

message: string

Descripción corta del error

Example
{
  "code": "INSUFFICIENT_FUNDS",
  "message": "La tarjeta no tiene saldo"
}
Documentation by Spectacle