Consultar PhastPay¶

Consultar Pagamento¶

`getPaymentById`¶

Utiliza-se a função getPaymentById para consultar um pagamento com base no identificador de pagamento.

`Request`¶

{
  "payment_id": "1e270a9b-09c5-4c95-882e-a10fdec288e1"
}

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`request`	`String`	Sim	Objeto contendo as informações da requisição de consulta de pagamento.
`callback`	`ICallbackService`	Sim	Interface que será executada para notificações de sucesso ou erro no processo de consulta de um pagamento.

Detalhamento dos Parâmetros

request (getPaymentById)

Nome	Tipo	Obrigatório	Descrição	Padrão
`payment_id`	`String`	Sim	Identificador da Transação de Pagamento.

Detalhamento dos Parâmetros

callback (ICallbackService)

Nome	Tipo	Obrigatório	Descrição
`onSuccess`	`String`	Sim	Método chamado em caso de sucesso. A resposta será uma `String`, em formato JSON, contendo os campos definidos na classe `GetPaymentByIdResponse`.
`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 getPaymentByIdService(
    phastPayClient: PhastPayClient,
    paymentId: String,
    printCustomerReceipt: Boolean,
    printMerchantReceipt: Boolean
) {
    val gson: Gson = Gson()

    if (phastPayClient.isBound() && paymentId.isNotBlank()) {
        val getPaymentByIdRequest = GetPaymentByIdRequest(paymentId, printCustomerReceipt, printMerchantReceipt)
        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?) {
               val responseSuccess = gson.fromJson(response, GetByPaymentIdResponse::class.java)
               println("getado $responseSuccess")
            }
        }
        phastPayClient.getPaymentById(
            gson.toJson(getPaymentByIdRequest),
            callback
        )
    }
}

`getPaymentByAppClientId`¶

Utiliza-se a função getPaymentByAppClientId para obter informações de um pagamento a partir do ID do cliente atribuído pela aplicação parceira.

Warning

A função retorna os dados da transação de pagamento sem a necessidade de abrir a aplicação PhastPay.

`Request`¶

{
  "app_client_id": "1e270a9b-09c5-4c95-882e-a10fdec288e1"
}

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`request`	`String`	Sim	Objeto contendo as informações da requisição consulta de um pagamento.
`callback`	`ICallbackService`	Sim	Interface que será executada para notificações de sucesso ou erro no processo de consulta de um pagamento.

Detalhamento dos Parâmetros

request (getPaymentByAppClientId)

Nome	Tipo	Obrigatório	Descrição
`app_client_id`	`String`	Sim	Identificador da transação, gerado pela aplicação parceira, no momento da requisição de pagamento.

Detalhamento dos Parâmetros

callback (ICallbackService)

Nome	Tipo	Obrigatório	Descrição
`onSuccess`	`String`	Sim	Método chamado em caso de sucesso. A resposta será uma `String`, em formato JSON, contendo os campos definidos na classe `GetPaymentByAppClientIdResponse`.
`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 getPaymentByAppClientIdService(
    phastPayClient: PhastPayClient,
    appClientId: String,
) {
    val gson: Gson = Gson()

    if (phastPayClient.isBound() && appClientId.isNotBlank()) {
        val getByClientIdRequest = GetPaymentByAppClientIdRequest(appClientId)
        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?) {
               val responseSuccess = gson.fromJson(response, GetPaymentByAppClientIdResponse::class.java)
               println("consultado $responseSuccess")
            }
        }
        phastPayClient.getPaymentByAppClientId(
            gson.toJson(getByClientIdRequest),
            callback
        )
    }
}

Consultar Devolução¶

`getRefundById`¶

Utiliza-se a função getRefundById para consultar uma devolução com base no identificador de devolução.

`Request`¶

