Créer une facture

Endpoint POST /pay/v01/redirect/checkout-invoice/create — paramètres, exemple complet et réponse.

Cet endpoint crée une nouvelle facture de paiement et retourne un lien vers la page de paiement LigdiCash. C’est la première étape du flux payin avec redirection.

POST https://app.ligdicash.com/pay/v01/redirect/checkout-invoice/create

​

Headers

Apikey · string · requis

La clé API de votre projet LigdiCash.

Authorization · string · requis

Votre API TOKEN précédé de Bearer . Exemple : Bearer eyJ0eXAiOiJKV1Qi...

Accept · string · requis

Doit être application/json.

Content-Type · string · requis

Doit être application/json.

​

Body

commande · object · requis

Objet racine de la requête.

Masquer Champs de commande

invoice · object · requis

Détails de la facture.

Masquer Champs de invoice

items · array · requis

Liste des articles. Peut être vide ([]) — dans ce cas, seul total_amount est pris en compte.

Masquer Champs d'un item

name · string · requis

Nom de l’article.

description · string

Description de l’article.

quantity · integer · requis

Quantité.

unit_price · integer · requis

Prix unitaire en XOF.

total_price · integer · requis

Prix total de la ligne (unit_price × quantity) en XOF.

total_amount · integer · requis

Montant total en XOF (entier, sans décimales). Si items est vide, ce champ seul définit le montant à collecter.

devise · string · requis

Devise. Toujours XOF.

description · string · requis

Description de la commande, affichée sur la page de paiement.

customer · string · requis

Doit toujours être vide (""). Si un numéro est fourni, LigdiCash filtre la page pour n’afficher que les opérateurs correspondants.

customer_firstname · string

Prénom du client.

customer_lastname · string

Nom du client.

customer_email · string

Email du client.

external_id · string

Identifiant marchand alternatif. Laisser vide ("") si non utilisé. Équivalent du transaction_id dans custom_data.

otp · string

Toujours vide ("") pour le payin avec redirection.

store · object · requis

Informations sur votre boutique.

Masquer Champs de store

name · string · requis

Nom de votre boutique ou application, affiché sur la page de paiement.

website_url · string · requis

URL de votre site.

actions · object · requis

URLs de retour et de notification.

Masquer Champs de actions

cancel_url · string · requis

URL vers laquelle LigdiCash redirige le client s’il annule le paiement.

return_url · string · requis

URL vers laquelle LigdiCash redirige le client après un paiement réussi.

callback_url · string · requis

URL de votre endpoint backend pour les notifications de statut. Doit être accessible publiquement.

custom_data · object

Objet libre pour vos métadonnées. LigdiCash vous le retourne dans le callback. Utilisez-le pour passer votre transaction_id.

​

Exemple de requête

cURL

curl -X POST https://app.ligdicash.com/pay/v01/redirect/checkout-invoice/create \
  -H "Apikey: {API_KEY}" \
  -H "Authorization: Bearer {API_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "commande": {
      "invoice": {
        "items": [
          {
            "name": "Abonnement Pro",
            "description": "Accès premium 1 mois",
            "quantity": 1,
            "unit_price": 5000,
            "total_price": 5000
          }
        ],
        "total_amount": 5000,
        "devise": "XOF",
        "description": "Abonnement Pro — Janvier 2025",
        "customer": "",
        "customer_firstname": "Amadou",
        "customer_lastname": "Diallo",
        "customer_email": "[e-mail]",
        "external_id": "",
        "otp": ""
      },
      "store": {
        "name": "MonApp",
        "website_url": "https://monapp.com"
      },
      "actions": {
        "cancel_url": "https://monapp.com/paiement/annule",
        "return_url": "https://monapp.com/paiement/succes",
        "callback_url": "https://monapp.com/api/callback/ligdicash"
      },
      "custom_data": {
        "transaction_id": "ORD-2025-00042"
      }
    }
  }'

const response = await fetch(
  "https://app.ligdicash.com/pay/v01/redirect/checkout-invoice/create",
  {
    method: "POST",
    headers: {
      Apikey: process.env.LIGDICASH_API_KEY,
      Authorization: `Bearer ${process.env.LIGDICASH_API_TOKEN}`,
      Accept: "application/json",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      commande: {
        invoice: {
          items: [
            {
              name: "Abonnement Pro",
              description: "Accès premium 1 mois",
              quantity: 1,
              unit_price: 5000,
              total_price: 5000,
            },
          ],
          total_amount: 5000,
          devise: "XOF",
          description: "Abonnement Pro — Janvier 2025",
          customer: "",
          customer_firstname: "Amadou",
          customer_lastname: "Diallo",
          customer_email: "[e-mail]",
          external_id: "",
          otp: "",
        },
        store: { name: "MonApp", website_url: "https://monapp.com" },
        actions: {
          cancel_url: "https://monapp.com/paiement/annule",
          return_url: "https://monapp.com/paiement/succes",
          callback_url: "https://monapp.com/api/callback/ligdicash",
        },
        custom_data: { transaction_id: "ORD-2025-00042" },
      },
    }),
  }
);

const data = await response.json();

$payload = [
  "commande" => [
    "invoice" => [
      "items" => [[
        "name" => "Abonnement Pro",
        "description" => "Accès premium 1 mois",
        "quantity" => 1,
        "unit_price" => 5000,
        "total_price" => 5000,
      ]],
      "total_amount" => 5000,
      "devise" => "XOF",
      "description" => "Abonnement Pro — Janvier 2025",
      "customer" => "",
      "customer_firstname" => "Amadou",
      "customer_lastname" => "Diallo",
      "customer_email" => "[e-mail]",
      "external_id" => "",
      "otp" => "",
    ],
    "store" => ["name" => "MonApp", "website_url" => "https://monapp.com"],
    "actions" => [
      "cancel_url" => "https://monapp.com/paiement/annule",
      "return_url" => "https://monapp.com/paiement/succes",
      "callback_url" => "https://monapp.com/api/callback/ligdicash",
    ],
    "custom_data" => ["transaction_id" => "ORD-2025-00042"],
  ],
];

$ch = curl_init("https://app.ligdicash.com/pay/v01/redirect/checkout-invoice/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Apikey: " . $_ENV["LIGDICASH_API_KEY"],
  "Authorization: Bearer " . $_ENV["LIGDICASH_API_TOKEN"],
  "Accept: application/json",
  "Content-Type: application/json",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);

​

Réponse

response_code · string

"00" si la facture a été créée avec succès, "01" en cas d’erreur.

token · string

Identifiant de la transaction côté LigdiCash. À stocker en base — nécessaire pour appeler confirm.

response_text · string

En cas de succès : l’URL de la page de paiement à ouvrir pour le client. En cas d’échec : le sous-code d’erreur au format Echec (CodeXX).

wiki · string

URL vers la documentation des codes d’erreur de cet endpoint. À consulter quand response_code vaut "01".

​

Exemple de réponse

Succès

{
  "response_code": "00",
  "token": "eyJ0eXAiOiJKV1Qi...",
  "response_text": "https://app.ligdicash.com/pay/invoice/eyJ0eXAiOiJKV1Qi...",
  "wiki": "https://client.ligdicash.com/wiki/createInvoice"
}

{
  "response_code": "01",
  "token": "",
  "response_text": "Echec (Code00)",
  "wiki": "https://client.ligdicash.com/wiki/createInvoice"
}

​

Pages associées

• Rediriger le client — comment ouvrir response_text
• Pièges courants — customer vide, iframe bloqué
• Le pattern transaction_id — bonnes pratiques pour custom_data