Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.useaxra.com/llms.txt

Use this file to discover all available pages before exploring further.

Installation

npm install @axra/node

Quick start

import { Axra } from '@axra/node';

const axra = new Axra('sk_test_...', {
  baseUrl: 'https://api.useaxra.com',
});

// Create a payment
const payment = await axra.payments.create({
  amount: 5000,
  currency: 'USD',
});

Configuration

OptionTypeDefaultDescription
baseUrlstringhttps://api.useaxra.comAPI base URL
apiVersionstring2026-04-15Sent as Axra-Version header
maxNetworkRetriesnumber2Automatic retries on 5xx errors

Treasury API

const axra = new Axra('sk_test_...'); // partner secret key

// Create an end-user
const user = await axra.treasury.users.service.treasuryUsersControllerCreate({
  requestBody: {
    externalId: 'user_123',
    email: 'jane@example.com',
    name: 'Jane Doe',
  },
});

Webhook signature verification

import { verifyAxraWebhookSignature, constructWebhookEvent } from '@axra/node';

app.post('/webhooks', (req, res) => {
  const signature = req.headers['axra-signature'];
  const event = constructWebhookEvent(
    'whsec_your_signing_secret',
    req.body,
    signature,
  );

  switch (event.type) {
    case 'payment.completed':
      break;
    case 'treasury.payout.completed':
      break;
  }
  res.status(200).send('ok');
});

Available services

NamespaceDescription
axra.paymentsCard payments and deposits
axra.withdrawalsWithdrawal operations
axra.transfersTransfer operations
axra.fxRatesFX rate lookups
axra.kycKYC verification
axra.webhookEndpointsWebhook endpoint management
axra.treasury.usersTreasury end-user CRUD
axra.treasury.kycTreasury KYC
axra.treasury.walletsTreasury wallets
axra.treasury.payoutsTreasury payouts