@extends('layouts.app')@section('content') BURIDAPAY API Documentation

 

BuridaPay API DOCUMENTATION

 

 /home Ecran d'accueil USSD | USSD home screen
Headers
  • "Authorization"  :  "Bearer TOKEN"
Paramètres
Réponse Content-type : application/json
 
  • {
    • "title"  :  "Bienvenue au BURIDA"
    • "content"  :  [
      {
      • "categoryId"  :  "1",
      • "categoryName"  :  "CLIENTS PERMANENTS",
      },
      {
      • "categoryId"  :  "2",
      • "categoryName"  :  "CLIENTS OCASIONNELS",
      },
      {
      • "categoryId"  :  "3",
      • "categoryName"  :  "TRANSPORTEURS",
      }
      ]
    }
Description
Paramètre Description Type Obligatoire
title Titre à afficher String oui
content Objet contenant la Liste des catégories d'activités Json object oui
categoryId Identifiant de la catégorie int oui
categoryName Nom de la catégorie String oui
 /products/:categoryId Liste des produits d'une catégorie | List of products in a category
Headers
  • "Authorization"  :  "Bearer TOKEN"
Paramètres
  • "categoryId"  :  "int"
Réponse Content-type : application/json
Exemple: categoryId = 2
  • {
    • "title"  :  "CLIENTS OCASIONNELS"
    • "content"  :  [
      {
      • "id"  :  "1",
      • "designation"  :  "MARIAGE DISTRICT D'ABIDJAN ET ASSINIE",
      • "amount"  :  "30000",
      },
      {
      • "id"  :  "1",
      • "designation"  :  "MARIAGE HORS DISTRICT D'ABIDJAN ET ASSINIE",
      • "amount"  :  "20000",
      },
      {
      • "id"  :  "1",
      • "designation"  :  "BAPTEME DISTRICT D'ABIDJAN ET ASSINIE",
      • "amount"  :  "5000",
      },
      ]
    }
Description
Paramètre Description Type Obligatoire
title Titre à afficher String oui
content Objet contenant la Liste des produits Json object oui
id Identifiant du produit int oui
designation Nom du produit String oui
 /customers Liste des clients | List of customers
Headers
  • "Authorization"  :  "Bearer TOKEN"
Paramètres
Réponse Content-type : application/json
Exemple
[
  • {
    • "id"  :  "CL001",
    • "firstName"  :  "KOUASSI",
    • "lastName"  :  "KOUAKOU RICHMOND",
    • "registeredPhoneNumber"  :  "0022500000000",
    • "tag"  :  "",
    • "isActive"  :  "true"
    },
    {
    • "id"  :  "CL002",
    • "firstName"  :  "KOFFI",
    • "lastName"  :  "KOUASSI FABRICE",
    • "registeredPhoneNumber"  :  "0022500000000",
    • "tag"  :  "",
    • "isActive"  :  "true"
    }
]
Description
Paramètre Description Type Obligatoire
id Identifiant du client String oui
firstName Prénoms du client String non
lastName Nom du client String non
registeredPhoneNumber Numéro de téléphone du client String non
tag Réservé pour un usage ultérieur Boolean oui
isActive Spécifie si oui ou non le client est actif Boolean oui
 /customers/:customerId Détails d'un client | Customer details
Headers
  • "Authorization"  :  "Bearer TOKEN"
Paramètres
  • "customerId "  :  "string"
Réponse Content-type : application/json
Exemple
{
  • "id"  :  "CL001",
  • "firstName"  :  "KOUASSI",
  • "lastName"  :  "RICHMOND",
  • "registeredPhoneNumber"  :  "0022500000000",
  • "tag"  :  "",
  • "isActive"  :  "true"
}
Description
Paramètre Description Type Obligatoire
id Identifiant du client String oui
firstName Prénoms du client String non
lastName Nom du client String non
registeredPhoneNumber Numéro de téléphone du client String non
tag Réservé pour un usage ultérieur Boolean oui
isActive Spécifie si oui ou non le client est actif Boolean oui
 /customers/:customerId/bills Liste des factures d'un client | List of customer bills
Headers
  • "Authorization"  :  "Bearer TOKEN"
Paramètres
  • "customerId "  :  "string"
Réponse Content-type : application/json
Exemple
[
  • {
    • "billId"  :  "2019/10/000100",
    • "amount"  :  "10000",
    • "periodStart"  :  "2019-10-01",
    • "periodEnd"  :  "2019-12-31",
    • "allowUserCustomInput"  :  true,
    • "paid"  :  "false"
    • "description"  :  "Oct-Dec 2019"
    • "customer"  :  "KOUASSI RICHMOND"
    },
    {
    • "billId"  :  "2020/01/000101",
    • "amount"  :  "15000",
    • "periodStart"  :  "2020-01-01",
    • "periodEnd"  :  "2020-03-01",
    • "allowUserCustomInput"  :  true,
    • "paid"  :  "false"
    • "description"  :  "Janv-Mars 2020"
    • "customer"  :  "KOUASSI RICHMOND"
    }
]
Description
Paramètre Description Type Obligatoire
billId Identifiant de la facture String oui
amount Montant de la facture String non
periodStart Début de la période de facturation String non
periodEnd Fin de la période de facturation String non
description Description de la facture String oui
allowUserCustomInput Indique si le paiement partiel est autorisé Boolean oui
paid Indique si la facture a été payée ou non Boolean oui
customer Nom et prénoms du client String non
 /bills/:billId Détails d'une facture | Details of a bill
Headers
  • "Authorization"  :  "Bearer TOKEN"
Paramètres
  • "billId "  :  "string"
Réponse Content-type : application/json
Exemple
{
  • "billId"  :  "2019/10/000100",
  • "amount"  :  "10000",
  • "periodStart"  :  "2019-10-01",
  • "periodEnd"  :  "2019-12-31",
  • "allowUserCustomInput"  :  true,
  • "paid"  :  "false"
  • "description"  :  "Oct-Dec 2019"
  • "customer"  :  "KOUASSI RICHMOND"
}
Description
Paramètre Description Type Obligatoire
billId Identifiant de la facture String oui
amount Montant de la facture String non
description Libellé de la facture String non
customer Nom et prénoms du client String non
allowUserCustomInput Spécifie si le paiement partiel est autorisé Boolean oui
 /ipn Notification de paiement instantanée | Instant payment notification
Headers
  • "Authorization"  :  "Bearer TOKEN"
Paramètres Content-type: application/json
{
  • "paymentSessionId"  :  "BU5imMJtBvD0H60s",
  • "customerMsisdn"  :  "08779408",
  • "transactionAmount"  :  "15000",
  • "transactionStatus"  :  "success",
  • "failMessage"  :  "",
  • "merchantName"  :  "BURIDA"
  • "merchantCode"  :  "024"
  • "customerId"  :  "1100011"
  • "billId"  :  "2019/02/01127"
  • "transactionDate"  :  "2020-11-15T10:04:27.201Z"
  • "transactionId"  :  "MMP00001"
  • "fees"  :  ""
  • "nuid"  :  "pilopc44a7qo6rdvlmcnwxkvzkd30lo5"
  • "serviceId"  :  "SRV001"
  • "serviceName"  :  "BURIDAPAY"
}
Réponse Content-type : application/json
Exemple
{
  • "nuid"  :  "pilopc44a7qo6rdvlmcnwxkvzkd30lo5"
}
Description
Paramètre Description Type Obligatoire
nuid Accusé de réception String oui

 

@endsection