{
  "refund_id": "1e270a9b-09c5-4c95-882e-a10fdec288e1",
  "print_customer_receipt": true,
  "print_merchant_receipt": true,
  "preview_customer_receipt": true,
  "preview_merchant_receipt": true
}

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`request`	`String`	Sim	Objeto contendo as informações da requisição de consulta de uma devolução.
`callback`	`ICallbackService`	Sim	Interface que será executada para notificações de sucesso ou erro no processo de consulta de uma devolução.

Detalhamento dos Parâmetros

request (getRefundById)

Nome	Tipo	Obrigatório	Descrição	Padrão
`refund_id`	`String`	Sim	Identificador da Transação de Devolução.	-
`print_customer_receipt`	`Boolean`	Não	Indica se o comprovante do cliente deve ser impresso após a consulta da devolução.	true
`print_merchant_receipt`	`Boolean`	Não	Indica se o comprovante do estabelecimento deve ser impresso após a consulta da devolução.	true
`preview_customer_receipt`	`Boolean`	Não	Indica se o comprovante do cliente deve ser exibido após a consulta da devolução.	true
`preview_merchant_receipt`	`Boolean`	Não	Indica se o comprovante do estabelecimento deve ser exibido após a consulta da devolução.	true

Detalhamento dos Parâmetros

callback (ICallbackService)

Nome	Tipo	Obrigatório	Descrição
`onSuccess`	`String`	Sim	Método chamado em caso de sucesso. A resposta será uma `String`, em formato JSON, contendo os campos definidos na classe `GetRefundByIdResponse`.
`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 getRefundByIdService(
    phastPayClient: PhastPayClient,
    refundId: String,
    printCustomerReceipt: Boolean,
    printMerchantReceipt: Boolean,
    previewCustomerReceipt: Boolean,
    previewMerchantReceipt: Boolean,
) {
    val gson: Gson = Gson()

    if (phastPayClient.isBound() && refundId.isNotBlank()) {
        val getRefundByIdRequest = GetRefundByIdRequest(refundId, printCustomerReceipt, printMerchantReceipt)
        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?) {
               val responseSuccess = gson.fromJson(response, GetRefundByIdResponse::class.java)
               println("consultado $responseSuccess")
            }
        }
        phastPayClient.getRefundById(
            gson.toJson(getRefundByIdRequest),
            callback
        )
    }
}

Listar Pagamentos¶

`getPaymentsToRefund`¶

Utiliza-se a função getPaymentsToRefund para recuperar a lista de transações elegíveis para devolução.

`Request`¶

{
  "start_date": "2024-06-01T00:40:01.444Z",
  "end_date": "2024-06-05T00:40:01.444Z",
  "print_customer_receipt": true,
  "print_merchant_receipt": true,
  "preview_customer_receipt": true,
  "preview_merchant_receipt": true
}

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`request`	`String`	Sim	Objeto contendo as informações da requisição da consulta.
`callback`	`ICallbackService`	Sim	Interface que será executada para notificações de sucesso ou erro no processo de consulta.

Detalhamento dos Parâmetros

request (getPaymentsToRefund)

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	-
`print_customer_receipt`	`Boolean`	Não	Indica se o comprovante do cliente deve ser impresso após a devolução do pagamento.	true
`print_merchant_receipt`	`Boolean`	Não	Indica se o comprovante do estabelecimento deve ser impresso após a devolução do pagamento.	true
`preview_customer_receipt`	`Boolean`	Não	Indica se o comprovante do cliente deve ser exibido após a devolução do pagamento.	true
`preview_merchant_receipt`	`Boolean`	Não	Indica se o comprovante do estabelecimento deve ser exibido após a devolução do pagamento.	true

Detalhamento dos Parâmetros

callback (ICallbackService)

Nome	Tipo	Obrigatório	Descrição
`onSuccess`	`String`	Sim	Método chamado em caso de sucesso. A resposta será uma `String`, em formato JSON, contendo os campos definidos na classe `GetPaymentsToRefundResponse`.
`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 getPaymentsToRefundService(
    phastPayClient: PhastPayClient,
    startDate: String,
    endDate: String,
    printCustomerReceipt: Boolean,
    printMerchantReceipt: Boolean,
    previewCustomerReceipt: Boolean,
    previewMerchantReceipt: Boolean,
) {
    val gson: Gson = Gson()

    if (phastPayClient.isBound()) {
        val getPaymentsToRefundRequest = GetPaymentsToRefundRequest(startDate, endDate, printCustomerReceipt, printMerchantReceipt)
        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?) {
               val responseSuccess = gson.fromJson(response, GetPaymentsToRefundResponse::class.java)
               println("consultado $responseSuccess")
            }
        }
        phastPayClient.getPaymentsToRefund(
            gson.toJson(getPaymentsToRefundRequest),
            callback
        )
    }
}

