Documentation API CMA/CGM

Spécifications d'intégration du service de paiement de factures maritimes CMA/CGM via l'API B-MO.

Présentation

L'API CMA/CGM permet aux partenaires B-MO de consulter les factures impayées, de calculer les frais d'opération et d'effectuer des règlements de factures maritimes en ligne.

URL de Base (selon l'environnement sélectionné) :

  • PAP (Pré-production / Défaut) : https://svc.pap.bestcash.me/external
  • TEST (Sandbox) : https://svc.test.bestcash.me/external
  • LIVE (Production) : https://svc.bmo.bestcash.me/external

Vous pouvez basculer d'un environnement à un autre à tout moment depuis le menu déroulant en haut des consoles d'essai <ApiPlayground /> ci-dessous.

1. Récupérer les informations d'une facture impayée (GET /external/thirdparty/billers/cma-cgm/invoice/{reference})

Permet d'extraire les détails complets d'une facture maritime CMA/CGM à partir de sa référence.

  • Méthode : GET
  • URL : /external/thirdparty/billers/cma-cgm/invoice/{reference}
  • Paramètre d'URL : {reference} (ex: BJKR0845111)

Tester la recherche de facture CMA/CGM

Récupérez les montants, statuts de paiement et données BL / Voyage de la facture.

Authentification (En-têtes B-MO)
Paramètres d'URL / Query Parameters (0)

Aucun paramètre d'URL configuré.

Exemple de réponse HTTP 200

{
  "multiplePaymentAuthorized": true,
  "partialPaymentAuthorized": false,
  "meta": {
    "additional_data": {
      "bl": {
        "code": "bl",
        "label": "BL",
        "description": "",
        "value": "CII0209332",
        "target": "CLIENT",
        "translations": []
      },
      "voyage": {
        "code": "voyage",
        "label": "Voyage",
        "description": "",
        "value": "0BVA4N1MA",
        "target": "CLIENT",
        "translations": []
      }
    }
  },
  "reference": "BJKR0845111",
  "currency": 952,
  "amount": 380000,
  "totalAmount": 380000,
  "paidAmount": 0,
  "invoiceDate": 1786966345,
  "invoiceDueDate": 1786966345,
  "invoiceDisplayOrder": 1
}

2. Calculer le coût d'une opération (GET /external/thirdparty/billers/cma-cgm/cost)

Permet d'obtenir l'estimation des frais applicables avant d'exécuter le paiement.

  • Méthode : GET
  • URL : /external/thirdparty/billers/cma-cgm/cost
  • Paramètre de requête : amount (ex: 380000)

Tester le calcul du coût d'opération CMA/CGM

Calculez les frais et obtenez les informations de la zone monétaire UEMOA.

Authentification (En-têtes B-MO)
Paramètres d'URL / Query Parameters (1)

Exemple de réponse HTTP 200

{
  "cost": 38000,
  "targetMonetaryArea": {
    "currencyShortName": "F CFA",
    "currencyCode": "XOF"
  }
}

3. Effectuer l'opération (POST /external/thirdparty/billers/cma-cgm/operation)

Déclencher le paiement de la facture CMA/CGM.

  • Méthode : POST
  • URL : /external/thirdparty/billers/cma-cgm/operation

Tester le paiement de facture CMA/CGM

Exécutez le règlement d'une facture CMA/CGM en environnement Sandbox.

Authentification (En-têtes B-MO)
Paramètres d'URL / Query Parameters (0)

Aucun paramètre d'URL configuré.

Corps de la Requête (JSON Body)

Exemple de corps de requête (JSON)

{
  "amount": 380000,
  "reference": "BJKR0845111",
  "externalReference": "test-001"
}

Exemple de réponse HTTP 201

{
  "prefixedAmount": "380 000 F CFA",
  "prefixedOperationCost": "38 000 F CFA",
  "operationCode": "",
  "status": "CONFIRMED",
  "operationCost": 38000,
  "amount": 380000,
  "operationType": "BILL_PAYMENT",
  "reference": "NICON20260723102013216",
  "creationDate": "2026-07-23T10:20:13+00:00",
  "customerReference": "BJKR0845111",
  "invoices": [
    {
      "reference": "BJKR0845111",
      "currency": 952,
      "amount": 380000,
      "totalAmount": 380000,
      "paidAmount": 0,
      "invoiceDate": 1786966345,
      "invoiceDueDate": 1786966345,
      "invoiceDisplayOrder": 1,
      "meta": {
        "additional_data": [
          {
            "code": "bl",
            "label": "BL",
            "description": "",
            "value": "CII0209332",
            "target": "CLIENT",
            "translations": []
          },
          {
            "code": "voyage",
            "label": "Voyage",
            "description": "",
            "value": "0BVA4N1MA",
            "target": "CLIENT",
            "translations": []
          }
        ]
      }
    }
  ]
}

4. Vérifier le statut d'une opération (GET /external/thirdparty/operation)

  • Méthode : GET
  • URL : /external/thirdparty/operation
  • Paramètre de requête : externalReference (ex: test-001)

Tester la vérification de statut CMA/CGM

Consultez l'état d'un paiement de facture CMA/CGM.

Authentification (En-têtes B-MO)
Paramètres d'URL / Query Parameters (1)

Exemple de réponse HTTP 200

{
  "status": "CONFIRMED",
  "operationCost": 38000,
  "amount": 380000,
  "operationType": "BILL_PAYMENT",
  "reference": "NICON20260723102013216",
  "creationDate": "2026-07-23T10:20:13+00:00",
  "externalReference": "test-001"
}