Every Platform
Capability.
Programmatic.
REST API, real-time webhooks, and SDKs that expose every platform capability — payout execution, FX locking, compliance status, and treasury management.
Also see pre-built ERP integrations and white-label onboarding.
// Execute a batch payout run
import { Bitwage } from '@bitwage/sdk';
// Initialize with API key
const bw = new Bitwage(process.env.BW_API_KEY);
// Create a batch payout run
const run = await bw.payouts.create({
recipients: [
{
id: 'rec_maria_lopez',
amount: 4200,
currency: 'USD',
},
],
fxLock: true,
});
// Webhook fires on settlement
bw.webhooks.on('payment.settled', (event) => {
console.log(event.txHash);
});
Full Platform Surface Area
Every dashboard capability is available via API. The dashboard is built on the same API your integration will use.
Payout Execution
FX & Treasury
Compliance
Recipient Management
Webhooks
Reconciliation
Real-Time Events
On Every Payment.
Webhooks fire on every meaningful event — settlement confirmed, payment failed, KYC completed, OFAC flag triggered. Payloads are signed with HMAC-SHA256 for tamper detection. Retry logic with exponential backoff handles transient failures automatically. Every event includes the payment ID, timestamp, and enough context to update your NetSuite ERP or reconciliation system without a follow-up API call.
payment.settledSettlement confirmed with txHash and timestamppayment.failedFailure reason code, recipient info, retry optionskyc.completedKYC verification passed or failed with detailsofac.flaggedSanctions match detected — payment blockedbatch.approvedBoth approvers signed — FX rate lockedbalance.thresholdTreasury balance crosses configured threshold
{
"event": "payment.settled",
"id": "pay_abc123",
"recipient_id": "rec_maria_lopez",
"amount": 4200,
"currency": "USD",
"rail": "usdc_ethereum",
"tx_hash": "0x7f3a...d9c2",
"settled_at": "2026-03-20T14:22:01Z",
"settlement_seconds": 34,
"signature": "sha256=abc..."
}Pre-Built ERP Integrations
For teams using NetSuite or Sage Intacct, pre-built connectors sync payment data automatically — no custom API work required.
API & SDK FAQ
How the REST API, webhooks, and SDKs work for global payout integration.
The REST API covers the full platform surface: create and execute batch payout runs, lock FX rate lock rates, query OFAC sanctions screening and KYC / AML compliance status, manage recipient onboarding, fund {{link:products/balance}} treasury, retrieve settlement confirmations with on-chain hashes for USDC stablecoin payments, and pull reconciliation data. Every dashboard action is available via API — the dashboard itself is built on the same API.
Webhook events fire on: payment batch approved, individual payment settled, payment failed (with reason code), recipient onboarding completed, KYC status change, FX rate lock confirmed, treasury balance threshold crossed, and OFAC sanctions screening flag triggered. Webhooks are signed with HMAC-SHA256 for tamper detection and support retry logic with exponential backoff.
Official SDKs are available for Node.js (TypeScript-typed), Python, and Ruby. Each SDK wraps the REST API with type-safe methods, automatic retry handling, and webhook signature verification. SDKs are open source on GitHub. For teams using ERP payment integration systems like NetSuite or Sage Intacct, we publish pre-built NetSuite ERP integration and Sage Intacct integration connectors that use the API internally.
The API uses API key + secret pairs with optional IP allowlisting. Separate key pairs can be issued per integration or environment (production vs. staging). Keys have granular permission scopes: read-only (reporting), payout execution, treasury management, and admin. API calls require HTTPS. Rate limits are generous for enterprise use cases — contact sales for dedicated capacity.
Yes. A full-featured sandbox environment mirrors production with simulated payment execution, realistic settlement timelines, and test stablecoin transfers on testnets. Sandbox credentials are issued immediately on signup. All webhook events fire in sandbox with the same payloads as production — making integration testing reliable before going live.
Start building on the Bitwage API.
Full sandbox environment, Node.js/Python/Ruby SDKs, and comprehensive documentation. API keys issued immediately.