Consultar convenio AGRA

Desarrollando

POST

/api/v1/transactions/query

Este servicio se debe usar para consultar la información del convenio sobre el que se quiere trabajar. Para el resultado de esta consulta debes tener en cuenta las siguientes condiciones:

Los convenios agrarios actualmente no tienen consulta previa, lo que significa que se hacen los pagos directos. Aquí se deben hacer validaciones de la información que ingresa el usuario por parte del integrador.

El campo "referencias" nos indica la cantidad de referencias que deben enviarse a la consulta (esta es la cantidad de campos que deberia habilitarse en el front), cada item del arreglo contiene la informacion de cada input, como el nombre de la referencia (lo que se debe solicitar al usuario), la longitud minima y maxima.

Nota: Con Agrario puedes usar el servicio de código de barras de forma libre, ya que con estos el banco no provee la información sobre cuáles son con códigos de barras.

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/json

Ejemplos

Respuestas

🟢200Éxito

application/json

Body

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": {
    "query": "get_product",
    "productId": 10027818
  }
}'

Ejemplo de Respuesta

{
  "statusCode": 200,
  "message": "Exitoso",
  "data": {
    "amountEditable": false,
    "Inputs": [
      {
        "name": "reference_1",
        "type": "davivienda-input",
        "label": "Referencia",
        "required": false,
        "disabled": true
      },
      {
        "name": "data",
        "type": "hidden",
        "origin": "object",
        "transformer": "JSON.parse(val)",
        "value": {
          "cod_convenio": "198442",
          "nom_convenio": "CLARO HOGAR",
          "referencias": [
            {
              "nom_ref": "Numero de Referencia 1",
              "longitud_max_ref": 32,
              "longitud_min_ref": 1,
              "algoritmo_ref": "N 010 Numérico"
            }
          ],
          "modificar_valor": true,
          "valor_menor": false,
          "valor_mayor": false,
          "valor_en_cero": false,
          "realizar_consulta": true,
          "id_autorizador": 16,
          "id_tipo_transaccion": 274,
          "pk_convenio_pdp": "225532",
          "datos_adicionales": {
            "permite_captura_manual": false
          }
        },
        "disabled": true
      },
      {
        "label": "Valor a pagar",
        "name": "amount",
        "value": 0,
        "type": "money",
        "disabled": true
      }
    ],
    "DefaultPayload": [],
    "Amount": {
      "cost": 0,
      "incentive": 0
    },
    "Error": {
      "message": null
    },
    "sign": "S2irOEf+2n1sYsH7y+6/o16rc1HtXnj03a3qXfZLgBU="
  },
  "_channel": "web"
}

Modificado en 2025-10-06 20:07:16

Como funciona los Recaudos Colpatria

Pagar Referencia AGRA