Signature des requêtes CP-HMAC

Chaque requête vers /v1/* est signée avec le secret de la clé API. Le secret lui-même ne transite jamais sur le réseau. Les clients officiels s’en chargent pour vous : cette section s’adresse à ceux qui écrivent leur propre client.

En-tête

Authorization: CP-HMAC key=<key_id>, ts=<unix_seconds>, nonce=<nonce>, sig=<hex>

Ce qui est signé

string = METHOD + "\n" + PATH_WITH_QUERY + "\n" + ts + "\n" + nonce + "\n" + hex(sha256(body))
sig    = hex(HMAC-SHA256(secret, string))

• METHOD : GET, POST, etc.
• PATH_WITH_QUERY : le chemin et la query string exactement tels qu’ils partiront dans la requête : /v1/invoices?status=paid&limit=50. Le schéma et l’hôte ne sont pas signés.
• Le corps est signé octet par octet. Signez la chaîne JSON exacte que vous envoyez, pas un objet resérialisé.
• Pour les requêtes sans corps, hex(sha256("")) = e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.

import { createHash, createHmac, randomBytes } from "node:crypto";

export function sign(keyId, secret, method, pathWithQuery, body = "") {
  const ts = Math.floor(Date.now() / 1000).toString();
  const nonce = randomBytes(16).toString("hex");
  const bodyHash = createHash("sha256").update(body).digest("hex");
  const sig = createHmac("sha256", secret)
    .update(`${method}\n${pathWithQuery}\n${ts}\n${nonce}\n${bodyHash}`)
    .digest("hex");
  return `CP-HMAC key=${keyId}, ts=${ts}, nonce=${nonce}, sig=${sig}`;
}

function cp_sign(string $keyId, string $secret, string $method, string $pathWithQuery, string $body = ''): string {
    $ts = (string) time();
    $nonce = bin2hex(random_bytes(16));
    $str = $method . "\n" . $pathWithQuery . "\n" . $ts . "\n" . $nonce . "\n" . hash('sha256', $body);
    $sig = hash_hmac('sha256', $str, $secret);
    return "CP-HMAC key=$keyId, ts=$ts, nonce=$nonce, sig=$sig";
}

import hashlib, hmac, secrets, time

def cp_sign(key_id: str, secret: str, method: str, path_with_query: str, body: bytes = b"") -> str:
    ts = str(int(time.time()))
    nonce = secrets.token_hex(16)
    msg = f"{method}\n{path_with_query}\n{ts}\n{nonce}\n{hashlib.sha256(body).hexdigest()}"
    sig = hmac.new(secret.encode(), msg.encode(), hashlib.sha256).hexdigest()
    return f"CP-HMAC key={key_id}, ts={ts}, nonce={nonce}, sig={sig}"

sig := cryptopayclient.SignRequest(secret, "POST", "/v1/invoices", ts, nonce, body)
req.Header.Set("Authorization", fmt.Sprintf("CP-HMAC key=%s, ts=%d, nonce=%s, sig=%s", keyID, ts, nonce, sig))

Vecteurs de test

Vérifiez votre implémentation : ces mêmes valeurs servent à tester les quatre clients officiels.

Si vous recevez un 401

Toute erreur de signature renvoie 401 unauthorized avec le même message : le serveur n’indique pas ce qui cloche. Causes fréquentes :

• l’horloge du serveur dérive de plus de 5 minutes : activez NTP ;
• un autre chemin a été signé : sans la query string ou avec des paramètres dans un autre ordre ;
• le corps a été resérialisé après la signature ;
• un nonce a été réutilisé ;
• la clé a été révoquée.

403 merchant_suspended  : la signature est valide, mais le compte marchand est suspendu.

Clés

• Les clés se créent dans le tableau de bord, section « Clés et webhooks ». Le secret ne s’affiche qu’une seule fois.
• Jusqu’à 10 clés peuvent être actives simultanément. Rotation : créez une nouvelle clé, basculez le serveur dessus, révoquez l’ancienne. La révocation prend effet immédiatement.
• Stockez le secret dans un gestionnaire de secrets ou une variable d’environnement du serveur, jamais dans le code ni dans git.
• Limite : environ 20 requêtes par seconde par marchand, avec une marge pour les pics ; au-delà, 429 rate_limited.