Skip to main content

Especificaciones para actualización de estado del QR

Las Entidades Participantes pueden actualizar el estado del QR una vez haya sido usado y se requiera dar de baja.
Dominio: https://bank.apihub.achcolombia.com.co
PATCH /ach/bk/v1/money-movement/qr/{id}
NOTA: Enviar el ID del QR (el que se entregó en la generación del mismo) en el path

Estados soportados

EstadoTipo de QRDescripción
ACTIVEEstático / DinámicoTodo QR inicia en este estado. Indica que está disponible para pago.
INACTIVESolo EstáticoEstado final. El QR ya no está disponible para recibir pagos.
CANCELEDSolo DinámicoEstado final. El comercio lo canceló antes de cualquier transacción.
PAIDSolo DinámicoEstado final. Se recibió la notificación de pago exitosa. El QR no puede volverse a usar.
EXPIREDSolo DinámicoEstado final. Se superó el tiempo de vigencia del QR. No puede utilizarse.

Transiciones Permitidas — QR Estático

Estado ActualEvento / CausaEstado Siguiente
ACTIVESolicitud de inhabilitaciónINACTIVE

Transiciones Permitidas — QR Dinámico

Estado ActualEvento / CausaEstado Siguiente
ACTIVEComercio cancelaCANCELED
ACTIVENotificación exitosa de pagoPAID
ACTIVEExpira vigenciaEXPIRED

Máquina de Estados QR Estáticos

Campos de Entrada

CampoTipoDescripciónFormatoObligatorio
metaobjectSI
requestIduuidCódigo generado por la entidad participante para identificar el paquetea1b2c3d4-e5f6-7890-abcd-ef1234567890SI
timestampdatetimeFecha y hora de la solicitud de generación del código QR2025-12-23T18:16:35.099ZSI
versionstringVersión del esquema, enviar el valor “1.0”1.0SI
dataobjectSI
movementTypeenumTipo de operación a realizar. [QR, QRVALIDATE, QRPARSER]QRSI
statusenumEstado de código QR. [INACTIVE, CANCELED, PAID]PAIDSI
{
  "meta": {
    "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "timestamp": "2026-01-16T01:48:22.252Z",
    "version": "1.0"
  },
  "data": {
    "movementType": "QR",
    "status": "INACTIVE"
  }
}

Campos de Salida:

CampoTipoDescripciónFormato
metaobject
requestIduuidCódigo generado por la entidad participante para identificar el paquetea1b2c3d4-e5f6-7890-abcd-ef1234567890
timestampdatetimeFecha y hora de la respuesta a la solicitud de generación del código QR2025-12-23T18:16:35.099Z
statusenumEstado de la respuesta. SUCCESS, ERRORSUCCESS
statusCodestringCódigo HTTP de la respuesta200
statusDescstringDescripción del código HTTPOK
dataobject
idstringIdentificador único del QR en el sistema123e4567-e89b-12d3-a456-426614174000
qrStatusstringEstado actual del QRACTIVE
lastModifiedDateTimedatetimeFecha y hora en la que se modificación el estado del QR2026-01-16T01:51:46.706Z
errorobject
codeintegerCódigo de error generado (cero si no hay errores)1005
messagestringMensaje de error (vacío si no hay errores)Fallas técnicas
{
  "meta": {
    "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "timestamp": "2026-01-16T01:51:46.706Z",
    "status": "SUCCESS",
    "statusCode": "200",
    "statusDesc": "string"
  },
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "qrStatus": "ACTIVE",
    "lastModifiedDateTime": "2026-01-16T01:51:46.706Z"
  }
}