API Integration

Guide to integrating with our payment API

Authentication

To use our API, you must first register on epay.guiddini.dz. Upon registration, you will receive a Secret Key and an App Key. These credentials must be kept private and secure.

Initiate Payment

Endpoint

POST /api/client/payment/initiate

Headers

Key	Value	Required
Accept	application/json	Yes
Content-Type	application/json	Yes
x-app-key	YOUR_APP_KEY	Yes
x-secret-key	YOUR_SECRET_KEY	Yes

Example Usage in Different Languages

Request Body

example.js

const axios = require('axios');
 
async function initiatePayment() {
  const response = await axios.post('https://api.example.com/client/payment/initiate', {
    amount: "2500"
  }, {
    headers: {
      'Accept': 'application/json',
      'Content-Type': 'application/json',
      'x-app-key': 'YOUR_APP_KEY',
      'x-secret-key': 'YOUR_SECRET_KEY'
    }
  });
  console.log(response.data);
}
 
initiatePayment();

Response

response.json

{
  "data": {
    "type": "transaction",
    "id": "YIFXM5E7ZA8KWS8C4SC4",
    "attributes": {
      "amount": "2500",
      "status": "processing",
      "form_url": "[https://test.satim.dz/payment/merchants/merchant1/payment_fr.html?mdOrder=Tox9krS9mLPdCUAAF2U4](https://test.satim.dz/payment/merchants/merchant1/payment_fr.html?mdOrder=Tox9krS9mLPdCUAAF2U4)"
    }
  }
}

Show Transaction

Endpoint

GET /api/client/payment/show

Headers

Key	Value	Required
Accept	application/json	Yes
Content-Type	application/json	Yes
x-app-key	YOUR_APP_KEY	Yes
x-secret-key	YOUR_SECRET_KEY	Yes

Request Body

Parameter	Type	Required	Description
order_number	string	Yes	The order number of transaction to retrieve

Example Usage in Different Languages

example.js

const axios = require('axios');
 
async function showTransaction(orderNumber) {
  const response = await axios.get('https://api.example.com/client/payment/show', {
    data: { order_number: orderNumber },
    headers: {
      'Accept': 'application/json',
      'Content-Type': 'application/json',
      'x-app-key': 'YOUR_APP_KEY',
      'x-secret-key': 'YOUR_SECRET_KEY'
    }
  });
  console.log(response.data);
}
 
showTransaction('1BU9MF7NVHA8WKKG8W8S');

Response

response.json

{
  "data": {
    "type": "transaction",
    "id": "1BU9MF7NVHA8WKKG8W8S",
    "attributes": {
      "amount": "3000",
      "order_number": "1BU9MF7NVHA8WKKG8W8S",
      "order_id": "rAYKqByC6d1MLIAAF775",
      "status": "processing",
      "deposit_amount": null,
      "auth_code": null,
      "action_code": null,
      "action_code_description": null,
      "error_code": "0",
      "error_message": null,
      "confirmation_status": "requires_verification",
      "license_env": "development", 
      "form_url": "https://test.satim.dz/payment/merchants/merchant1/payment_fr.html?mdOrder=rAYKqByC6d1MLIAAF775",
      "svfe_response": null,
      "pan": null,
      "ip_address": null,
      "approval_code": null,
      "updated_at": "2025-04-05T10:36:20+00:00"
    }
  },
  "meta": {
    "code": "TRANSACTION_FOUND",
    "message": "Transaction retrieved successfully"
  }
}

Previous

Api Overview

Next

HTTP Responses