Forward Compatibility

Guide to integrating with our payment API


Introduction

Our online payment solution is designed specifically for businesses operating in Algeria, providing secure, fast, and localized transactions in Algerian Dinars (DZD). Whether you're running an e-commerce store, offering digital services, or managing online billing, our platform ensures your payments are processed reliably and efficiently.

Why Choose Our Payment Solution?

  • Top-Tier Security: All transactions are encrypted using industry-standard protocols to keep your data safe.
  • Algeria-Optimized: Built to handle local currency (DZD) and comply with Algerian payment regulations.
  • Quick Integration: Easy to implement with custom systems or platforms like WordPress.
  • Real-Time Updates: Receive instant transaction confirmations and status changes.

Key Features

  • Robust Payment Gateway: Secure, encrypted channels for all transactions.
  • Support for Multiple Payment Methods: Accept credit cards and other regionally accepted payment options.
  • High Performance: Infrastructure optimized for speed and reliability.
  • Developer-Friendly API: Clean and well-documented endpoints for quick integration.

Getting Started

To begin using the payment API, follow these steps:

  1. Create an Account at epay.guiddini.dz to obtain your API credentials.
  2. Integrate the API using our configuration guides.
  3. Start Accepting Payments by initiating your first API call.

Check the sections ahead for full reference documentation, code examples, and error handling guidance.


About This API

Welcome to the documentation for the Guiddini Online Payment API. This guide outlines the goals, architecture, and practical benefits of integrating with our system. Whether you're handling everyday payments or interfacing with government financial systems, this API is built to simplify your workflow.

Purpose & Vision

Integrating with traditional government payment APIs is often complex due to heavy documentation, compliance needs, and inconsistent standards. Our API offers a streamlined layer on top of these systems, acting as a secure, reliable intermediary between your application and government platforms.

Simplifying Bureaucratic Payments

Government systems come with rigid structures and regulatory demands. Our API bridges these systems using consistent, easy-to-implement endpoints that abstract the complexity, speed up development, and ensure compliance.

Built by Developers, for Developers

This API was developed by a small, agile team solving real-world problems for over 300 Algerian web merchants. Our goal is to empower developers with simple tools that save time, reduce frustration, and ensure success.


Forward Compatibility

This API is designed to evolve with your business, adding new features without breaking your existing integration. By following the JSON:API specification, we ensure that enhancements—like additional fields or related data—won't disrupt your implementation. You can adopt new capabilities when you're ready, while your application remains stable.

Seamless Evolution Without Breaking Changes

Unlike traditional APIs that rely on versioned endpoints, our API allows backward-compatible improvements. With JSON:API, your app can safely ignore unknown fields or sections. New data doesn't interfere with existing functionality.

Example: Fetching More Payment Data with include

Initial request:

{
  "data": {
    "type": "payment",
    "id": "PAY12345",
    "attributes": {
      "amount": 49.99,
      "status": "completed"
    }
  },
  "meta": {
    "code": "SUCCESS",
    "message": "Payment retrieved successfully"
  }
}

Extended request with user info:

GET /payments/PAY12345?include=user

{
  "data": {
    "type": "payment",
    "id": "PAY12345",
    "attributes": {
      "amount": 49.99,
      "status": "completed"
    }
  },
  "included": [
    {
      "type": "user",
      "id": "USER789",
      "attributes": {
        "name": "Ali Si-Larbi",
        "email": "ali@guiddini.com"
      }
    }
  ],
  "meta": {
    "code": "SUCCESS",
    "message": "Payment and user details retrieved successfully"
  }
}

Your existing code continues to work without changes. When you're ready, you can update your logic to use the included section for richer data.

Why It Matters

This approach delivers powerful benefits for your online payment system:

  • Zero Disruption: New features like "include" don't break your app—you adopt them when you're ready.
  • Faster Performance: Fetching related data (e.g., user info) in one request reduces API calls, speeding up your app and improving the user experience.
    • Nested item
  • Scalability Made Easy: As your platform grows—maybe adding support for payment history or refunds—the API can introduce new "include" options without forcing you to rewrite your integration.
  • Cost and Time Savings: Your developers can focus on building features, not fixing broken integrations, saving you resources in the long run.
  • Future-Proof Confidence: Whether you're a small business or a large enterprise, this API ensures your payment system stays reliable and adaptable as your needs evolve.

Important

This isn't just about today's payments—it's about tomorrow's growth.
With this API, you're investing in a solution that keeps your integration seamless and your business moving forward.