Consult Operation

GET /api/v1/cash/consult

Base URL https://dev-api.finco.lat · operationId consultOperation

Retrieves the current status and details of a cash operation using its reference number. Use this endpoint to check the status of cash-in or cash-out operations.

Authorization

ClientAuth API key in header X-Client-Id

Client API key (32-character hex) obtained from client creation process. Must be used with X-Signature and X-Timestamp headers for HMAC authentication.

HMACSignature API key in header X-Signature

HMAC-SHA256 signature generated using your api_secret. Format: HMAC-SHA256(timestamp + "." + requestBody, api_secret)

Timestamp API key in header X-Timestamp

Unix timestamp (seconds since epoch) when the request was created. Used in HMAC signature generation to prevent replay attacks.

Query parameters

reference string required

20-digit operation reference number

Example 10511175512161627448

Responses

200 Operation found successfully application/json

response_code string

Response code ("0" for success)

response_text string

Response message

result object

operation_id result.operation_id integer

Unique identifier for the operation

kind result.kind string

Operation type

cash_in cash_out

reference result.reference string

20-digit operation reference number

status result.status string

Current operation status

close paid expired reversed

amount result.amount integer

Transaction amount in MXN

created_at result.created_at string (date-time)

ISO 8601 timestamp of operation creation

expire_at result.expire_at string (date-time)

ISO 8601 timestamp when operation expires

400 Bad Request - Invalid operation parameters application/json

response_code string

Error code identifier

1 60 64

response_text string

Human-readable error message

result object

Additional error context

amount result.amount integer

Requested amount (if applicable)

external_user_id result.external_user_id string

User identifier (if applicable)

reference result.reference string

Reference number (if applicable)

401 Unauthorized - Invalid or missing authentication application/json

error string

Error message

404 Operation not found application/json

response_code string

Error code identifier

1 60 64

response_text string

Human-readable error message

result object

Additional error context

amount result.amount integer

Requested amount (if applicable)

external_user_id result.external_user_id string

User identifier (if applicable)

reference result.reference string

Reference number (if applicable)

This request is in the Monato · Cash Postman collection.Download collection

Request

# SIGNATURE = HMAC-SHA256(TIMESTAMP + "." + request body, api_secret)
curl -X GET "https://dev-api.finco.lat/api/v1/cash/consult?reference=10511175512161627448" \
  -H "X-Client-Id: $CLIENT_ID" \
  -H "X-Signature: $SIGNATURE" \
  -H "X-Timestamp: $TIMESTAMP"

import crypto from "node:crypto";

const body = "";
const TIMESTAMP = Math.floor(Date.now() / 1000).toString();
const SIGNATURE = crypto.createHmac("sha256", API_SECRET).update(TIMESTAMP + "." + body).digest("hex");

const res = await fetch("https://dev-api.finco.lat/api/v1/cash/consult?reference=10511175512161627448", {
  method: "GET",
  headers: {
    "X-Client-Id": CLIENT_ID,
    "X-Signature": SIGNATURE,
    "X-Timestamp": TIMESTAMP,
  },
});
const data = await res.json();

import requests
import hashlib
import hmac
import time

body = ""
TIMESTAMP = str(int(time.time()))
SIGNATURE = hmac.new(API_SECRET.encode(), f"{TIMESTAMP}.{body}".encode(), hashlib.sha256).hexdigest()

res = requests.get(
    "https://dev-api.finco.lat/api/v1/cash/consult?reference=10511175512161627448",
    headers={
        "X-Client-Id": CLIENT_ID,
        "X-Signature": SIGNATURE,
        "X-Timestamp": TIMESTAMP,
    },
)
data = res.json()

Response

{
  "response_code": "0",
  "response_text": "Operacion encontrada",
  "result": {
    "operation_id": 123,
    "kind": "cash_in",
    "reference": "10511175512161627448",
    "status": "paid",
    "amount": 500,
    "created_at": "2025-01-15T10:30:00Z",
    "expire_at": "2025-01-18T10:30:00Z"
  }
}

{
  "response_code": "60",
  "response_text": "Parámetros Incorrectos",
  "result": {
    "amount": 500,
    "external_user_id": "USER123456"
  }
}

{
  "response_code": "60",
  "response_text": "Parámetros Incorrectos, Monto invalido",
  "result": {
    "amount": 5,
    "external_user_id": "USER123456"
  }
}

{
  "response_code": "1",
  "response_text": "Operacion rechazada",
  "result": {
    "amount": 500,
    "external_user_id": "USER123456"
  }
}

{
  "error": "Unauthorized"
}

{
  "response_code": "64",
  "response_text": "Operacion no encontrada",
  "result": {
    "reference": "10511175512161627448"
  }
}