{% extends 'base.html' %} {% block content %}

Documentation API

Guide complet d'intégration de l'API Pay2Up

Version 1.0 API REST

Présentation

Bienvenue dans la documentation de l'API de notre application ! Cette API vous permet d'accéder à toutes les fonctionnalités de notre application, en utilisant des requêtes HTTP.

URL de base

https://myapiv1.upgroup-pay.com/api

Pour utiliser notre API, vous devrez envoyer des requêtes HTTP à l'adresse de l'endpoint approprié. Chaque endpoint de notre API correspond à une fonctionnalité spécifique de notre application, et peut accepter différents types de requêtes HTTP (GET, POST, PUT, DELETE, etc.).

Prérequis

Configuration Cross Origin

Configurez votre Cross Origin dans Parametres > Cross Origin Access.
Ajoutez 127.0.0.1 si vous travaillez en local.

Clés d'intégration API

Récupérez vos clés ID et SECRET dans Parametres > Integration API.

Générer un lien de paiement

POST /v1/payment/checkout

Content-Type: application/json

HEADER 
{
  "content-type": "application/json"
}
BODY 
{
  "k_id": "[API_ID]",           // ID de l'API
  "k_secret": "[API_SECRET]",   // Clé secrète
  "image": "string",            // Image d'illustration (optionnel)
  "products": [                 // Liste des produits [REQUIS]
    {
      "id": "string",           // Identifiant unique
      "price": "string",        // Prix (minimum 100)
      "name": "string",         // Nom du produit
      "qte": 1                  // Quantité (minimum 1)
    }
  ],
  "fields": {},                 // Métadonnées (optionnel)
  "is_prod": false,             // Environnement (défaut: false)
  "ipn": "string",              // URL de callback [REQUIS]
  "ipn_token": "string",        // Token d'authentification (optionnel)
  "success": "string",          // URL de redirection (succès)
  "cancel": "string"            // URL de redirection (échec)
}
RESPONSE 
{
  "status": "SUCCESS",          // SUCCESS | ERROR | DENIED
  "message": "[message]",       // Détails de la réponse
  "data": {
    "redirect": "https://example.com/pay/dfskeopodff768gdfg86d..."  // URL de paiement
  }
}

Notes importantes

  • Le prix minimum d'un produit est de 100 XOF
  • L'URL de callback (ipn) est obligatoire pour recevoir les notifications de transaction
  • Utilisez l'environnement de test (is_prod: false) pour vos développements
  • Conservez votre clé secrète (k_secret) en lieu sûr



{% endblock content %}