FireHorse Pay/developersDashboard
API reference

Cancel a non-terminal transaction

Apply cancellation when the transaction permits the transition. Terminal transactions cannot be voided.

POST/api/v1/transactions/{id}/void

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

Request#

FieldUseDescription
idpathNumeric owned transaction ID.
reasonrequiredReason for cancellation.
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/void';
const method = 'POST';
const body = JSON.stringify({
  "reason": "Order cancelled"
});
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'
  },
  body
});
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": "CANCELED",
  "amount": 10,
  "currency": "EUR",
  "merchantReference": "order-example-001",
  "redirectUrl": null
}

Integration notes#

Inspect the current state first. An unsupported transition returns a conflict.

A local cancellation is not a blanket guarantee that a provider-side collection or transfer was reversed.

Search documentation