Developer Portal

Build with Avantulo Pay API

Powerful APIs and SDKs to integrate seamless payment experiences into your applications. Start accepting payments in minutes, not weeks.

Level 2+
Business Accounts
REST
API Type
v1
Current Version
Quick Start
// Create a payment link via Merchant API
const response = await fetch('https://api.avantulopay.com/api/v1/merchant/payment-links', {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key',
    'X-API-Secret': 'your_api_secret',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'Product Purchase',
    amount: 100.00,
    currency: 'USD',
    description: 'Order #12345'
  })
});

const { data } = await response.json();
console.log('Payment URL:', data.url);

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/api/v1/merchant

Note: Merchant API requires Business account with KYC Level 2 or higher

Merchant Account

POST/api/v1/merchant/register

Register merchant account

GET/api/v1/merchant/account

Get merchant account details

POST/api/v1/merchant/regenerate-credentials

Regenerate API credentials

Payment Links

POST/api/v1/merchant/payment-links

Create a payment link

GET/api/v1/merchant/payment-links

List all payment links

GET/api/v1/merchant/payment-links/:id

Get payment link details

PATCH/api/v1/merchant/payment-links/:id

Update payment link

Invoices

POST/api/v1/merchant/invoices

Create an invoice

GET/api/v1/merchant/invoices

List invoices

GET/api/v1/merchant/invoices/:id

Get invoice details

POST/api/v1/merchant/invoices/:id/send

Send invoice to customer

Webhooks

GET/api/v1/merchant/webhooks

Get webhook delivery history

POST/api/v1/merchant/webhooks/test

Test webhook endpoint

Authentication

All API requests must include your API credentials in request headers:

X-API-Key: YOUR_API_KEY
X-API-Secret: YOUR_API_SECRET
Content-Type: application/json

Get your API credentials from: Dashboard → Merchant → API Keys

Integration Examples

Use our REST API with any programming language. Here are examples in popular languages to get you started.

JavaScript / Node.js

const response = await fetch('https://api.avantulopay.com/api/v1/merchant/payment-links', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.AVANTULO_API_KEY,
    'X-API-Secret': process.env.AVANTULO_API_SECRET,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'Product Purchase',
    amount: 100.00,
    currency: 'USD'
  })
});

const { data } = await response.json();

Python

import requests

response = requests.post(
  'https://api.avantulopay.com/api/v1/merchant/payment-links',
  headers={
    'X-API-Key': os.getenv('AVANTULO_API_KEY'),
    'X-API-Secret': os.getenv('AVANTULO_API_SECRET'),
    'Content-Type': 'application/json'
  },
  json={
    'title': 'Product Purchase',
    'amount': 100.00,
    'currency': 'USD'
  }
)

data = response.json()

PHP

$ch = curl_init('https://api.avantulopay.com/api/v1/merchant/payment-links');

curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'X-API-Key: ' . $_ENV['AVANTULO_API_KEY'],
    'X-API-Secret: ' . $_ENV['AVANTULO_API_SECRET'],
    'Content-Type: application/json'
  ],
  CURLOPT_POSTFIELDS => json_encode([
    'title' => 'Product Purchase',
    'amount' => 100.00,
    'currency' => 'USD'
  ])
]);

$response = curl_exec($ch);
$data = json_decode($response);

cURL

curl -X POST https://api.avantulopay.com/api/v1/merchant/payment-links \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Product Purchase",
    "amount": 100.00,
    "currency": "USD"
  }'

Requirements

Merchant API is available for Business accounts with KYC Level 2 or higher. Get your API credentials from: Dashboard → Merchant → API Keys

Quick Start Examples

Copy and paste these examples to start integrating Avantulo Pay API into your application

Create Payment Link

curl -X POST https://api.avantulopay.com/api/v1/merchant/payment-links \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Product Purchase",
    "amount": 100.00,
    "currency": "USD",
    "description": "Order #12345"
  }'

Get Payment Link

curl https://api.avantulopay.com/api/v1/merchant/payment-links/LINK_ID \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"

Create Invoice

curl -X POST https://api.avantulopay.com/api/v1/merchant/invoices \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -H "Content-Type: application/json" \
  -d '{
    "customerEmail": "customer@example.com",
    "customerName": "John Doe",
    "amount": 250.00,
    "currency": "USD",
    "dueDate": "2025-12-31",
    "items": [
      {
        "description": "Consulting Service",
        "quantity": 5,
        "unitPrice": 50.00
      }
    ]
  }'

Ready to Start Building?

Activate your Business account and get API credentials to start accepting payments

Developer Support & Community

Get help when you need it. Our developer community and support team are here to help you succeed.

Email Support

Contact our support team for technical assistance and integration help

Response: < 24 hourssupport@avantulopay.com

Live Chat

Get instant help from our AI assistant, available 24/7 on the platform

Response: InstantOpen Chat

Contact Form

Send us your questions and we'll get back to you with detailed answers

Response: < 48 hoursContact Us

Need Help with Integration?

Our support team is ready to help you with API integration, payment setup, and technical questions.

Merchant API requires Business account with KYC Level 2+. Get started today and unlock payment integration features.