Retrait on-chain depuis un sous-portefeuille
Débite le sous-portefeuille (pool ledger user_wallets + balance annexe) et diffuse un retrait crypto vers une adresse externe. Réutilise le pipeline payout (frais, compliance, whitelist, broadcast).
Autorisations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Paramètres de chemin
Identifiant du sous-portefeuille.
Corps
Cryptomonnaie à envoyer. Doit figurer parmi les actifs supportés par votre compte, par exemple USDT.TRC20, USDT.BEP20 ou BTC.
32^[A-Z0-9_.\-]{1,32}$"USDT.TRC20"
Montant à envoyer, en unités de l'actif. Chaîne de caractères, jamais un nombre JSON : un montant crypto passé en number est arrondi par la précision flottante. Jusqu'à 18 décimales.
^(?=.*[1-9])\d{1,18}(\.\d{1,18})?$"125.50"
Adresse crypto du destinataire, sur le réseau correspondant à assetCode. Une adresse d'un autre réseau entraîne une perte définitive des fonds.
3 - 255"TJRyWwFs9wTFGZg3JbrVriFbNfCug5tDeC"
Mémo / tag de destination. Obligatoire pour les réseaux qui en exigent un (XRP, TON, Stellar…) ; à omettre pour tous les autres.
120"1234567890"
Note libre attachée au retrait, visible dans votre historique.
255"Paiement fournisseur juillet"
Référence libre côté marchand, reportée telle quelle sur le retrait.
255"facture-4821"
Clé d'idempotence. Rejouer la même clé retourne le retrait déjà créé au lieu d'en créer un second — indispensable pour un retry réseau sûr. Peut aussi être transmise via l'en-tête Idempotency-Key.
120^[A-Za-z0-9_.\-:]+$"payout-2026-07-08-0001"
Code TOTP à 6 chiffres, issu de votre application d'authentification. Requis uniquement pour les appels authentifiés par session utilisateur (dashboard) ; les appels par clé API n'en ont pas besoin.
^[0-9]{6}$"123456"
Qui supporte les frais de ce retrait, pour cet appel uniquement.
merchant: les frais s'ajoutent au montant. Le destinataire reçoitamounten entier, votre solde est débité deamount+ frais.customer: les frais sont prélevés sur le montant. Le destinataire reçoitamountmoins les frais, votre solde est débité deamount. Omis, ce champ retombe sur la configuration de votre compte (merchantpar défaut).
merchant, customer "merchant"
Réponse
Retrait créé.
Identifiant unique du payout.
Référence libre attachée par le marchand (optionnelle).
Catégorie du payout : retrait crypto standard, transfert interne entre marchands, remboursement d'un paiement, ou leg crypto d'un settlement.
Montant brut envoyé — chaîne décimale (préserve la précision).
Code de l'actif crypto (USDT.TRC20, BTC, …).
Adresse de destination — adresse blockchain, email interne ou identifiant d'un autre compte IzichangePay selon destinationType.
Type de destination : adresse blockchain, email interne ou identifiant d'un autre compte marchand de la plateforme.
Mémo/tag requis pour les chaînes memo-type (XRP, TON, Stellar).
Frais facturés par IzichangePay — chaîne décimale.
Frais réseau (gas) effectivement payés à la blockchain — chaîne décimale, renseigné après diffusion.
Statut courant du payout (pending, approved, confirmed, failed, etc.).
Message d'erreur sécurisé pour les payouts non finalisés (échec, en attente d'examen). null pour les payouts en bonne marche.
Indique qui supporte les frais : le marchand (montant débité = amount + fee) ou le client (sur les remboursements).
Statut du contrôle KYT (Know Your Transaction) si applicable.
Date de création — ISO 8601.
Date de dernière mise à jour — ISO 8601.
Historique des transitions de statut, chaque entrée comportant le statut, l'horodatage, la source et une note éventuelle.