FireHorse Pay/developersDashboard
API reference

List payment provider candidates

Read provider catalog candidates for a direct integration scope. This list is not final routing eligibility or a provider readiness result.

GET/api/v1/providers/payment-options

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

Request#

FieldUseDescription
amountquery, requiredRequested major-unit amount.
currencyquery, requiredThree-letter currency code.
paymentMethodquery, requiredInternal payment method, for example CARD.
typequery, requiredDEPOSIT or PAYOUT.
modequery, optionalDefaults to LIVE. Explicitly send SANDBOX while testing.
regionIdquery, optionalMerchant region ID for regional filtering.
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/providers/payment-options?amount=10.00&currency=EUR&paymentMethod=CARD&type=DEPOSIT&mode=SANDBOX';
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
[]

Integration notes#

An empty list means no catalog candidates for this scope. A non-empty list does not certify current routing eligibility, external credentials, FX conversion or provider health.

Call from your server with signed headers. Query parameters are excluded from the HMAC path.

Hosted checkout handles method eligibility separately and routing selects the provider. Do not use the legacy cashier options endpoint as a signed-header-only merchant API.

Search documentation