Node.js
import { createHmac } from "node:crypto";
// Node.js 18+. Set credentials and resource values on your server.
function required(name) {
const value = process.env[name];
if (!value) throw new Error(`Set ${name} before running this example.`);
return value;
}
const baseUrl = process.env.LEDIG_API_BASE_URL ?? "https://api-sandbox.ledig.io";
const method = "GET";
const id = required("LEDIG_TRANSACTION_ID");
const path = `/v1/transactions/${encodeURIComponent(id)}`;
const pathWithQuery = path;
const rawBody = "";
const headers = { "Accept": "application/json" };
const timestamp = Math.floor(Date.now() / 1000).toString();
const payload = `${timestamp}.${method}.${pathWithQuery}.${rawBody}`;
headers["x-ledig-key"] = required("LEDIG_API_KEY");
headers["x-ledig-timestamp"] = timestamp;
headers["x-ledig-signature"] = "v1=" + createHmac("sha256", required("LEDIG_API_SECRET"))
.update(payload).digest("base64");
const response = await fetch(`${baseUrl}${pathWithQuery}`, {
method,
headers,
});
const result = await response.json();
// Use result in your application; do not log credentials or upload links.
console.log(response.status);{
"status": "success",
"data": {
"id": "transaction_example_001",
"profileId": "profile_example_001",
"currency": "USD",
"amount": "250.00",
"category": "deposit",
"reference": "deposit-example-001",
"description": "USD deposit",
"subDescription": "Bank transfer",
"status": "completed",
"statusDescription": "Completed",
"type": "fiat",
"createdAt": "2026-01-15T10:00:00.000Z",
"displayStatus": "completed",
"displayStatusDescription": "Completed",
"data": {
"grossAmount": "250.00",
"netAmount": "250.00",
"feeAmount": "0.00",
"feeCurrency": "USD"
},
"isCredit": true,
"isFiat": true
}
}{
"status": "error",
"code": "UNAUTHORIZED",
"message": "Authentication is required."
}{
"status": "error",
"code": "FORBIDDEN",
"message": "You do not have permission to perform this action."
}{
"status": "error",
"code": "NOT_FOUND",
"message": "The requested resource was not found."
}{
"status": "error",
"code": "RATE_LIMITED",
"message": "Too many requests. Wait before trying again."
}Transactions
View a transaction
Read the details and current status of one transaction.
GET
/
v1
/
transactions
/
{id}
Node.js
import { createHmac } from "node:crypto";
// Node.js 18+. Set credentials and resource values on your server.
function required(name) {
const value = process.env[name];
if (!value) throw new Error(`Set ${name} before running this example.`);
return value;
}
const baseUrl = process.env.LEDIG_API_BASE_URL ?? "https://api-sandbox.ledig.io";
const method = "GET";
const id = required("LEDIG_TRANSACTION_ID");
const path = `/v1/transactions/${encodeURIComponent(id)}`;
const pathWithQuery = path;
const rawBody = "";
const headers = { "Accept": "application/json" };
const timestamp = Math.floor(Date.now() / 1000).toString();
const payload = `${timestamp}.${method}.${pathWithQuery}.${rawBody}`;
headers["x-ledig-key"] = required("LEDIG_API_KEY");
headers["x-ledig-timestamp"] = timestamp;
headers["x-ledig-signature"] = "v1=" + createHmac("sha256", required("LEDIG_API_SECRET"))
.update(payload).digest("base64");
const response = await fetch(`${baseUrl}${pathWithQuery}`, {
method,
headers,
});
const result = await response.json();
// Use result in your application; do not log credentials or upload links.
console.log(response.status);{
"status": "success",
"data": {
"id": "transaction_example_001",
"profileId": "profile_example_001",
"currency": "USD",
"amount": "250.00",
"category": "deposit",
"reference": "deposit-example-001",
"description": "USD deposit",
"subDescription": "Bank transfer",
"status": "completed",
"statusDescription": "Completed",
"type": "fiat",
"createdAt": "2026-01-15T10:00:00.000Z",
"displayStatus": "completed",
"displayStatusDescription": "Completed",
"data": {
"grossAmount": "250.00",
"netAmount": "250.00",
"feeAmount": "0.00",
"feeCurrency": "USD"
},
"isCredit": true,
"isFiat": true
}
}{
"status": "error",
"code": "UNAUTHORIZED",
"message": "Authentication is required."
}{
"status": "error",
"code": "FORBIDDEN",
"message": "You do not have permission to perform this action."
}{
"status": "error",
"code": "NOT_FOUND",
"message": "The requested resource was not found."
}{
"status": "error",
"code": "RATE_LIMITED",
"message": "Too many requests. Wait before trying again."
}Required scope:
transactions:read
Use this endpoint to check an individual deposit, conversion or payment in your business’s history.Authorizations
Response
Transaction.