FireHorse Pay/developersDashboard
API reference

Retrieve a transaction

Read the current owned transaction by numeric ID or UUID. Use the terminal status and credited amount to update your order.

GET/api/v1/transactions/{idOrUuid}

Illustrative examples · merchant-scoped · API key and HMAC required

Request#

FieldUseDescription
idOrUuidpathNumeric transaction ID or UUID returned by the API.
Node.js
// Node.js 18+ · server only. No browser API key.
import { createHash, createHmac, randomUUID } from 'node:crypto';

const key = process.env.FIREHORSE_API_KEY;
if (!key) throw new Error('Set FIREHORSE_API_KEY on the server');
const path = '/api/v1/transactions/100123';
const method = 'GET';
const body = '';
const timestamp = String(Math.floor(Date.now() / 1000));
const nonce = randomUUID();
const hash = createHash('sha256').update(body, 'utf8').digest('hex');
const canonical = [method, path.split('?')[0], timestamp, nonce, hash].join('\n');
const signature = createHmac('sha256', key).update(canonical).digest('hex');
const response = await fetch('https://firehorsepay.powerwebhub.com/transaction' + path, {
  method, redirect: 'error',
  headers: {
    'X-API-KEY': key, 'X-TIMESTAMP': timestamp,
    'X-NONCE': nonce, 'X-SIGNATURE': signature,
    'Content-Type': 'application/json'
  }
});
const result = await response.json();
if (!response.ok) {
  // Reconcile uncertain results and 409; do not blindly create another order.
  throw new Error('Firehorse HTTP ' + response.status);
}
// Store result securely. A 201/CREATED is not a confirmed payment.

Example response#

HTTP 200 · illustrative response
{
  "id": 100123,
  "uuid": "6f1c0c8e-0d62-4a0f-a913-57c6e45d7c21",
  "type": "DEPOSIT",
  "status": "SUCCESS",
  "amount": 10,
  "currency": "EUR",
  "merchantReference": "order-example-001",
  "redirectUrl": null,
  "providerAmount": 10,
  "providerCurrency": "EUR",
  "actualAmount": 10,
  "actualCurrency": "EUR",
  "creditedAmount": 10,
  "creditedCurrency": "EUR",
  "amountUpdateType": "EXACT"
}

Integration notes#

Transactions owned by another merchant return 404.

CREATED, PROCESSING and MANUAL_REVIEW require further handling. Do not mark them as paid.

Use sensible polling intervals and backoff rather than a tight loop.

Search documentation