`getTransactions`¶

Utiliza-se a função getTransactions para obter a lista de todas as transações com status de pagamento confirmado e/ou devolução registrada.

Warning

Esta consulta retorna os dados correspondentes ao tipo da transação. Caso seja um pagamento, os detalhes do pagamento serão retornados; caso seja uma devolução, serão fornecidos os dados da devolução.

`Request`¶

{
  "start_date": "2024-06-01T00:40:01.444Z",
  "end_date": "2024-06-05T00:40:01.444Z",
  "print_customer_receipt": true,
  "print_merchant_receipt": true,
  "preview_customer_receipt": true,
  "preview_merchant_receipt": true
}

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`request`	`String`	Sim	Objeto contendo as informações da requisição da consulta.
`callback`	`ICallbackService`	Sim	Interface que será executada para notificações de sucesso ou erro no processo de consulta.

Detalhamento dos Parâmetros

request (getTransactions)

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	-
`print_customer_receipt`	`Boolean`	Não	Indica se o comprovante do cliente deve ser impresso após a consulta.	true
`print_merchant_receipt`	`Boolean`	Não	Indica se o comprovante do estabelecimento deve ser impresso após a consulta.	true
`preview_customer_receipt`	`Boolean`	Não	Indica se o comprovante do cliente deve ser impresso após a consulta.	true
`preview_merchant_receipt`	`Boolean`	Não	Indica se o comprovante do estabelecimento deve ser impresso após a consulta.	true

Detalhamento dos Parâmetros

callback (ICallbackService)

Nome	Tipo	Obrigatório	Descrição
`onSuccess`	`String`	Sim	Método chamado em caso de sucesso. A resposta será uma `String`, em formato JSON, contendo os campos definidos na classe `GetTransactionsResponse`.
`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 getTransactionsService(
    phastPayClient: PhastPayClient,
    startDate: String,
    endDate: String,
    printCustomerReceipt: Boolean,
    printMerchantReceipt: Boolean,
    previewCustomerReceipt: Boolean,
    previewMerchantReceipt: Boolean,
) {
    val gson: Gson = Gson()

    if (phastPayClient.isBound()) {
        val getTransactionsRequest = GetTransactionsRequest(startDate, endDate, printCustomerReceipt, printMerchantReceipt)
        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?) {
               val responseSuccess = gson.fromJson(response, GetTransactionsResponse::class.java)
               println("consultado $responseSuccess")
            }
        }
        phastPayClient.getTransactions(
            gson.toJson(getTransactionsRequest),
            callback
        )
    }
}

`getPayments`¶

Utiliza-se a função getPayments para obter uma lista de pagamentos.

Warning

A função retorna a lista de pagamentos sem a necessidade de abrir a aplicação PhastPay.

`Request`¶

{
  "start_date": "2024-06-01T00:40:01.444Z",
  "end_date": "2024-06-05T00:40:01.444Z"
}

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`request`	`String`	Sim	Objeto contendo as informações da requisição de consulta.
`callback`	`ICallbackService`	Sim	Interface que será executada para notificações de sucesso ou erro no processo de consulta.

Detalhamento dos Parâmetros

request (getPayments)

Nome	Tipo	Obrigatório	Descrição
`start_date`	`String`	Sim	Data Inicial em formato UTC
`end_date`	`String`	Sim	Data Final em formato UTC

Detalhamento dos Parâmetros

callback (ICallbackService)

Nome	Tipo	Obrigatório	Descrição
`onSuccess`	`String`	Sim	Método chamado em caso de sucesso. A resposta será uma `String`, em formato JSON, contendo os campos definidos na classe `GetPaymentsResponse`.
`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 getPaymentsService(
    phastPayClient: PhastPayClient,
    startDate: String,
    endDate: String,
) {
    val gson: Gson = Gson()

    if (phastPayClient.isBound()) {
        val getPaymentsRequest = GetPaymentsRequest(startDate, endDate)
        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?) {
               val responseSuccess = gson.fromJson(response, GetPaymentsResponse::class.java)
               println("consultado $responseSuccess")
            }
        }
        phastPayClient.getPayments(
            gson.toJson(getPaymentsRequest),
            callback
        )
    }
}

