Aller au contenu

Intégrations

Créer une facture (Checkout)

Pour créer une facture, vous devez d'abord obtenir l'ID du mode de paiement.

  • Si vous utilisez toujours le même mode de paiement, demandez-le à l'équipe de support.
  • Si vous utilisez différents modes, envoyez une requête au point de terminaison ci-dessous.

Point de terminaison : /v1/payment-method/list
Méthode : GET

Exemple de réponse :

{
  "data": [
    {
      "id": "11111",
      "title": "Cards International",
      "countries": ["US", "GB", "FR"],
      "currencies": ["USD", "EUR"],
      "icon": "",
      "fields": [
        {
          "name": "cardNumber",
          "title": "card number"
        },
        {
          "name": "holderName",
          "title": "holder name"
        }
      ]
    },
    {
      "id": "11117",
      "title": "Alipay",
      "countries": ["CN"],
      "currencies": ["CNY"],
      "icon": "",
      "fields": []
    }
  ]
}

Utilisez la valeur de id comme payment_method lors de la création d'une facture.


Créer une facture

Point de terminaison : /v1/payment/create
Méthode : POST

Requête (paramètres minimaux) :

{
  "amount": "10.03",
  "currency": "USD",
  "payment_method": "11111",
  "save_card": "1",
  "customer": {
    "email": "[email protected]",
    "name": "John Doe",
    "ip": "192.168.1.1"
  },
  "urls": {
    "success": "https://example.com/success",
    "fail": "https://example.com/fail",
    "notification": "https://example.com/notification"
  },
  "reference": "3d7d949e-94fb-4b8b-bc32-7c7f46bcd638",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}

Requête avec carte enregistrée :

{
  "amount": "10.03",
  "currency": "USD",
  "payment_method": "11111",
  "customer": {
    "email": "[email protected]",
    "name": "John Doe",
    "ip": "192.168.1.1"
  },
  "urls": {
    "success": "https://example.com/success",
    "fail": "https://example.com/fail",
    "notification": "https://example.com/notification"
  },
  "reference": "3d7d949e-94fb-4b8b-bc32-7c7f46bcd638",
  "card": {
    "cardId": "050159eb-6af3-407c-84c0-ca1680711a77"
  },
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}

Réponse :

{
  "data": {
    "payment_id": "...",
    "amount": "10.03",
    "currency": "USD",
    "status": "pending",
    "reference": "...",
    "url": "https://api.beezyycashier.com/process/...",
    "method": "get"
  }
}

Redirigez votre client vers l'url.


Mettre à jour les informations de paiement

Par ID de paiement

Point de terminaison : /v1/payment/{payment_id}
Méthode : GET

Par référence

Point de terminaison : /v1/payment/by-reference/{reference}
Méthode : GET

Exemple de réponse

{
  "data": {
    "payment_id": "...",
    "amount": "10.03",
    "status": "success",
    "transactions": [ ... ]
  }
}

Remboursements

Point de terminaison : /v1/refund/create
Méthode : POST

{
  "reference": "...",
  "payment_id": "...",
  "amount": "10.03",
  "currency": "USD"
}

Réponse :

{
  "data": {
    "refund_id": "...",
    "amount": "10.03",
    "status": "success",
    "message": "Remboursement accepté"
  }
}

Enregistrer une carte

Point de terminaison : /v1/client/card/save
Méthode : POST

{
  "payment_method": "11111",
  "customer": {
    "email": "[email protected]",
    "name": "John Doe",
    "ip": "192.168.1.1"
  },
  "urls": {
    "success": "https://example.com/success",
    "fail": "https://example.com/fail",
    "notification": "https://example.com/notification"
  },
  "reference": "...",
  "metadata": {
    "key1": "value1"
  }
}

Informations sur le client

Par email :

GET : /v1/client/[email protected]

Par ID de carte :

GET : /v1/client/card/{card_id}


Actions sur la carte

  • Désactiver : GET /v1/client/card/deactivate/{card_id}
  • Activer : GET /v1/client/card/activate/{card_id}

Retraits

Retrait individuel :

POST : /v1/withdrawal/create

{
  "reference": "...",
  "amount": "10.03",
  "currency": "USD",
  "withdrawal_method_id": "22222",
  "receiver": {
    "cardNumber": "...",
    "name": "John Doe",
    "email": "[email protected]"
  },
  "urls": {
    "notification": "https://example.com/notify"
  }
}

Retraits en masse :

POST : /v1/withdrawal/create-mass
Corps : tableau d’objets de retrait

Par ID de lot :

GET : /v1/withdrawal/{stack_id}


Signature de notification

Vous pouvez vérifier les notifications grâce à l'en-tête de signature.

  • Algorithme : HMAC-SHA512
  • Signature : hash_hmac('sha512', raw_request_body, project_key)
  • En-tête : signature
  • Pour les notifications de retrait, utilisez la clé de retrait du projet à la place de la clé de paiement.
  • Hachez le corps JSON brut tel qu'il a été reçu — ne le ré-encodez pas et ne le reformatez pas avant le hachage.

Exemples de génération de la signature

Tous les extraits ci-dessous produisent la même sortie hex en minuscules pour les mêmes raw_body et project_key.

PHP

$signature = hash_hmac('sha512', $rawBody, $projectKey);

Python

import hmac
import hashlib

signature = hmac.new(
    project_key.encode('utf-8'),
    raw_body.encode('utf-8'),
    hashlib.sha512
).hexdigest()

Go

import (
    "crypto/hmac"
    "crypto/sha512"
    "encoding/hex"
)

mac := hmac.New(sha512.New, []byte(projectKey))
mac.Write([]byte(rawBody))
signature := hex.EncodeToString(mac.Sum(nil))

Java

import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.nio.charset.StandardCharsets;

Mac mac = Mac.getInstance("HmacSHA512");
mac.init(new SecretKeySpec(
    projectKey.getBytes(StandardCharsets.UTF_8),
    "HmacSHA512"
));
byte[] hash = mac.doFinal(rawBody.getBytes(StandardCharsets.UTF_8));

StringBuilder sb = new StringBuilder();
for (byte b : hash) sb.append(String.format("%02x", b));
String signature = sb.toString();

Important : raw_body doit correspondre exactement aux octets lus depuis le corps de la requête HTTP, avant tout json_decode / json.loads. Si vous parsez le JSON puis le re-sérialisez, les espaces et l'ordre des clés changeront, ce qui fera échouer la vérification de la signature.