Create Export | Coinflow

curl -X POST https://api-sandbox.coinflow.cash/api/merchant/exports \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "type": "Payments",
  "format": "Simple",
  "filters": {}
}'

{
  "_id": "string",
  "exportId": "string",
  "createdBy": {
    "editor": "string",
    "editorType": "Coinflow",
    "ipAddress": "string"
  },
  "type": "Payments",
  "format": "Simple",
  "status": "Pending",
  "filters": {
    "since": "string",
    "until": "string",
    "status": "string",
    "method": "string",
    "search": "string",
    "protection": "string",
    "processor": "string",
    "amount": "string",
    "authCode": "string",
    "timezone": "string",
    "merchantId": "string"
  },
  "filtersHash": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "expiresAt": "2024-01-15T09:30:00Z",
  "merchant": "string",
  "progress": {
    "processed": 1.1,
    "total": 1.1
  },
  "r2Key": "string",
  "fileName": "string",
  "fileSize": 1.1,
  "recordCount": 1.1,
  "downloadLogs": [
    {
      "editor": "string",
      "editorType": "Coinflow",
      "ipAddress": "string",
      "downloadedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "errorMessage": "string",
  "startedAt": "2024-01-15T09:30:00Z",
  "completedAt": "2024-01-15T09:30:00Z"
}

Create a new export job

Authentication

Authorizationstring

The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Request

This endpoint expects an object.

typeenumRequired

Allowed values:

formatenumRequired

Allowed values:

filtersobjectRequired

Response

_idstring

exportIdstring

createdByobject

typeenum

Allowed values:

formatenum

Allowed values:

statusenum

Allowed values:

filtersobject

filtersHashstring

createdAtdatetime

updatedAtdatetime

expiresAtdatetime

merchantstring or object or null

progressobject or null

r2Keystring or null

fileNamestring or null

fileSizedouble or null

recordCountdouble or null

downloadLogslist of objects or null

errorMessagestring or null

startedAtdatetime or null

completedAtdatetime or null