Requisições e Respostas¶

GetPaymentByIdRequest¶

data class GetPaymentByIdRequest(
    @SerializedName("payment_id")
    val paymentId: String = "",
    @SerializedName("print_customer_receipt")
    val printCustomerReceipt: Boolean = true,
    @SerializedName("print_merchant_receipt")
    val printMerchantReceipt: Boolean = true,
    @SerializedName("preview_customer_receipt")
    val previewCustomerReceipt: Boolean = true,
    @SerializedName("preview_merchant_receipt")
    val previewMerchantReceipt: Boolean = true,
)

GetPaymentByIdResponse:¶

data class GetPaymentByIdResponse(
    @SerializedName("payment_id")
    val paymentId: String? = null,
    @SerializedName("app_client_id")
    val appClientId: String,
    @SerializedName("status")
    val status: String,
    @SerializedName("value")
    val value: String,
    @SerializedName("iva")
    val iva: String? = null,
    @SerializedName("date_time")
    val dateTime: String
)

GetPaymentByAppClientIdRequest¶

data class GetPaymentByAppClientIdRequest(
    @SerializedName("app_client_id")
    val appClientId: String
)

GetPaymentByAppClientIdResponse:¶

data class GetPaymentByAppClientIdResponse(
    @SerializedName("payment_id")
    val paymentId: String? = null,
    @SerializedName("app_client_id")
    val appClientId: String = null,
    @SerializedName("status")
    val status: String,
    @SerializedName("value")
    val value: String,
    @SerializedName("iva")
    val iva: String? = null,
    @SerializedName("date_time")
    val dateTime: String,
    @SerializedName("service")
    val service: String,
    @SerializedName("currency")
    val currency: String,
    @SerializedName("application_id")
    val applicationId: String? = null,
    @SerializedName("application_name")
    val applicationName: String? = null,
    @SerializedName("refunds")
    val refunds: List<StartRefundResponse>? = null
)

Veja mais sobre StartRefundResponse

GetRefundByIdRequest¶

data class GetRefundByIdRequest(
    @SerializedName("refund_id")
    val refundId: String,
    @SerializedName("print_customer_receipt")
    val printCustomerReceipt: Boolean?,

    @SerializedName("print_merchant_receipt")
    val printMerchantReceipt: Boolean?,

    @SerializedName("preview_customer_receipt")
    val previewCustomerReceipt: Boolean = true,

    @SerializedName("preview_merchant_receipt")
    val previewMerchantReceipt: Boolean = true,
)

GetRefundByIdResponse:¶

