API · consult

API v1

POST /api/v1/consult

Qué hace#

Consulta una transacción específica: devuelve el monto procesado y el estado de la transacción.

Autenticación#

Requiere el token bearer del API en el header Authorization — ver autenticación.

Parámetros#

keystring#

Key de la integración Tilopay.

orderNumberstring#

Número de orden consultado.

merchantIdstring#

Id de comercio.

Ejemplo de request#

Los valores <...> son marcadores: reemplazalos por tus credenciales y datos.

{
  "key": "<api_key>",
  "orderNumber": "1212122",
  "merchantId": ""
}

Respuesta#

{
  "type": "200",
  "message": "",
  "response": [
    {
      "id_tilopay": 734312,
      "orderNumber": "1212122",
      "amount": "5.00",
      "currency": "USD",
      "merchantId": "88803956",
      "code": "1",
      "response": "Transacción aprobada",
      "auth": "123456",
      "commission": 0.18,
      "iva_commission": 0.02,
      "retention_iva": 0.27,
      "retention_rent": 0.09,
      "cost": 0.35,
      "cost_iva": 0.05,
      "net_to_liquidate": "4.04",
      "capture": "Capture",
      "card": "4021",
      "last": "5221",
      "environment": "Test",
      "type": "Payment",
      "date": "2024-07-31 16:59:20"
    }
  ]
}

Para interpretar una respuesta que no es de éxito, ver cómo leer una respuesta de error.

Última verificación: 2026-08-29 · Responsable: equipo-integraciones

Ver como Markdown crudo