¡Hola!, estamos llevando a otro nivel nuestro producto QR Code, eso incluye una migración a una mejor plataforma, entonces por el momento ya no tenemos habilitada esta versión para uso, por favor escríbenos aquí para asesorarte y contarte todo el paso a paso para probar una versión más reciente y recargada :) Contáctanos aquí: https://soportedevs.bancolombia.com/hc/es-419/requests/new?ticket_form_id=1900000233587
Esta API permite generar intenciones de compra y cargarlas en códigos QR Mixtos. Las intenciones de compra son paquetes de información que llevan todos los datos de la compra, como el monto, el identificador único de QR, número de venta o números de fidelidad. Este paquete de información se actualiza en el código QR para que sea leído por el cliente pagador.
- Protocols: HTTPS
Base Gateway API Endpoint
Paths
/qr-codes/intention
Generar intenciones de pago asociadas a un QR.
Esta función permite crear los paquetes de información para cada intención de compra y cargarla en el código QR.
Secreto de la aplicación consumidora o client_secret
Identificación de la aplicación consumidora o client_id
Representa el formato de mensajería que se espera en la respuesta. Ejemplo: application/vnd.bancolombia.v4+json
application/vnd.bancolombia.v4+json
Successful response.
Error in the request.
Incorrect credentials.
You do not have permissions to access the resource.
Resource not found.
Resource state has conflicts with data of the request.
Internal server error.
Error in the service provider response.
Service unavailable.
Service provider response time exceeded.
/qr-codes/intention/{qrIntentionId}
Consultar intenciones de pago asociadas a un QR.
Función de respaldo o apoyo que le permite al comercio verificar en el sistema de QR Bancolombia el estado de cada intención de compra. (Pendiente, exitosa, cancelada y expirada).
Secreto de la aplicación consumidora o client_secret
Identificación de la aplicación consumidora o client_id
Representa el formato de mensajería que se espera en la respuesta. Ejemplo: application/vnd.bancolombia.v4+json
Identificador de la intención de pago con QR que se generó.
{
"maxLength": 50
}Successful response.
Error in the request.
Incorrect credentials.
You do not have permissions to access the resource.
Resource not found.
Resource state has conflicts with data of the request.
Internal server error.
Error in the service provider response.
Service unavailable.
Service provider response time exceeded.
/qr-codes/intention/cancel
Cancelar intenciones de pago asociadas a un QR.
Esta función le permite al comercio cancelar la intención de compra antes de que expire el tiempo de esta y antes de que el cliente pagador confirme la transacción. Si la transacción ya ha sido confirmada, no se puede cancelar la intención de compra y se debe utilizar la funcionalidad de reverso.
Secreto de la aplicación consumidora o client_secret
Identificación de la aplicación consumidora o client_id
Representa el formato de mensajería que se espera en la respuesta. Ejemplo: application/vnd.bancolombia.v4+json
application/vnd.bancolombia.v4+json
Successful response.
Error in the request.
Incorrect credentials.
You do not have permissions to access the resource.
Resource not found.
Resource state has conflicts with data of the request.
Internal server error.
Error in the service provider response.
Service unavailable.
Service provider response time exceeded.
/qr-code-intention/health
Identificación de la aplicación consumidora o client_id
Secreto de la aplicación consumidora o client_secret
application/vnd.bancolombia.v4+json
Successful response.
Definitions
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"intentionDetail"
],
"properties": {
"intentionDetail": {
"$ref": "#\/definitions\/intentionDetail"
},
"invoice": {
"$ref": "#\/definitions\/invoice"
},
"customer": {
"$ref": "#\/definitions\/customer"
}
}
}
}
}
{
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#\/definitions\/meta"
},
"data": {
"type": "object",
"required": [
"qrIntentionId"
],
"properties": {
"qrIntentionId": {
"type": "string",
"maxLength": 50,
"description": "Identificador de la intención de pago con QR que se generó.",
"example": "8a2b66a1-fed3-4acb-9297-a67361008b5f"
}
}
}
}
}
{
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#\/definitions\/meta"
},
"data": {
"type": "object",
"required": [
"intentionDetail"
],
"properties": {
"intentionDetail": {
"$ref": "#\/definitions\/intentionDetailResponse"
},
"invoice": {
"$ref": "#\/definitions\/invoice"
},
"customer": {
"$ref": "#\/definitions\/customer"
}
}
}
}
}
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"qrIntentionId"
],
"properties": {
"qrIntentionId": {
"type": "string",
"maxLength": 50,
"description": "Identificador de la intención de pago con QR que se generó.",
"example": "bc9a81ae-af76-4320-ac5c-f1e76930c75b"
},
"reason": {
"type": "string",
"maxLength": 200,
"description": "Razon por la cual se canceló la intención de pago.",
"example": "Cambio de productos"
}
}
}
}
}
{
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#\/definitions\/meta"
},
"data": {
"type": "object",
"required": [
"intentionDetail"
],
"properties": {
"intentionDetail": {
"$ref": "#\/definitions\/intentionDetailCancelResponse"
},
"invoice": {
"$ref": "#\/definitions\/invoice"
},
"customer": {
"$ref": "#\/definitions\/customer"
}
}
}
}
}
{
"type": "object",
"required": [
"qrId",
"amount"
],
"properties": {
"qrId": {
"type": "string",
"maxLength": 50,
"description": "Identificador del QR al cual se asociara la intención de pago.",
"example": "31e5bcea-5edb-4b07-b781-37abb68c1f3b"
},
"reference": {
"type": "string",
"maxLength": 200,
"description": "Descripción de la intención de pago.",
"example": "Mercado, paga con QR caja 1"
},
"amount": {
"type": "number",
"format": "double",
"maxLength": 12,
"description": "Total a pagar en la intención de pago.",
"example": "15000"
}
}
}
{
"type": "object",
"required": [
"qrId",
"amount",
"state",
"creationDate"
],
"properties": {
"qrId": {
"type": "string",
"maxLength": 50,
"description": "Identificador del QR al cual se asociara la intención de pago.",
"example": "31e5bcea-5edb-4b07-b781-37abb68c1f3b"
},
"reference": {
"type": "string",
"maxLength": 200,
"description": "Descripción de la intención de pago.",
"example": "Mercado, paga con QR caja 1"
},
"amount": {
"type": "number",
"format": "double",
"maxLength": 15,
"description": "Total a pagar en la intención de pago.",
"example": "15000.00"
},
"state": {
"type": "string",
"maxLength": 10,
"description": "Estado en el que se encuentra la intención de pago.",
"example": "EXPIRADA",
"enum": [
"PENDIENTE",
"EXITOSA",
"CANCELADO",
"EXPIRADA"
]
},
"reason": {
"type": "string",
"maxLength": 200,
"description": "Razon por la cual se canceló la intención de pago.",
"example": "INTENCIÓN EXPIRÓ"
},
"creationDate": {
"type": "string",
"format": "date-time",
"description": "Fecha en la que se creo la intención de pago."
},
"lastUpdateDate": {
"type": "string",
"format": "date-time",
"description": "Fecha de la ultima modificación de la intención de pago."
}
}
}
{
"type": "object",
"required": [
"qrId",
"amount",
"state"
],
"properties": {
"qrId": {
"type": "string",
"maxLength": 50,
"description": "Identificador del QR al cual se asociara la intención de pago.",
"example": "31e5bcea-5edb-4b07-b781-37abb68c1f3b"
},
"amount": {
"type": "number",
"format": "double",
"maxLength": 15,
"description": "Total a pagar en la intención de pago.",
"example": "15000.0"
},
"state": {
"type": "string",
"maxLength": 10,
"description": "Estado en el que se encuentra la intención de pago.",
"example": "CANCELADO",
"enum": [
"PENDIENTE",
"EXITOSA",
"CANCELADO",
"EXPIRADA"
]
}
}
}
{
"type": "object",
"required": [
"commerceInvoiceId"
],
"properties": {
"commerceInvoiceId": {
"type": "string",
"maxLength": 50,
"description": "Identificador de compra del comercio que permite identificar internamente el registro.",
"example": "0000548796"
}
}
}
{
"type": "object",
"required": [
"customerLoyaltyId"
],
"properties": {
"customerLoyaltyId": {
"type": "string",
"maxLength": 50,
"description": "Identificador de lealtad del cliente en el comercio.",
"example": "Lifemiles"
}
}
}
Datos de trazabilidad e informacion técnica de del mensaje.
{
"type": "object",
"required": [
"_messageId",
"_requestDateTime",
"_applicationId"
],
"properties": {
"_messageId": {
"type": "string",
"example": "c4e6bd04-5149-11e7-b114-b2f933d5fe66"
},
"_requestDateTime": {
"type": "string",
"format": "date-time",
"example": "2021-08-10T09:36:21.443Z"
},
"_applicationId": {
"type": "string",
"example": "64bf9778-7616-4b45-96b9-e8962348e4eb"
}
}
}
Objeto que contiene los enlaces relacionados al mensaje de respuesta, puede contener los enlaces para realizar una paginación.
{
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/links"
},
{
"$ref": "#\/definitions\/pagination"
}
]
}
Enlaces relacionados al mensaje de respuesta de la API.
{
"type": "object",
"properties": {
"self": {
"description": "Enlace con el que se llamó la API.",
"type": "string",
"example": "\/v1\/bian-path\/card"
}
},
"additionalProperties": false
}
{
"type": "object",
"properties": {
"first": {
"description": "the first page of data",
"type": "string",
"format": "uri"
},
"last": {
"description": "the last page of data",
"type": "string",
"format": "uri"
},
"prev": {
"description": "the previous page of data",
"type": "string",
"format": "uri"
},
"next": {
"description": "the next page of data",
"type": "string",
"format": "uri"
}
}
}
Mensaje de respuesta cuando ocurre un error.
{
"type": "object",
"required": [
"meta",
"errors"
],
"properties": {
"meta": {
"$ref": "#\/definitions\/meta"
},
"status": {
"type": "number",
"description": "Código de estado HTTP (status code) asociado al mensaje de error de la respuesta del llamado a la API.",
"example": 404
},
"title": {
"type": "string",
"description": "Título asociado al código de estado HTTP (status code) asociado al mensaje de error de la respuesta del llamado a la API.",
"example": "Not Found"
},
"errors": {
"type": "array",
"description": "Lista de errores detectados",
"uniqueItems": true,
"items": {
"$ref": "#\/definitions\/error"
}
}
},
"additionalProperties": false
}
Objeto que describe el error
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {
"description": "Código del mensaje de error. Puede contener un código de un error que ocurrió en la API o en su servicio proveedor, este se indica usando los siguientes prefijos:\n- SP: Indica un error de sistema o técnico en el proveedor de la API. Ejemplo: 'SP500'\n- SA: Indica un error de sistema o técnico en la API. Ejemplo: 'SA400'\n- BP: Indica un error o excepción de negocio en el proveedor de la API. Ejemplo: 'BP12345'\n",
"type": "string",
"example": "BP404"
},
"detail": {
"description": "Es la descripción funcional del mensaje de error.",
"type": "string",
"example": "El recurso consultado no fue encontrado"
}
},
"additionalProperties": false
}