GET
Lister les payouts

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de requête

cursor
string

Identifiant du dernier payout de la page précédente.

take
number

Nombre d'éléments à retourner (défaut 20, max 500).

status
string

Filtre par statut (pending, approved, confirmed, failed, …).

assetCode
string

Filtre par code d'actif (USDT.TRC20, BTC, …).

payoutType
string
requis
from
string

Borne basse de date de création — ISO 8601.

to
string

Borne haute de date de création — ISO 8601.

merchantReference
string
requis
page
number

Page 1-based. Bascule en pagination par offset ; renvoie le total via l'en-tête X-Total-Count.

Réponse

200 - application/json

Liste paginée des payouts.

id
string
requis

Identifiant unique du payout.

merchantReference
object | null
requis

Référence libre attachée par le marchand (optionnelle).

payoutType
string
requis

Catégorie du payout : retrait crypto standard, transfert interne entre marchands, remboursement d'un paiement, ou leg crypto d'un settlement.

amount
string
requis

Montant brut envoyé — chaîne décimale (préserve la précision).

assetCode
string
requis

Code de l'actif crypto (USDT.TRC20, BTC, …).

destinationAddress
string
requis

Adresse de destination — adresse blockchain, email interne ou identifiant d'un autre compte IzichangePay selon destinationType.

destinationType
string
requis

Type de destination : adresse blockchain, email interne ou identifiant d'un autre compte marchand de la plateforme.

destinationMemo
object | null
requis

Mémo/tag requis pour les chaînes memo-type (XRP, TON, Stellar).

feeAmount
string
requis

Frais facturés par IzichangePay — chaîne décimale.

networkFeeAmount
object | null
requis

Frais réseau (gas) effectivement payés à la blockchain — chaîne décimale, renseigné après diffusion.

networkFeeAssetCode
object | null
requis

Asset dans lequel les frais réseau ont été payés : le BASE COIN de la chaîne (ex. TRX pour un retrait USDT.TRC20, BNB pour USDT.BEP20), jamais l'asset du retrait. À utiliser pour libeller networkFeeAmount.

networkFeeUsdEquivalent
object | null
requis

Contre-valeur USD des frais réseau, pour comparer des frais payés dans des monnaies natives différentes. Indicatif de reporting : rien n'est facturé en USD. Renseigné seulement à la CONFIRMATION, quand le coût réel est constaté on-chain — null tant que le payout n'est pas confirmé.

txid
object | null
requis

Hash de la transaction on-chain, vérifiable sur un explorateur de blocs. Renseigné une fois la transaction diffusée : null tant que le retrait n'a pas atteint la chaîne, et sur ce qui n'y arrive jamais (transferts internes, confirmations manuelles hors-chaîne).

Exemple:

"9f4c1a2b3d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f8"

txUrl
object | null
requis

URL de la transaction sur un explorateur de blocs, pré-résolue par le serveur. null si le hash n'est pas encore connu ou si aucun explorateur n'est configuré pour cet actif.

Exemple:

"https://tronscan.org/#/transaction/9f4c1a2b3d5e6f70"

status
string
requis

Statut courant du payout (pending, approved, confirmed, failed, etc.).

failureReason
object | null
requis

Message d'erreur sécurisé pour les payouts non finalisés (échec, en attente d'examen). null pour les payouts en bonne marche.

feeBearer
string
requis

Indique qui supporte les frais : le marchand (montant débité = amount + fee) ou le client (sur les remboursements).

kytStatus
object | null
requis

Statut du contrôle KYT (Know Your Transaction) si applicable.

createdAt
string
requis

Date de création — ISO 8601.

updatedAt
string
requis

Date de dernière mise à jour — ISO 8601.

statusHistory
object[]
requis

Historique des transitions de statut, chaque entrée comportant le statut, l'horodatage, la source et une note éventuelle.