Create Export

POST

https://api-sandbox.coinflow.cash/api/merchant/exports

POST

/api/merchant/exports

$ 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": {}
> }'

200Successful

1 {
2   "_id": "string",
3   "exportId": "string",
4   "createdBy": {
5     "editor": "string",
6     "editorType": "Coinflow",
7     "ipAddress": "string"
8   },
9   "type": "Payments",
10   "format": "Simple",
11   "status": "Pending",
12   "filters": {
13     "since": "string",
14     "until": "string",
15     "status": "string",
16     "method": "string",
17     "search": "string",
18     "protection": "string",
19     "processor": "string",
20     "amount": "string",
21     "authCode": "string",
22     "timezone": "string",
23     "merchantId": "string",
24     "statementMonth": 1.1,
25     "statementYear": 1.1
26   },
27   "filtersHash": "string",
28   "createdAt": "2024-01-15T09:30:00Z",
29   "updatedAt": "2024-01-15T09:30:00Z",
30   "expiresAt": "2024-01-15T09:30:00Z",
31   "merchant": "string",
32   "progress": {
33     "processed": 1.1,
34     "total": 1.1
35   },
36   "r2Key": "string",
37   "fileName": "string",
38   "fileSize": 1.1,
39   "recordCount": 1.1,
40   "downloadLogs": [
41     {
42       "editor": "string",
43       "editorType": "Coinflow",
44       "ipAddress": "string",
45       "downloadedAt": "2024-01-15T09:30:00Z"
46     }
47   ],
48   "errorMessage": "string",
49   "startedAt": "2024-01-15T09:30:00Z",
50   "completedAt": "2024-01-15T09:30:00Z"
51 }

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

formatenumRequired

filtersobjectRequired

Response

_idstring

exportIdstring

createdByobject

typeenum

formatenum

statusenum

filtersobject

filtersHashstring

createdAtdatetime

updatedAtdatetime

expiresAtdatetime

merchantstring or object

progressobject

r2Keystring

fileNamestring

fileSizedouble

recordCountdouble

downloadLogslist of objects

errorMessagestring

startedAtdatetime

completedAtdatetime