Overview
The Payment API enables merchants to submit payment transactions directly to the gateway via HTTP POST requests over SSL connections. This integration method provides complete control over the customer experience and payment flow.The communication method used to send messages to the Payment Gateway’s server is the standard HTTP protocol over an SSL connection.
API Endpoint
Transaction Types
The Payment API supports comprehensive transaction operations:- Sale
- Capture
- Void
- Refund
- Credit
- Validate
- Update
- Offline
Transactions submitted and immediately flagged for settlement. Use for immediate payment processing.Type:
saleAuthentication
All API requests require authentication using your API Security Key:Payment Methods
Credit/Debit Cards
Credit/Debit Cards
Submit credit and debit card transactions using these variables:Required Variables:
ccnumber- Card number (numeric)ccexp- Expiration date (MMYY format)cvv- Security code (recommended for better approval rates)
ACH/eCheck
ACH/eCheck
Process electronic check transactions:Required Variables:
checkname- Account holder namecheckaba- Bank routing numbercheckaccount- Account numberaccount_type-checkingorsavingssec_code- Entry class (PPD, WEB, TEL, CCD)
Digital Wallets
Digital Wallets
Accept Apple Pay and Google Pay:Apple Pay:Google Pay:
Tokenized Payments
Tokenized Payments
Use tokens from Collect.js:
Credit card and electronic check variables cannot be submitted in the same request.
Response Format
Transaction responses are returned in the HTTP response body using query string format:Key Response Variables
| Variable | Description | Values |
|---|---|---|
response | Transaction approval status | 1=approved, 2=declined, 3=error |
responsetext | Description of transaction result | Text description |
transactionid | Gateway transaction identifier | Unique ID |
amount_authorized | Authorization amount | Numeric |
Advanced Features
Level II/III Processing
Enhanced data fields for corporate purchasing and detailed line items
Recurring Subscriptions
Plan-based or custom subscription management
Customer Vault
Secure credential storage compliant with PCI standards
Partial Payments
Split-tender transactions with settlement controls
3D Secure
Enhanced authentication with cardholder_auth, cavv, and xid parameters
Payment Facilitator
Submerchant routing and identification fields

