Ir para o conteúdo

Serviços PhastPay

Consultar Serviços Disponíveis

getAvailableServices

Utiliza-se a função getAvailableServices para obter a lista dos serviços de pagamento disponíveis.

A lista de serviços disponíveis pode ser consultada aqui.

Response

{
   "service_provider_resources":[
      {
         "provider_id":"e611de92-1234-1234-1234-7c19a6e96c5f",
         "provider_name":"PAYREXX - EMULATOR",
         "services":[
            {
               "display_mode":"BUTTON",
               "service":"TWINT"
            }
         ],
         "tip_information":{
            "amounts":[
               10,
               30,
               60
            ],
            "percentages":[
               10,
               20,
               30
            ]
         }
      },
      {
         "provider_id":"01065b44-1234-1234-1234-4d359fad89b5",
         "provider_name":"EUPAGO - EMULATOR",
         "services":[
            {
               "display_mode":"BUTTON",
               "service":"MBWAY"
            }
         ]
      }
   ],
   "services":[
      "TWINT",
      "MBWAY"
   ]
}

Parâmetros

Nome Tipo Obrigatório Descrição
onSuccess ICallbackService Sim Callback de sucesso tendo como resposta o IpcGetAvailableServicesResponse.
onError ICallbackService Sim Callback de erro tendo como resposta o IpcResponseError.

Detalhe dos Parâmetros

response (IpcGetAvailableServicesResponse)

Nome Tipo Obrigatório Descrição
services List<AcquirerType> Não Lista de tipos de adquirentes disponíveis.
service_provider_resources List<ResourceServiceProvider> Não Recursos detalhados dos provedores de serviço.

ResourceServiceProvider

Nome Tipo Obrigatório Descrição
provider_name String Não Nome do provedor de serviço.
provider_id String Não Identificador único do provedor.
tip_information TipInformation Não Configurações de gorjetas (valores e porcentagens).
services List<ServiceDetail> Não Detalhes dos serviços oferecidos por este provedor.

TipInformation

Nome Tipo Obrigatório Descrição
percentages List<Integer> Não Lista de porcentagens sugeridas para gorjeta.
amounts List<Integer> Não Lista de valores fixos sugeridos para gorjeta.

ServiceDetail

Nome Tipo Obrigatório Descrição
service AcquirerType Não Tipo de adquirente (ex: BIZUM, MBWAY).
display_mode DisplayMode Não Modo de exibição na interface (Padrão: BUTTON).

DisplayMode

Valor Descrição
BUTTON O serviço deve ser apresentado como um botão.
SCREEN O serviço deve ser apresentado em uma tela dedicada.

AcquirerType

Nome Tipo Obrigatório Descrição
BIZUM AcquirerType - Serviço de pagamentos instantâneos BIZUM.
MBWAY AcquirerType - Serviço de pagamentos móveis MBWAY.
TWINT AcquirerType - Serviço de pagamentos móveis TWINT.

response (IpcResponseError)

Nome Tipo Obrigatório Descrição
error_message String Sim Mensagem do erro ocorrido durante o processamento.
val callback = object  : PhastPayClient.ICallbackService {
    override fun onSuccess(response: String?) {
         val responseObject =
                    gson.fromJson(response, GetAvailableServicesResponse::class.java)
        println("Response $response")
    }

    override fun onError(response: String?) {
        println("Response $response")
    }
}
phastPayClient.getAvailableServices(callback)

Requisições e Respostas

GetAvailableServicesResponse

data class PhastPayGetAvailableServicesResponse (
    val services: List<Service>,
    @SerialName("service_provider_resources")
    val serviceProviderResources: List<ResourceServiceProvider>? = emptyList()
)

IpcResponseError

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