Skip to content

Gateway Documentation

Build payment integrations with our REST API. Accept cards, ACH, and digital wallets.

Get Started in 5 Minutes

Log in to your Control Panel and navigate to Settings → API Keys.

You'll need two keys:

  • Public key (pub_XXX) — For frontend tokenization
  • Secret key — For backend API calls

Read the Full Quick Start Guide →


What Are You Building?

Choose your integration path:

I want to...Start here
Accept one-time payments on my websiteTokenizer — Hosted payment fields
Save cards for future purchasesCustomer Vault — Store payment methods
Set up recurring billingRecurring API — Subscriptions & plans
Send payment links to customersSimple Payments — Hosted checkout
Add Apple Pay / Google PayWalletJS — Digital wallets
Integrate with WooCommerceWooCommerce Plugin

Core APIs

Transactions

Process payments, refunds, and authorizations.

EndpointDescription
Sale/AuthCharge cards and bank accounts
CaptureCapture authorized transactions
RefundRefund settled transactions
VoidCancel pending transactions
SearchQuery transaction history

Customer Vault

Securely store payment methods for repeat customers.

EndpointDescription
Customer VaultCreate, update, and manage customers
RecurringSubscriptions and scheduled payments

Other APIs

APIDescription
InvoicesCreate and send payment requests
Batch ProcessingUpload transaction files
Settlement BatchesView daily settlements
TerminalsPhysical terminal integration
Custom FieldsAdd custom data to transactions
CartShopping cart management

Services & Tools

ServiceWhat It DoesBest For
TokenizerHosted payment form via iframeStaying out of PCI scope
Simple Payments"Pay Now" hosted checkout pageQuick setup, no coding
WebhooksReal-time event notificationsAutomating workflows
Fraud ProtectionRisk scoring and rulesReducing chargebacks
WalletJSApple Pay & Google PayMobile-friendly checkout

Integration Workflows

Step-by-step guides for common patterns:

WorkflowDescription
Tokenizer → Customer → PaymentCollect card, save it, charge later
Invoice PaymentCreate invoice, send link, get paid
Duplicate DetectionPrevent accidental double charges
Fee ProgramsSurcharge, cash discount, dual pricing

E-Commerce Plugins

Pre-built integrations for popular platforms:

PlatformStatus
WooCommerceWordPress e-commerce
MagentoEnterprise e-commerce
Gravity FormsWordPress forms

Testing

Sandbox Environment

All development should use the sandbox:

  • Base URL: https://sandbox.example.com
  • No real money is processed
  • Use test cards to simulate scenarios

Test Cards

Card NumberResult
4111111111111111Approved
4000000000000002Declined
4000000000009995Insufficient Funds
4000000000000051Partial Approval

View All Test Data →


Quick Reference

Authentication

All API requests require your secret key in the Authorization header:

bash
-H "Authorization: YOUR_SECRET_KEY"

Request Format

  • Content-Type: application/json
  • Method: POST for creates, GET for reads
  • Amounts: In cents (e.g., 1000 = $10.00)

Response Format

json
{
  "status": "success",      // or "error"
  "msg": "success",         // Human-readable message
  "data": { }               // Response payload
}

Common Response Codes

CodeMeaning
100Approved
200Declined
201Declined - Call issuer
300Gateway error

View API Request Documentation →


Resources

ResourceDescription
Quick StartGet up and running
Test DataCards, triggers, and scenarios
WebhooksEvent notifications
Fee ProgramsSurcharge & cash discount

Need Help?

  • API Issues: Check the response msg field for details
  • Integration Questions: Review the Workflows section
  • Testing Problems: Verify you're using sandbox test data
  • Account Issues: Contact support through your Control Panel

Last updated: