Appearance
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 website | Tokenizer — Hosted payment fields |
| Save cards for future purchases | Customer Vault — Store payment methods |
| Set up recurring billing | Recurring API — Subscriptions & plans |
| Send payment links to customers | Simple Payments — Hosted checkout |
| Add Apple Pay / Google Pay | WalletJS — Digital wallets |
| Integrate with WooCommerce | WooCommerce Plugin |
Core APIs
Transactions
Process payments, refunds, and authorizations.
| Endpoint | Description |
|---|---|
| Sale/Auth | Charge cards and bank accounts |
| Capture | Capture authorized transactions |
| Refund | Refund settled transactions |
| Void | Cancel pending transactions |
| Search | Query transaction history |
Customer Vault
Securely store payment methods for repeat customers.
| Endpoint | Description |
|---|---|
| Customer Vault | Create, update, and manage customers |
| Recurring | Subscriptions and scheduled payments |
Other APIs
| API | Description |
|---|---|
| Invoices | Create and send payment requests |
| Batch Processing | Upload transaction files |
| Settlement Batches | View daily settlements |
| Terminals | Physical terminal integration |
| Custom Fields | Add custom data to transactions |
| Cart | Shopping cart management |
Services & Tools
| Service | What It Does | Best For |
|---|---|---|
| Tokenizer | Hosted payment form via iframe | Staying out of PCI scope |
| Simple Payments | "Pay Now" hosted checkout page | Quick setup, no coding |
| Webhooks | Real-time event notifications | Automating workflows |
| Fraud Protection | Risk scoring and rules | Reducing chargebacks |
| WalletJS | Apple Pay & Google Pay | Mobile-friendly checkout |
Integration Workflows
Step-by-step guides for common patterns:
| Workflow | Description |
|---|---|
| Tokenizer → Customer → Payment | Collect card, save it, charge later |
| Invoice Payment | Create invoice, send link, get paid |
| Duplicate Detection | Prevent accidental double charges |
| Fee Programs | Surcharge, cash discount, dual pricing |
E-Commerce Plugins
Pre-built integrations for popular platforms:
| Platform | Status |
|---|---|
| WooCommerce | WordPress e-commerce |
| Magento | Enterprise e-commerce |
| Gravity Forms | WordPress 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 Number | Result |
|---|---|
4111111111111111 | Approved |
4000000000000002 | Declined |
4000000000009995 | Insufficient Funds |
4000000000000051 | Partial Approval |
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
| Code | Meaning |
|---|---|
100 | Approved |
200 | Declined |
201 | Declined - Call issuer |
300 | Gateway error |
View API Request Documentation →
Resources
| Resource | Description |
|---|---|
| Quick Start | Get up and running |
| Test Data | Cards, triggers, and scenarios |
| Webhooks | Event notifications |
| Fee Programs | Surcharge & cash discount |
Need Help?
- API Issues: Check the response
msgfield 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