Integration Options

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

Choose the integration method that best fits your needs. Easypay offers three main ways to integrate payment processing into your platform.

Overview

Plugins

The fastest way to integrate Easypay if you're using a supported e-commerce platform. Install, configure, and start accepting payments in minutes.

Supported Platforms

WooCommerce

WordPress e-commerce plugin for online stores of all sizes.

Features:

• All Easypay payment methods (Credit Card, MB WAY, Multibanco, etc.)
• Single and recurring payments
• Automatic order status updates
• Refund management from WordPress admin

View WooCommerce Integration Guide

PrestaShop

Open-source e-commerce platform with extensive customization options.

Features:

• Complete payment method support
• Multi-currency support
• One-click installation
• Order synchronization

View PrestaShop Integration Guide

Shopify

Hosted e-commerce platform for online stores and retail point-of-sale systems.

Features:

• Seamless Shopify integration
• All payment methods available
• Automatic inventory sync
• Mobile-optimized checkout

View Shopify Integration Guide

Magento

Adobe Commerce platform for enterprise e-commerce solutions.

Features:

• Enterprise-grade payment processing
• Advanced order management
• Multi-store support
• Custom payment workflows

View Magento Integration Guide

VTEX

Cloud-native commerce platform for enterprise brands.

Features:

• Native VTEX integration
• Omnichannel payment support
• Real-time payment updates
• VTEX IO compatibility

View VTEX Integration Guide

Wix

Website builder with integrated e-commerce capabilities.

Features:

• Drag-and-drop payment integration
• Mobile-responsive checkout
• Wix Stores compatibility
• No coding required

View Wix Integration Guide

Jumpseller

E-commerce platform for small to medium businesses.

Features:

• Quick setup process
• All payment methods
• Inventory management
• Multi-language support

View Jumpseller Integration Guide

nopCommerce

Open-source ASP.NET e-commerce platform.

Features:

• ASP.NET Core integration
• Flexible payment configuration
• Plugin architecture support
• Multi-vendor marketplace ready

View nopCommerce Integration Guide

Checkout

Easypay's pre-built payment form that you can embed directly into any website with just a few lines of code. Perfect for custom websites and applications.

Key Benefits

• Minimal Development: Embed with just a few lines of JavaScript
• All Payment Methods: Credit cards, MB WAY, Apple Pay, Google Pay, Samsung Pay, Multibanco, Direct Debit, Virtual IBAN
• Fully Customizable: Match your brand with extensive styling options
• Mobile Responsive: Works seamlessly on all devices
• PCI Compliant: We handle security and compliance

How It Works

1. Create a checkout session (server-side API call)
2. Embed the checkout form (add JavaScript snippet to your page)
3. Handle the payment response (receive webhook notifications)

Quick Example

// Include the SDK
<script src="https://cdn.easypay.pt/checkout/2.9.1/"></script>

// Initialize checkout with your session
const manifest = await getManifestFromServer();
easypayCheckout.startCheckout(manifest);

Learn More

• Complete Checkout Guide - Full integration documentation
• Live Demo - Try it in action
• GitHub Example - Full working code

Server to Server (Direct API Integration)

For developers who need full control over the payment flow. Build custom payment experiences using our REST API directly.

When to Use

• Custom payment workflows
• Mobile applications
• Backend-only integrations
• Advanced payment logic
• Multi-tenant platforms

Prerequisites

Before you begin, you'll need:

1. An Easypay account
2. API credentials (Account ID and API Key)

Get Your API Credentials

To create credentials for your account, follow this guide.

For testing purposes, you can use these credentials:

AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6
ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92

Note: These credentials only work in the test environment.

Choose Your Environment

Easypay provides two environments:

• Test: https://api.test.easypay.pt/2.0
• Production: https://api.prod.easypay.pt/2.0

Always start with the test environment to familiarize yourself with the API.

Make Your First API Call

Here's a simple example to create a single payment:

curl -L -X POST 'https://api.test.easypay.pt/2.0/single' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92' \
  -H 'Content-Type: application/json' \
  --data-raw '{
    "type": "sale",
    "value": 10.00,
    "currency": "EUR",
    "method": "cc",
    "customer": {
      "name": "John Doe",
      "email": "john.doe@example.com"
    }
  }'

Handle the Response

A successful response will include the payment details and a unique payment ID:

{
  "status": "success",
  "id": "5eca7446-14e9-47bb-aabb-5ee237159b8b",
  "method": "cc",
  "customer": {
    "name": "John Doe",
    "email": "john.doe@example.com"
  }
}

Learn More

• Authentication - Detailed authentication guide
• API Reference - Complete endpoint documentation
• Payment Methods - Available payment methods
• Payment Types - Single, frequent, and subscription payments
• Webhooks - Receive real-time payment notifications
• Error Handling - Handle errors gracefully

Need Help?

Contact our technical support at correio@easypay.pt.