v3.4.1 — Production Ready

Build.
Integrate.
Ship._

The usaepya API is RESTful, well-documented, and ready for production in minutes. No hidden quirks, no undocumented endpoints — just clean, predictable responses every time.

99.99{c9d393b960216dbb9db132348d5880c342a083d2ef1fb7028e68a85ef7377326}
Uptime SLA
<80ms
Avg. Response
180+
Countries
payment.js
// Initialize usaepya client
const usaepya = require('usaepya-node');
const client = new usaepya('sk_live_••••••••');
// Create a payment intent
const intent = await client.payments.create({
amount: 4999, // $49.99 USD
currency: 'usd',
method: 'card',
capture: true,
});
// Response
{
"status": "succeeded",
"id": "pay_3Kx9mZ2vLqA8",
"settled_at": "2025-01-15T08:32:11Z"
}▌
200 OK · 74ms
REST API v3
Quick-Start Guide

From zero to live payments in under 30 minutes

Four clear steps — no fluff, no friction. Follow along and you'll be processing real transactions before your coffee gets cold.

1

Create a free account and receive sandbox API keys

Sign up in seconds — no credit card required. Once verified, your dashboard automatically provisions a pair of sandbox keys: a publishable key for client-side use and a secret key for server-to-server requests. Sandbox mode mirrors production behavior exactly, so everything you test here will work identically in live.

Publishablepk_test_51Abc...XyZ
Secretsk_test_51Abc...••••
Get your API keys →
2

Make your first test transaction

Call the POST /v1/transactions endpoint with an amount (in the smallest currency unit, e.g. cents) and a currency. A successful response returns a transaction object with a unique ID you can store, query, and refund at any time.

curl -X POST https://api.usaepya.com/v1/transactions 
  -H "Authorization: Bearer sk_test_your_api_key" 
  -H "Content-Type: application/json" 
  -d '{
    "amount": 4999,
    "currency": "USD",
    "description": "Order #1042",
    "customer": {
      "email": "[email protected]"
    }
  }'
3

Configure webhooks to receive real-time payment events

Register a public HTTPS endpoint in your dashboard under Settings → Webhooks. usaepya will POST signed JSON payloads for events like transaction.succeeded, transaction.failed, and refund.created. Always verify the usaepya-signature header before processing.

// Express.js webhook handler example
const express = require('express');
const app = express();

app.post('/webhooks/usaepya', express.raw({ type: 'application/json' }), (req, res) => {
  const sig = req.headers['usaepya-signature'];
  let event;

  try {
    event = usaepya.webhooks.constructEvent(
      req.body, sig, 'whsec_your_webhook_secret'
    );
  } catch (err) {
    return res.status(400).send(`Webhook Error: ${err.message}`);
  }

  if (event.type === 'transaction.succeeded') {
    const txn = event.data.object;
    console.log('Payment succeeded:', txn.id);
  }

  res.json({ received: true });
});
4

Switch to live keys and go to production

Once your sandbox integration is solid, swap your sk_test_ keys for sk_live_ keys — that's the only code change you'll need. Complete a brief identity verification in the dashboard, update your webhook endpoint to your production URL, and you're live. Our infrastructure handles PCI-DSS compliance, TLS termination, and 99.99{c9d393b960216dbb9db132348d5880c342a083d2ef1fb7028e68a85ef7377326} uptime SLA automatically.

🔑Rotate to live keysReplace sk_test_ with sk_live_ in your environment variables.
✅Complete KYB/KYCQuick identity check in your dashboard — usually approved within 24 hours.
🚀Deploy & monitorUse the real-time logs and alerts dashboard to track every payment.

Ready to go deeper?

Explore the full API reference — every endpoint, parameter, and error code, documented in detail.

View Full API Reference →
API Reference

Everything your integration needs, documented and ready.

usaepya's REST API is organized around three core endpoint families. Each surface follows the same predictable conventions — JSON in, JSON out, consistent error codes, and versioned stability.

Full API Reference
Core

Transactions

Sale · Auth · Void · Refund

Initiate, authorize, capture, and reverse payments with a single, predictable API surface. Supports card-present and card-not-present flows, multi-currency, and 3DS2 authentication out of the box.

Key Endpoints

  • POST
    /v1/transactions/saleCharge a card immediately
  • POST
    /v1/transactions/authPre-authorize & capture later
  • POST
    /v1/transactions/voidCancel an unsettled auth
  • POST
    /v1/transactions/refundFull or partial refund
Explore Transactions Docs
PCI DSS

Customers & Tokens

Store Cards · Recurring Billing

Vault card data as reusable tokens without touching raw PAN data on your servers. Build subscription flows, one-click checkout, and scheduled billing triggers with full lifecycle management.

Key Endpoints

  • POST
    /v1/customersCreate a customer profile
  • POST
    /v1/customers/:id/tokensTokenize a payment method
  • POST
    /v1/subscriptionsSet up recurring billing
  • DELETE
    /v1/tokens/:token_idRevoke a stored token
Explore Customers & Tokens Docs
Analytics

Reporting

Settlements · Batches · Disputes

Pull granular settlement data, query batch history by date range or merchant ID, and programmatically manage disputes and chargebacks — all exportable as JSON or CSV.

Key Endpoints

  • GET
    /v1/settlementsList settled transactions
  • GET
    /v1/batches/:batch_idFetch batch detail
  • GET
    /v1/disputesList open disputes
  • POST
    /v1/disputes/:id/respondSubmit dispute evidence
Explore Reporting Docs

Ready to start integrating?

Your API keys are waiting. Explore the interactive sandbox in the full developer portal.

usaepya

Payments Built for Developers, Trusted by Merchants.

[email protected]1-800-555-0199
1234 Gateway Blvd, Suite 200
Los Angeles, CA 90001, USA

Stay Updated

Get the latest API updates, developer news, and payment insights delivered to your inbox.

No spam. Unsubscribe anytime.

© 2026 usaepya. All rights reserved.

PCI DSS Level 1
SOC 2 Certified