Relatório PhastPay¶
Consultar Relatórios¶
getReports¶
Utiliza-se a função getReports para consultar o relatório das transações por um determinado período.
Request¶
{
"start_date": "2024-06-01T00:40:01.444Z",
"end_date": "2024-06-05T00:40:01.444Z",
"report_type": "SUMMARY"
}
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
request |
String |
Sim | Objeto contendo as informações da requisição. |
callback |
ICallbackService |
Sim | Interface que será executada para notificações de sucesso ou erro. |
Detalhamento dos Parâmetros
request (getReports)
| Nome | Tipo | Obrigatório | Descrição | Padrão |
|---|---|---|---|---|
start_date |
String |
Sim | Data Inicial em formato UTC | - |
end_date |
String |
Sim | Data Final em formato UTC | - |
report_type |
SUMMARY, DETAILED |
Não | Indica o tipo de relatório a ser gerado: resumido ou detalhado. | SUMMARY |
Detalhamento dos Parâmetros
callback (ICallbackService)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
onSuccess |
String |
Sim | Método chamado em caso de sucesso. |
onError |
String |
Sim | Método chamado em caso de erro. A resposta será uma String, em formato JSON, contendo os campos definidos na classe IpcResponseError. |
fun getReportsService(
phastPayClient: PhastPayClient,
startDate: String,
endDate: String,
reportType: ReportType
) {
val gson: Gson = Gson()
if (phastPayClient.isBound()) {
val getReportsRequest = GetReportsRequest(startDate, endDate, reportType)
val callback = object : PhastPayClient.ICallbackService {
override fun onError(response: String?) {
val responseError = gson.fromJson(response, IpcResponseError::class.java)
println("Erro $responseError")
}
override fun onSuccess(response: String?) {
println("consultado $response")
}
}
phastPayClient.getReports(
gson.toJson(getReportsRequest),
callback
)
}
}
Requisições e Respostas¶
GetReportsRequest¶
data class GetReportsRequest(
@SerializedName("start_date")
val startDate: String,
@SerializedName("end_date")
val endDate: String,
@SerializedName("report_type")
val reportType: ReportType
)
IpcResponseError¶
class IpcResponseError (
@SerializedName("error_message")
val errorMessage: String
)