Documentation/Lire un export
openapi.jsonOuvrir mon espace

Lire un export

GET/v1/exports/{id}

Un export, et où en est son fichier.

La demande

bash
curl https://api.payiz.app/v1/exports/exp_01j9zk4m2q8w5tz7m3kd6hw2pv \
  -H "Authorization: Bearer sk_test_…"

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

200 · 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.
© 2026 PayizUne question ? L’aide est dans le rond, en bas à droite.
GET/v1/exports/{id}

Un export, et où en est son fichier.

La demande

bash
curl https://api.payiz.app/v1/exports/exp_01j9zk4m2q8w5tz7m3kd6hw2pv \
  -H "Authorization: Bearer sk_test_…"

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

200 · 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.