Lister les paiements

Aperçu

Le service trouve automatiquement tous les paiements qui arrivent sur vos portefeuilles crypto, mais seulement tant qu'il existe des factures avec une recherche active. La recherche fonctionne tant qu'une facture est impayée et continue pendant encore une heure après le délai de paiement — pour tenir compte des réseaux lents. Si aucune facture de ce type n'existe, une transaction entrante n'entre pas dans le système.

Requête

curl -X POST https://api.bitsby.app/payments/list \
  -H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay" \
	-F "startDate=2000-01-01" \
	-F "endDate=2030-01-01" \
	-F "offset=0" \
	-F "limit=10"

Paramètres de la requête

Paramètre	Type de données	Description	Exemple	Obligatoire ?	Par défaut
walletId	UUID	ID du portefeuille au format UUID	1c48b092-9878-48f5-b441-07a8a48e7b54	non
invoiceId	UUID	ID de la facture au format UUID	1c48b092-9878-48f5-b441-07a8a48e7b54	non
startDate	String	Date de début de la transaction on-chain, au format Y-m-d	2000-01-01	non
endDate	String	Date de fin de la transaction on-chain, au format Y-m-d	2030-01-01	non
offset	Integer	Index du premier enregistrement à renvoyer	0	non	0
limit	Integer	Nombre d'enregistrements que vous voulez recevoir	50	non	10

Exemple de réponse

Un paiement déjà associé à une facture :

{
   "result":"success",
   "data":[
      {
         "id":"f986ad8d-2298-473d-982a-efbc817b975d",
         "amount":12,
         "hash":"f09352627039c088688806821b864895ff237558612d834861621fc026de5f68",
         "transactionDatetime":"2024-02-27 21:05:36",
         "invoice":{
            "id":"f31c61f6-407f-4999-95cf-56477eff06d4",
            "uid":"riUZBnNvd2rX",
            "projectId":"9deea1e2-0c08-41a3-bdc2-a34eada3892d",
            "createDatetime":"2024-02-27 20:57:23",
            "timeToPayDatetime":"2024-02-28 08:57:23",
            "commissionFiatUSD":0.12,
            "amountFiatUSD":12,
            "amountFiat":12,
            "currencyFiat":"USD",
            "description":null,
            "serviceData":"orderId:2444",
            "views":1,
            "status":"paid"
         },
         "wallet":{
            "id":"47aa71e2-07a0-482e-9172-7114d7376ba0",
            "name":"usdt-tron",
            "blockchain":"tron",
            "cryptocurrency":"usdt",
            "address":"TKbstUwMzLrfTAGL4erYb7gc7ghmHQ9zG7"
         }
      },
      {
         "id":"f3195184-9a6f-4c82-928b-d7fe7c015b7b",
         "amount":5.02,
         "hash":"74763b65e43bcc9492a6ce9a7f26fbfdbd7635aecd3454420b5e9534cba50ee6",
         "transactionDatetime":"2024-02-26 13:32:57",
         "invoice":{
            "id":"fac8ef03-2c41-4ce0-a432-7c33b928f16f",
            "uid":"AFhygKX21ecd",
            "projectId":"9deea1e2-0c08-41a3-bdc2-a34eada3892d",
            "createDatetime":"2024-02-26 13:29:24",
            "timeToPayDatetime":"2024-02-27 01:29:24",
            "commissionFiatUSD":0.05,
            "amountFiatUSD":5.02, 
            "amountFiat":5,
            "currencyFiat":"USD",
            "description":null,
            "serviceData":"orderId:3419",
            "views":3,
            "status":"paid"
         },
         "wallet":{
            "id":"47aa71e2-07a0-482e-9172-7114d7376ba0",
            "name":"usdt-tron",
            "blockchain":"tron",
            "cryptocurrency":"usdt",
            "address":"TKbstUwMzLrfTAGL4erYb7gc7ghmHQ9zG7"
         }
      }
   ]
}

Un paiement que le service a trouvé mais pas encore associé à une facture arrive sans le bloc invoice. Ces paiements sont les candidats à l'association manuelle :

{
   "result":"success",
   "data":[
      {
         "id":"c1d0f4a2-93b7-4f61-8c25-1a6f0e2b7d94",
         "amount":9.87,
         "hash":"5b1e4b1cf0a4c3d2e9f6a7b8c9d0e1f2a3b4c5d6e7f8091a2b3c4d5e6f708192",
         "transactionDatetime":"2024-02-28 09:14:02",
         "wallet":{
            "id":"47aa71e2-07a0-482e-9172-7114d7376ba0",
            "name":"usdt-tron",
            "blockchain":"tron",
            "cryptocurrency":"usdt",
            "address":"TKbstUwMzLrfTAGL4erYb7gc7ghmHQ9zG7"
         }
      }
   ]
}

Paramètres de la réponse

Paramètre	Description
id	ID du paiement au format UUID
amount	Montant du paiement en cryptomonnaie
hash	Le hash de la transaction on-chain
transactionDatetime	Date et heure de la transaction on-chain (UTC)
invoice	Bloc avec les paramètres de la facture. Présent si une facture est associée au paiement
invoice.id	ID de la facture au format UUID
invoice.uid	ID de la facture (pour le client)
invoice.projectId	ID du projet au format UUID
invoice.createDatetime	Date et heure de création de la facture (UTC)
invoice.timeToPayDatetime	Date et heure de fin de validité de la facture (UTC)
invoice.commissionFiatUSD	Montant de la commission du service. Calculé à partir du montant invoice.amountFiatUSD
invoice.amountFiatUSD	Le montant de la facture converti en USD. À la création de la facture, il est calculé à partir de invoice.amountFiat au taux de change actuel. Au moment du paiement, il est remplacé par le montant réellement reçu, converti en USD au taux de ce moment. La commission dans invoice.commissionFiatUSD est elle aussi recalculée à partir de ce montant
invoice.amountFiat	Le montant d'origine de la facture en devise fiat. Ne change pas
invoice.currencyFiat	Devise fiat
invoice.description	La description définie à la création de la facture
invoice.serviceData	Les données de service définies à la création de la facture
invoice.views	Nombre de vues de la page de paiement
invoice.status	Statut de la facture
wallet	Bloc avec les paramètres du portefeuille
wallet.id	ID du portefeuille au format UUID
wallet.name	Nom du portefeuille
wallet.blockchain	La blockchain du portefeuille crypto
wallet.cryptocurrency	La cryptomonnaie du portefeuille
wallet.address	L'adresse du portefeuille crypto