Consulta obligacion

Desarrollando

POST

/api/v1/transactions/query

Servicio para consultar la obligación; para este servicio debes tener en cuenta las siguientes condiciones:

En el caso de que se requiera hacer la consulta y el pago con el número de tarjeta, se deben solicitar los primeros 6 dígitos + los últimos 4 dígitos de la tarjeta. En el caso contrario, se ingresa el número de la obligación normalmente.

Hay 3 tipos de pagos que puede realizar el cliente de la obligación: el pago mínimo, el pago total y el pago por valor diferente. Recuerda que si se ingresa un valor diferente este no debe sobrepasar el valor del pago total.

Solicitud

Autorización

Proporciona tu token bearer en el encabezado

Authorization

al realizar solicitudes a recursos protegidos.

Ejemplo:

Authorization: Bearer ********************

Parámetros del Body application/jsonRequerido

Ejemplos

Respuestas

🟢200Éxito

application/json

Body

🔴500Rechazo

Ejemplo de Solicitud

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/transactions/query' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "data": {
    "productId": 701005,
    "customerQueryType": "1",
    "reference": "21000000300",
    "customerDocType": "CC",
    "customerDocument": "1111111111",
    "customerPaymentType": "1"
  }
}'

Ejemplo de Respuesta

200 - Éxito

{
    "statusCode": 200,
    "message": "Exitoso",
    "data": {
        "amountEditable": true,
        "Inputs": [
            {
                "icon": "document",
                "name": "customerQueryType",
                "type": "select",
                "label": "Tipo de consulta",
                "options": [
                    {
                        "label": "Nro de Tarjeta",
                        "value": "1"
                    },
                    {
                        "label": "Nro de Obligación",
                        "value": "2"
                    }
                ],
                "required": true,
                "disabled": true,
                "value": "1"
            },
            {
                "icon": "document",
                "name": "reference",
                "note": "Para tarjeta de crédito: Los primeros 6 dígitos de la tarjeta + últimos 4 ejm: 4564216437",
                "type": "text",
                "label": "N° Tarjeta / Obligación",
                "required": true,
                "disabled": true,
                "value": "21000000300"
            },
            {
                "icon": "document",
                "name": "customerDocType",
                "type": "select",
                "label": "Tipo de documento",
                "options": [
                    {
                        "label": "Cedula de Ciudadania",
                        "value": "CC"
                    },
                    {
                        "label": "Cedula Extranjería",
                        "value": "CE"
                    },
                    {
                        "label": "Nit",
                        "value": "NI"
                    }
                ],
                "required": true,
                "disabled": true,
                "value": "CC"
            },
            {
                "icon": "document",
                "name": "customerDocument",
                "type": "text",
                "label": "Documento del cliente",
                "required": true,
                "disabled": true,
                "value": "1111111111"
            },
            {
                "icon": "document",
                "name": "customerPaymentType",
                "type": "select",
                "view": "query",
                "label": "Tipo de Pago",
                "options": [
                    {
                        "eval": [
                            "S",
                            "eq",
                            "S"
                        ],
                        "label": "Pago mínimo",
                        "value": "1"
                    },
                    {
                        "eval": [
                            "S",
                            "eq",
                            "S"
                        ],
                        "label": "Pago total",
                        "value": "2"
                    },
                    {
                        "eval": [
                            "S",
                            "eq",
                            "S"
                        ],
                        "label": "Valor diferente",
                        "value": "3"
                    }
                ],
                "onChange": "self.setForm({amount: ['1'].includes(val) ? self.form.amount_1 : ['2'].includes(val) ? self.form.amount_2 : 0 })",
                "required": true,
                "disabled": false,
                "value": "1"
            },
            {
                "name": "amount",
                "type": "money",
                "view": "query",
                "label": "valor",
                "value": "138199",
                "disabled": false
            },
            {
                "name": "id_query",
                "origin": "object",
                "payloadSell": true,
                "label": "Id Consulta",
                "type": "hidden",
                "value": 3576123,
                "disabled": true
            },
            {
                "name": "aditional",
                "origin": "object",
                "payloadSell": true,
                "label": "Datos Adicionales",
                "type": "hidden",
                "value": {},
                "disabled": true
            },
            {
                "name": "name_client",
                "origin": "object",
                "payloadSell": true,
                "label": "Nombre Receptor",
                "value": "MARLYN AQUILINO DE LA TORR",
                "disabled": true,
                "type": "text"
            },
            {
                "name": "amount_1",
                "origin": "object",
                "payloadSell": true,
                "label": "Valor minimo",
                "disabled": true,
                "type": "hidden",
                "value": 138199
            },
            {
                "name": "amount_2",
                "origin": "object",
                "payloadSell": true,
                "label": "Valor total",
                "type": "hidden",
                "value": 731573,
                "disabled": true
            }
        ],
        "DefaultPayload": [],
        "Amount": {
            "cost": 0,
            "incentive": null
        },
        "Error": {
            "message": null
        },
        "sign": "S2irOEf+2n1sYsH7y+6/o16rc1HtXnj03a3qXfZLgBU="
    },
    "_channel": "web"
}

Modificado en 2025-10-10 19:55:03

Como funciona el pago de obligaciones Caja Social

Pago obligacion