data class GetRefundByIdResponse(
    @SerializedName("refund_id")
    val refundId: String? = null,
    @SerializedName("app_client_id")
    val appClientId: String,
    @SerializedName("status")
    val status: String,
    @SerializedName("value")
    val value: String,
    @SerializedName("iva")
    val iva: String? = null,
    @SerializedName("date_time")
    val dateTime: String
    )

GetPaymentsToRefundRequest¶

data class GetPaymentsToRefundRequest(
    @SerializedName("start_date")
    val startDate: String,

    @SerializedName("end_date")
    val endDate: String,

    @SerializedName("print_customer_receipt")
    val printCustomerReceipt: Boolean = true,

    @SerializedName("print_merchant_receipt")
    val printMerchantReceipt: Boolean = true,

    @SerializedName("preview_customer_receipt")
    val previewCustomerReceipt: Boolean = true,

    @SerializedName("preview_merchant_receipt")
    val previewMerchantReceipt: Boolean = true,
    )

GetPaymentsToRefundResponse:¶

data class GetPaymentsToRefundResponse(
    @SerializedName("refund_id")
    val refundId: String? = null,
    @SerializedName("app_client_id")
    val appClientId: String,
    @SerializedName("status")
    val status: String,
    @SerializedName("value")
    val value: String,
    @SerializedName("iva")
    val iva: String? = null,
    @SerializedName("date_time")
    val dateTime: String
    )

GetTransactionsRequest¶

data class GetTransactionsRequest(
    @SerializedName("start_date")
    val startDate: String,

    @SerializedName("end_date")
    val endDate: String,

    @SerializedName("print_customer_receipt")
    val printCustomerReceipt: Boolean = true,

    @SerializedName("print_merchant_receipt")
    val printMerchantReceipt: Boolean = true,

    @SerializedName("preview_customer_receipt")
    val previewCustomerReceipt: Boolean = true,

    @SerializedName("preview_merchant_receipt")
    val previewMerchantReceipt: Boolean = true,
    )

GetTransactionsResponse:¶

data class GetTransactionsResponse(
    @SerializedName("payment_id")
    val refundId: String? = null,
    @SerializedName("refund_id")
    val refundId: String? = null,
    @SerializedName("app_client_id")
    val appClientId: String,
    @SerializedName("status")
    val status: String,
    @SerializedName("value")
    val value: String,
    @SerializedName("iva")
    val iva: String? = null,
    @SerializedName("date_time")
    val dateTime: String
    )

GetPaymentsRequest¶

data class GetPaymentsRequest(
    @SerializedName("start_date")
    val startDate: String,

    @SerializedName("end_date")
    val endDate: String
    )

GetPaymentsResponse¶

data class GetPaymentsResponse(
    val payments: List<GetPaymentByAppClientIdResponse>,
)

IpcResponseError¶

class IpcResponseError (
    @SerializedName("error_message")
    val errorMessage: String
)

Consultar PhastPay¶

Consultar Pagamento¶

getPaymentById¶

Request¶

getPaymentByAppClientId¶

Request¶

Consultar Devolução¶

getRefundById¶

Request¶

Listar Pagamentos¶

getPaymentsToRefund¶

Request¶

getTransactions¶

Request¶

getPayments¶

Request¶

Requisições e Respostas¶

GetPaymentByIdRequest¶

GetPaymentByIdResponse:¶

GetPaymentByAppClientIdRequest¶

GetPaymentByAppClientIdResponse:¶

GetRefundByIdRequest¶

GetRefundByIdResponse:¶

GetPaymentsToRefundRequest¶

GetPaymentsToRefundResponse:¶

GetTransactionsRequest¶

GetTransactionsResponse:¶

GetPaymentsRequest¶

GetPaymentsResponse¶

IpcResponseError¶

`getPaymentById`¶

`Request`¶

`getPaymentByAppClientId`¶

`Request`¶

`getRefundById`¶

`Request`¶

`getPaymentsToRefund`¶

`Request`¶

`getTransactions`¶

`Request`¶

`getPayments`¶

`Request`¶