Préparer un export
POST/v1/exports
Prépare un fichier CSV ou Excel de ce que la page Rapports exporte : paiements, essais, remboursements, retraits, litiges, mouvements du compte, factures ou clients, sur une période.
L’export naît « pending ». Le webhook « export.ready » prévient quand le fichier est prêt ; « file_url » le rend alors, avec votre clé secrète. Les numéros des payeurs y sont toujours masqués.
Les en-têtes
Idempotency-KeytexteConseillée : la même clé rend le même export, sans en préparer un second.
Idempotency-KeytexteConseillée : la même clé rend le même export, sans en préparer un second.
Ce qu’on envoie
Un corps JSON. Ce qui n’est pas requis peut être omis.
datasetREQUIStexteCe que vous exportez : « payments » (les paiements), « attempts » (les essais de paiement), « refunds », « payouts », « disputes », « ledger » (les mouvements du compte), « invoices » ou « customers ».
fromREQUIStexteLe premier jour, au format AAAA-MM-JJ, à l’heure du pays de l’espace.
toREQUIStexteLe dernier jour, compris.
format« csv » · « xlsx »Par défaut « csv » : UTF-8 et point-virgule. « xlsx » : un classeur Excel, montants et dates en nombres.
columns« accounting » · « full » ou listePar défaut « accounting », les colonnes du modèle Comptable ; « full », toutes ; ou la liste des colonnes voulues, dans l’ordre. Les en-têtes du fichier sont ces noms.
currencytexteSans précision : la monnaie de l’espace. Une monnaie à la fois.
filtersobjetLes filtres de la page Rapports : status, channel, operator, country, metadata. Ils valent pour les jeux qui les suivent.
datasetREQUIStexteCe que vous exportez : « payments » (les paiements), « attempts » (les essais de paiement), « refunds », « payouts », « disputes », « ledger » (les mouvements du compte), « invoices » ou « customers ».
fromREQUIStexteLe premier jour, au format AAAA-MM-JJ, à l’heure du pays de l’espace.
toREQUIStexteLe dernier jour, compris.
format« csv » · « xlsx »Par défaut « csv » : UTF-8 et point-virgule. « xlsx » : un classeur Excel, montants et dates en nombres.
columns« accounting » · « full » ou listePar défaut « accounting », les colonnes du modèle Comptable ; « full », toutes ; ou la liste des colonnes voulues, dans l’ordre. Les en-têtes du fichier sont ces noms.
currencytexteSans précision : la monnaie de l’espace. Une monnaie à la fois.
filtersobjetLes filtres de la page Rapports : status, channel, operator, country, metadata. Ils valent pour les jeux qui les suivent.
La demande
bash
curl https://api.payiz.app/v1/exports \
-H "Authorization: Bearer sk_test_…" \
-H "Idempotency-Key: rapports-exporter-01" \
-H "Content-Type: application/json" \
-d '{
"dataset": "payments",
"from": "2026-09-01",
"to": "2026-09-30",
"format": "xlsx",
"columns": "accounting"
}'La réponse
json
{
"id": "exp_01j9zk4m2q8w5tz7m3kd6hw2pv",
"object": "export",
"dataset": "payments",
"format": "xlsx",
"columns": [
"date",
"reference",
"description",
"status",
"amount",
"fee",
"net",
"currency"
],
"from": "2026-09-01",
"to": "2026-09-30",
"currency": "XOF",
"status": "pending",
"rows": 92,
"file_url": null,
"expires_at": 1793433600,
"created": 1790841600,
"livemode": false
}Ce qu’on reçoit
202 · un objet export
idtexteUn identifiant préfixé « exp_ », par exemple exp_01j9zk4m2q8w5tz7m3kd6hw2pv.
object« export »Le genre de l’objet rendu : il ne change jamais.
datasettexteCe qui est exporté, comme demandé.
format« csv » · « xlsx »Le format du fichier.
columnslisteLes colonnes du fichier, dans l’ordre.
fromtexteLe premier jour couvert.
totexteLe dernier jour couvert.
currencytexteLe code ISO 4217, en majuscules.
status« pending » · « ready » · « failed »Où en est le fichier. « failed » : il n’a pas pu se préparer ; demandez-en un autre.
rowsentierLe nombre de lignes du fichier.
file_urltexte ou nullL’adresse du fichier une fois prêt (GET, avec votre clé secrète). Null tant qu’il se prépare.
expires_atentierDes secondes depuis 1970 : le fichier s’efface ensuite.
createdentierDes secondes depuis 1970.
livemodevrai ou fauxFaux en mode test : aucun argent ne circule.
idtexteUn identifiant préfixé « exp_ », par exemple exp_01j9zk4m2q8w5tz7m3kd6hw2pv.
object« export »Le genre de l’objet rendu : il ne change jamais.
datasettexteCe qui est exporté, comme demandé.
format« csv » · « xlsx »Le format du fichier.
columnslisteLes colonnes du fichier, dans l’ordre.
fromtexteLe premier jour couvert.
totexteLe dernier jour couvert.
currencytexteLe code ISO 4217, en majuscules.
status« pending » · « ready » · « failed »Où en est le fichier. « failed » : il n’a pas pu se préparer ; demandez-en un autre.
rowsentierLe nombre de lignes du fichier.
file_urltexte ou nullL’adresse du fichier une fois prêt (GET, avec votre clé secrète). Null tant qu’il se prépare.
expires_atentierDes secondes depuis 1970 : le fichier s’efface ensuite.
createdentierDes secondes depuis 1970.
livemodevrai ou fauxFaux en mode test : aucun argent ne circule.
© 2026 PayizUne question ? L’aide est dans le rond, en bas à droite.