Créer un Lien de Paiement

Crée un nouveau lien de paiement à usage unique pour le système de paiement OneClick (Navio)

POST /v3/ocpay/createLink

cURL

curl --request POST \
  --url https://api.oneclickdz.com/v3/ocpay/createLink \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Token: YOUR_API_KEY' \
  --data '{
  "productInfo": {
    "title": "Premium Subscription",
    "description": "Monthly access to premium features",
    "amount": 5000
  },
  "feeMode": "NO_FEE",
  "successMessage": "Thank you for your purchase!",
  "redirectUrl": "https://yourstore.com/success?orderId=12345"
}'

Réponse de succès (200)

{
  "success": true,
  "data": {
    "paymentLink": {
      "uid": "user_123456789",
      "ref": "OCPL-A1B2C3-D4E5",
      "isSandbox": false,
      "productInfo": {
        "title": "Premium Subscription",
        "description": "Monthly access to premium features",
        "amount": 5000
      },
      "feeMode": "NO_FEE",
      "successMessage": "Thank you for your purchase!",
      "redirectUrl": "https://yourstore.com/success?orderId=12345",
      "time": "2025-01-15T10:30:00Z"
    },
    "paymentUrl": "https://pay.ocdz.link/pay/OCPL-A1B2C3-D4E5",
    "paymentRef": "OCPL-A1B2C3-D4E5"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "requestId": "req_abc123xyz"
  }
}

​

Vue d’ensemble

Créez un lien de paiement sécurisé et à usage unique avec des paramètres personnalisables. Idéal pour les commandes e-commerce, les paiements de services et les renouvellements d’abonnements.

Validation marchande requise : Complétez la validation marchande sur https://app.oneclickdz.com/profile avant d’utiliser cet endpoint.

​

Corps de la requête

productInfo · object · requis

Détails du produit ou du service à payer

Afficher propriétés de productInfo

title · string · requis

Nom du produit/service (1 à 200 caractères) Exemples : - "Premium Subscription" - "Web Design Services" - "Online Course Access"

description · string

Description détaillée (max 1000 caractères). Prend en charge le markdown.

amount · number · requis

Montant du paiement en DZD (500 - 500 000) Exemples : 5000, 15000, 50000

feeMode · string · défaut: "NO_FEE"

Détermine qui paie les frais de retrait - NO_FEE - Le marchand paie tous les frais (par défaut) - SPLIT_FEE - Frais partagés 50/50 - CUSTOMER_FEE - Le client paie tous les frais

successMessage · string

Message de succès personnalisé (max 500 caractères) affiché après le paiement

redirectUrl · string

URL de redirection après un paiement réussi (doit être un HTTP/HTTPS valide)

​

Réponse

success · boolean

Indique si l’opération a réussi

data · object

Détails du lien de paiement

Afficher propriétés de data

paymentLink · object

Informations complètes du lien de paiement

Afficher propriétés de paymentLink

uid · string

Identifiant unique du marchand

ref · string

Code de référence du paiement (format : OCPL-XXXXXX-YYYY)

isSandbox · boolean

Si c’est un lien de paiement de test

productInfo · object

Informations du produit telles que soumises

feeMode · string

Mode de configuration des frais

successMessage · string

Message de succès personnalisé

redirectUrl · string

URL de redirection après paiement

time · string

Horodatage de création du lien (ISO 8601)

paymentUrl · string

URL complète à partager avec les clients pour le paiement

paymentRef · string

Code de référence du paiement - SAUVEGARDEZ-LE pour le suivi des paiements

meta · object

Métadonnées de la réponse

Afficher propriétés de meta

timestamp · string

Horodatage de la réponse (ISO 8601)

requestId · string

ID unique de la requête pour le support

​

Fonctionnalités clés

Flexibilité des frais

Choisissez qui paie les frais de transaction - marchand, client ou partagé

Marque personnalisée

Messages de succès personnalisés et URL de redirection

Tests en sandbox

Testez votre intégration en toute sécurité avant la mise en production

Sécurité à usage unique

Chaque lien est à usage unique pour une sécurité renforcée

​

Notes importantes

Limites de montant : - Minimum : 500 DZD - Maximum : 500 000 DZD - Doit être un nombre entier (pas de décimales)

Structure des frais : - 0% si utilisation du solde OneClick - 1% de frais de retrait uniquement (configurable par transaction)

Expiration du lien : Les liens de paiement expirent 20 minutes après la création si le paiement n’est pas initié

cURL

curl --request POST \
  --url https://api.oneclickdz.com/v3/ocpay/createLink \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Token: YOUR_API_KEY' \
  --data '{
  "productInfo": {
    "title": "Premium Subscription",
    "description": "Monthly access to premium features",
    "amount": 5000
  },
  "feeMode": "NO_FEE",
  "successMessage": "Thank you for your purchase!",
  "redirectUrl": "https://yourstore.com/success?orderId=12345"
}'

Réponse de succès (200)

{
  "success": true,
  "data": {
    "paymentLink": {
      "uid": "user_123456789",
      "ref": "OCPL-A1B2C3-D4E5",
      "isSandbox": false,
      "productInfo": {
        "title": "Premium Subscription",
        "description": "Monthly access to premium features",
        "amount": 5000
      },
      "feeMode": "NO_FEE",
      "successMessage": "Thank you for your purchase!",
      "redirectUrl": "https://yourstore.com/success?orderId=12345",
      "time": "2025-01-15T10:30:00Z"
    },
    "paymentUrl": "https://pay.ocdz.link/pay/OCPL-A1B2C3-D4E5",
    "paymentRef": "OCPL-A1B2C3-D4E5"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "requestId": "req_abc123xyz"
  }
}

​

Étapes suivantes

Vérifier le statut du paiement

Apprendre à vérifier le statut du paiement

Guide d'intégration

Guide complet d’intégration Navio