com.cardpay.sdk.api

Interface ReportsApiControllerApi

public interface ReportsApiControllerApi

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<ReportsResponse>	gETReports(String id) Gets actual state of processing of requested settlement reports
retrofit2.Call<byte[]>	gETReportsContent(String fileId) Download prepared file: single report by id or all reports collected into archive by sample id
retrofit2.Call<ReportsResponse>	pOSTReports(ReportsRequest request) Starts preparation of settlement reports for merchants

Method Detail

gETReports

@GET(value="api/reports/{id}")
retrofit2.Call<ReportsResponse> gETReports(@Path(value="id")
                                                                          String id)

Gets actual state of processing of requested settlement reports

Parameters:

id - id (required)

Returns:

Call<ReportsResponse>

gETReportsContent

@GET(value="api/reports/download")
retrofit2.Call<byte[]> gETReportsContent(@Query(value="file_id")
                                                                            String fileId)

Download prepared file: single report by id or all reports collected into archive by sample id

Parameters:

fileId - file_id (required)

Returns:

Call<byte[]>

pOSTReports

@Headers(value="Content-Type:application/json")
 @POST(value="api/reports")
retrofit2.Call<ReportsResponse> pOSTReports(@Body
                                                                                                                        ReportsRequest request)

Starts preparation of settlement reports for merchants

Parameters:

request - request (required)

Returns:

Call<ReportsResponse>