Créer une commande d’encaissement

Crée un ordre de paiement partagé à montant fixe. La réponse comprend le numéro de commande, l'adresse de réception, la caisse URL et le paiement status.

notifyUrl est requis. Les rappels ultérieurs pour cette commande sont envoyés directement à ce URL.

POST/openapi/payin/orders

En-têtes

ChampTypeObligatoireDescription
x-api-keystringOuiMarchand API Key. Utilisez la valeur commençant par mch_ de la page des paramètres API du marchand.
x-merchant-uidstringOuiMerchant UID.
x-timestampstringOuiMilliseconde à 13 chiffres timestamp. La dérive d'horloge autorisée par défaut est de 5 minutes.
x-noncestringOuiChaîne aléatoire unique pour chaque requête, jusqu'à 128 caractères. La réutilisation est rejetée.
x-signaturestringOuiSignature hexadécimale générée avec HMAC-SHA256. La charge utile contient Merchant UID, timestamp, nonce, la méthode, le chemin, le query canonique et le body canonique.

Paramètres

ChampTypeObligatoireDescription
chainCodestringOuiCode de chaîne. Valeurs prises en charge : TRON / BSC / SOL.
tokenSymbolstringOuiSymbole de jeton, par exemple USDT.
merchantOrderNostringOuiNuméro de commande du commerçant. Maximum 128 caractères.
amountstringOuiMontant du paiement, jusqu'à 6 décimales.
notifyUrlstringOuiRappel spécifique à la commande URL. Un HTTPS URL public appartenant au commerçant est recommandé. Maximum 500 caractères ; les destinations privées, loopback ou non sécurisées sont interdites.

Exemple de requête

{
  "chainCode": "TRON",
  "tokenSymbol": "USDT",
  "merchantOrderNo": "M202604150001",
  "amount": "100.00",
  "notifyUrl": "https://merchant.example.com/api/uugate/payin-notify"
}

Champs de réponse

ChampTypeObligatoireDescription
orderNostringOuiNuméro de commande de la plateforme.
merchantOrderNostring | nullOuiNuméro de commande du commerçant.
bindKeystring | nullOuiBinding key for exclusive-wallet orders; empty for shared pay-in orders.
chainCodestring | nullOuiRéseau de la commande.
tokenSymbolstring | nullOuiDevise de la commande.
txHashstring | nullOuiHash de la transaction associée ; null avant détection.
amountstring | nullOuiMontant de la commande.
paidAmountstring | nullOuiMontant payé. Vide avant paiement.
addressstring | nullOuiAdresse de réception réelle.
cashierUrlstring | nullOuiURL complète du paiement avec un jeton aléatoire. Conservez tout le fragment #ct=.
paymentUristring | nullOuiPaiement par portefeuille URI.
expireAtstring | nullOuiDélai d'expiration de la commande.
createdAtstring | nullOuiTemps créé.
detectedAtstring | nullOuiPayment detection time; empty before detection.
confirmedAtstring | nullOuiOn-chain confirmation time; empty before confirmation.
completedAtstring | nullOuiOrder completion time; empty before completion.
statusstringOuiCommandez status.

Exemple de réponse

{
  "orderNo": "PI1776193200123ABCD1234",
  "merchantOrderNo": "M202604150001",
  "bindKey": null,
  "amount": "100.000000",
  "paidAmount": null,
  "address": "TXYZ3x9nJ5J4xP2gh6mQW7rT31jB8Y2pA9",
  "cashierUrl": "https://open.uugate.com/SK/PI1776193200123ABCD1234#ct=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "paymentUri": "TRON:TXYZ3x9nJ5J4xP2gh6mQW7rT31jB8Y2pA9?token=USDT&amount=100.000000",
  "expireAt": "2026-04-18T06:30:00.000Z",
  "createdAt": "2026-04-18T06:00:00.000Z",
  "detectedAt": null,
  "confirmedAt": null,
  "completedAt": null,
  "status": "waiting_payment",
  "chainCode": "TRON",
  "tokenSymbol": "USDT",
  "txHash": null
}

Exemples de code

Exécution : enregistrez Java sous UUGateExample.java (UUGateCallback.java pour les callbacks), puis utilisez java nom du fichier ; PHP : php example.php ; Go : go run example.go ; Node.js : node example.mjs. Les vérificateurs de callback lisent le corps brut sur l’entrée standard.

import { createHmac, randomBytes } from 'node:crypto';

function required(name) {
  const value = process.env[name]?.trim();
  if (!value) throw new Error(name + ' is required');
  return value;
}
const uid = required("UUGATE_MERCHANT_UID"), key = required("UUGATE_API_KEY");
const timestamp = String(Date.now()), nonce = randomBytes(16).toString("hex");
const method = 'POST', path = '/openapi/payin/orders';
const canonicalQuery = '', canonicalBody = "{\"amount\":\"100.00\",\"chainCode\":\"TRON\",\"merchantOrderNo\":\"M202604150001\",\"notifyUrl\":\"https://merchant.example.com/api/uugate/payin-notify\",\"tokenSymbol\":\"USDT\"}";
const payload = [uid, timestamp, nonce, method, path, canonicalQuery, canonicalBody].join('\n');
const signature = createHmac('sha256', key).update(payload, 'utf8').digest('hex');
const base = (process.env.UUGATE_BASE_URL || 'https://api.uugate.com').replace(/\/+$/, '');
const response = await fetch(base + path, {
  method, redirect: 'error', signal: AbortSignal.timeout(30000),
  headers: { 'Content-Type': 'application/json', 'x-api-key': key, 'x-merchant-uid': uid,
    'x-timestamp': timestamp, 'x-nonce': nonce, 'x-signature': signature },
  ...(canonicalBody ? { body: canonicalBody } : {}),
});
const raw = await response.text();
if (!response.ok) throw new Error('HTTP ' + response.status + ': ' + (raw || 'empty response body'));
JSON.parse(raw);
console.log(raw);

Notes

  • Un ordre de paiement partagé peut déclencher 40105 lorsque le même commerçant, la même chaîne, le même jeton et le même montant sont toujours réservés par un autre ordre valide.
  • Les quatre langages utilisent les mêmes chemins, paramètres et réponses. Les identifiants proviennent de UUGATE_MERCHANT_UID et UUGATE_API_KEY ; UUGATE_BASE_URL vaut https://api.uugate.com par défaut.
  • canonicalBody est un JSON compact aux clés triées. Après modification, triez les objets récursivement, conservez l’ordre des tableaux et utilisez UTF-8 sans échappement supplémentaire des barres obliques ou Unicode. Les montants sont des chaînes, les booléens true / false.
  • Une réponse réussie renvoie directement l’objet métier, sans enveloppe code / data. Vérifiez d’abord le statut HTTP. Les erreurs métier renvoient code, message, data et requestId ; les refus de sécurité peuvent se limiter à HTTP 401 / 403 avec un corps vide.
  • Après un timeout ou HTTP 5xx, consultez la commande avant de répéter sa création ou son envoi. Générez un nouveau timestamp, nonce et une nouvelle signature pour chaque requête.