Report request

A method for getting a CSV report for transactions

Request Report

Large CSV Reports may take a long time to generate, so we designed an asynchronous flow to retrieve it. To get to the report, client should perform the following steps:

1. Request report using REQUEST_REPORT URL

2. Check report status using STATUS_REPORT URL until its done

3. Download generated report via DOWNLOAD_REPORT URL

Request address

POST

https://{domain}/v1/payments/report/

Query parameters

Name	Required	Type	Description	Example
site_id	Yes	Integer	Site identifier in the system	1
start_date	Yes	Timestamp	Start time of the report	1694681569
end_date	Yes	Timestamp	End time of the report	1694778773
type	No	Integer	Type of the transaction	3
requested_by	No	String	Id of the client who made the request	69
signature	Yes	SHA-1	Signature	d9f5713990de5c6e32169dba1f0102f540018975

Parameter "type" value - 3, means it is a deposit, value - 11, means it is a withdrawal.

Request example

{
    "site_id": 24,
    "start_date": "1694326942",
    "end_date": "1695795742",
    "signature": "signature"
}

Response example

200

{
    "success": true,
    "track_id": "a86948edfa9545dbad5517d67ba23703"
}

400

{
    "success": false,
    "errors": {
        "site_id": ["Unknown site_id"]
    }
}

Status Report

Request address

GET

https://{domain}/v1/payments/report/

Request parameters

Name	Required	Type	Description	Example
site_id	Yes	Int	Site identifier in the system	24
track_id	Yes	String		a86948edfa9545dbad5517d67ba23703
signature	Yes	String	Signature	d9f5713990de5c6e32169dba1f0102f540018975

Request example

{
    "site_id": 24,
    "track_id": "a86948edfa9545dbad5517d67ba23703",
    "signature": "signature"
}

Response example

200

{
    "success": true,
    "download_url": "https://api.carouseller.com/v1/payments/report/download/",
    "period": "2023-09-10 06:22:22 - 2023-09-27 06:22:22",
    "request_date": "2023-09-27 06:56:41",
    "completed_at": "2023-09-27 06:56:42"
}

400

{
    "success": false,
    "errors": {
        "track_id": [
            "Report is failed, please contact support for investigation"
        ]
    }
}

Download Report

Request address

GET

https://api.carouseller.com/v1/payments/report/download/

Request parameters

Name	Required	Type	Description	Example
site_id	Yes	Int	Site identifier in the system	24
track_id	Yes	String		a86948edfa9545dbad5517d67ba23703
signature	Yes	String	Signature	d9f5713990de5c6e32169dba1f0102f540018975

Example request address

https://api.carouseller.com/v1/payments/report/download/?site_id=24&track_id=a86948edf
a9545dbad5517d67ba23703&signature=signature_example