API referenceReports

Export collections

Every collection in the period, whatever became of it. Failed and refunded charges are included rather than filtered out: a report showing only what settled answers "how much came in" and hides "how much did not", which is the half a business is trying to act on.

POST
/api/b/v1/reports/collections/export

Every collection in the period, whatever became of it.

Failed and refunded charges are included rather than filtered out: a report showing only what settled answers "how much came in" and hides "how much did not", which is the half a business is trying to act on.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

admin_access_token?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A report over a window of time.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/b/v1/reports/collections/export" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "kind": "string",  "format": "string",  "status": "string",  "filename": "string",  "row_count": 0,  "byte_size": 0,  "error": "string",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}