Build with Avantulo Pay API
Powerful APIs and SDKs to integrate seamless payment experiences into your applications. Start accepting payments in minutes, not weeks.
// Initialize Avantulo Pay SDK
import { AvantuloPayClient } from '@avantulo/sdk';
const client = new AvantuloPayClient({
apiKey: 'your_api_key',
environment: 'production'
});
// Create a payment
const payment = await client.payments.create({
amount: 1000,
currency: 'USD',
description: 'Payment for order #12345'
});RESTful API Documentation
Our well-documented REST API makes it easy to integrate payments into any application. All API responses are returned in JSON format.
Base URL
https://api.avantulopay.com/v2Authentication
/api/v2/auth/tokenGenerate API access token
/api/v2/auth/refreshRefresh access token
/api/v2/auth/revokeRevoke access token
Payments
/api/v2/paymentsCreate a new payment
/api/v2/payments/:idRetrieve payment details
/api/v2/payments/:id/captureCapture authorized payment
/api/v2/payments/:id/refundRefund a payment
Customers
/api/v2/customersCreate a new customer
/api/v2/customers/:idRetrieve customer details
/api/v2/customers/:idUpdate customer information
Webhooks
/api/v2/webhooksRegister webhook endpoint
/api/v2/webhooksList webhook endpoints
/api/v2/webhooks/:idDelete webhook endpoint
Authentication
All API requests must include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEYOfficial SDK Libraries
Battle-tested SDKs for your favorite programming languages. Get up and running with just a few lines of code.
JavaScript / TypeScript
v2.1.3- •Full TypeScript support
- •Promise-based API
- •Automatic retries
- •Webhook validation
Python
v2.0.8- •Async/await support
- •Type hints
- •Django integration
- •Flask integration
PHP
v2.0.5- •PSR-4 autoloading
- •Laravel integration
- •Symfony support
- •Guzzle HTTP client
Ruby
v2.0.3- •Rails integration
- •Sinatra support
- •Thread-safe
- •Comprehensive test suite
Go
v2.0.2- •Concurrent safe
- •Context support
- •Zero dependencies
- •High performance
Java
v2.0.4- •Spring Boot integration
- •Kotlin support
- •Reactive streams
- •Android compatible
Don't see your language? Check out our community-maintained SDKs or build your own!
Browse Community SDKsDeveloper Tools & Resources
Everything you need to build, test, and monitor your payment integration
API Explorer
Interactive API console to test endpoints directly in your browser
- Live API testing
- Request/response viewer
- Code generation
Test Environment
Sandbox environment with test API keys and simulated transactions
- Test credit cards
- Webhook testing
- Error simulation
Webhook Manager
Configure and test webhook endpoints with detailed event logs
- Event replay
- Payload inspection
- Retry management
Schema Validator
Validate API requests and responses against our JSON schemas
- Real-time validation
- Error highlighting
- Schema docs
API Key Manager
Generate and manage API keys with granular permissions
- Key rotation
- Permission scopes
- Usage tracking
Analytics Dashboard
Track API usage, performance metrics, and error rates
- Real-time metrics
- Custom alerts
- Export data
Avantulo CLI
Powerful command-line tool for local development and testing
Install globally via npm:
npm install -g @avantulo/cliavantulo testRun integration tests against the sandbox
avantulo debugDebug API requests with detailed logging
avantulo webhook listenForward webhooks to your local environment
Prefer Postman? Download our complete API collection
Download Postman CollectionAPI Playground
Test our API endpoints right in your browser. No setup required.
Request
/v2/payments{
"amount": 5000,
"currency": "USD",
"description": "Test payment",
"customer": {
"email": "test@example.com",
"name": "John Doe"
}
}Response
Developer Support & Community
Get help when you need it. Our developer community and support team are here to help you succeed.
Developer Discord
Join our active community of developers building with Avantulo Pay
GitHub Discussions
Ask questions, share ideas, and collaborate with other developers
Developer Resources
Developer Newsletter
Stay updated with new features, API changes, and developer tips delivered monthly.
Need help with your integration? Book a free 30-minute session with our developer advocates.