API · consult

API v1

POST /api/v1/consult

What it does#

Queries a specific transaction: returns the processed amount and the status of the transaction.

Authentication#

Requires the API bearer token in the Authorization header — see authentication.

Parameters#

keystring#

Tilopay integration key.

orderNumberstring#

Order number being queried.

merchantIdstring#

Merchant id.

Request example#

The <...> values are placeholders: replace them with your own credentials and data.

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

Response#

{
  "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"
    }
  ]
}

To interpret a response that is not a success, see how to read an error response.

Last verified: 2026-08-29 · Owner: equipo-integraciones

View as raw Markdown