Developer ZoneRecipesAPI ReferenceChangelog
Developer Zone

APIs Interface

PGW SDK Helper API Interface


Class PGWSDK
Methods Platform Data Type Mandatory Description

instance/shared

iOS / Android

PGWSDKHelper

M

PGW SDK instance methods.

proceedDeepLinkPayment(request, response)

iOS / Android

PaymentProviderRequest, PaymentResultResponseCallback

O

Proceed deep link payment method.

Request: Refer to: Payment Provider Request

Response: Refer to: Deep Link Payment Result Response

universalPaymentResultObserver(url)

iOS

URL

O

Observer deep link payment url method.

Refer to: URL

supportGooglePayPayment(request, response)

Android

PaymentProviderRequest, PaymentResultResponseCallback

O

Verify google pay availability method.

Request: Refer to: Payment Provider Request

Response: Refer to: Google Pay Payment Result Response

supportGooglePayPayment(googlePayAPIEnvironment, request, response)

Android

Integer, PaymentProviderRequest, PaymentResultResponseCallback

O

Verify google pay availability method.

googlePayAPIEnvironment: Refer to: API environment

Request: Refer to: Payment Provider Request

Response: Refer to: Google Pay Payment Result Response

proceedGooglePayPayment(request, response)

Android

PaymentProviderRequest, PaymentResultResponseCallback

O

Proceed google pay payment method.

Request: Refer to:Payment Provider Request

Response: Refer to: Google Pay Payment Result Response

proceedGooglePayPayment(googlePayAPIEnvironment, request, response)

Android

Integer, PaymentProviderRequest, PaymentResultResponseCallback

O

Proceed google pay payment method.

googlePayAPIEnvironment: Refer to: API environment

Request: Refer to: Payment Provider Request

Response: Refer to: Google Pay Payment Result Response

proceedApplePayPayment(request, response)

iOS

PaymentProviderRequest, PaymentResultResponseCallback

O

Proceed apple pay payment method.

Request: Refer to: Payment Provider Request

Response: Refer to: Apple Pay Payment Result Response

supportApplePayPayment(request, response)

iOS

PaymentProviderRequest, PaymentResultResponseCallback

O

Verify apple pay availability method.

Request: Refer to: Payment Provider Request

Response: Refer to: Apple Pay Payment Result Response

proceedZaloPayPayment(request, response)

iOS / Android

PaymentProviderRequest, PaymentResultResponseCallback

O

Proceed ZaloPay payment method.

Request: Refer to: Payment Provider Request

Response: Refer to: Zalo Pay Payment Result Response

proceedZaloPayPayment(zaloPayAPIEnvironment, request, response)

iOS / Android

Environment, PaymentProviderRequest, PaymentResultResponseCallback

O

Proceed ZaloPay payment method.

zaloPayAPIEnvironment: Refer to: ZaloPay Wallet

Request: Refer to: Payment Provider Request

Response: Refer to: Zalo Pay Payment Result Response


Payment Provider Request


Class PaymentProviderRequest
Parameter Platform Data Type Mandatory Description

Constructors (activity)

Android

Activity

M

Init class constructor with Android activity.

• SDK constructor
• Refer to: Activity

uiViewController

iOS

UIViewController

C

iOS UI View controller.

Refer to: UI view controller

paymentProvider

iOS / Android

PaymentProvider

C

Payment provider info.

Refer to: Payment Provider

transactionResultResponse

iOS / Android

TransactionResultResponse

C

Transaction result info.

Refer to: Do Payment Response API

fxRate

iOS / Android

FXRate

O

Exchange rate info.

Refer to: FX rate


Deep Link Payment Result Response


Class DeepLinkPaymentResultResponse
Parameter Platform Data Type Mandatory Description

paymentToken

iOS / Android

String

M

Payment token.

data

iOS / Android

String

M

Payment data information.

fallbackData

iOS / Android

String

M

Payment fallback data information.

• if user device doesn't installed specific native app, this fallback allow do payment with web payment.

intent

Android

Intent

O

Payment intent from deep link.

Refer to: Intent

responseCode

iOS / Android

String

M

API response code.

Refer to: Deep Link Payment Response Code

responseDescription

iOS / Android

String

M

API response description.

Refer to: Deep Link Payment Response Code


Google Pay Payment Result Response


Class GooglePayPaymentResultResponse
Parameter Platform Data Type Mandatory Description

token

Android

String

M

Google pay token.

fxRateId

Android

String

O

Exchange rate id.

googlePayResult

Android

GooglePayResult

M

Google pay result data.

Refer to: Google Pay Result

responseCode

Android

String

M

API response code.

Refer to: Google Pay Payment Response Code

responseDescription

Android

String

M

API response description.

Refer to: Google Pay Payment Response Code


Apple Pay Payment Result Response


Class ApplePayPaymentResultResponse
Parameter Platform Data Type Mandatory Description

token

iOS

String

M

Apple pay token.

fxRateId

iOS

String

O

Exchange rate id.

responseCode

iOS

String

M

API response code.

Refer to: Apple Pay Payment Response Code

responseDescription

iOS

String

M

API response description.

Refer to: Apple Pay Payment Response Code


ZaloPay Payment Result Response


Class ZaloPayPaymentResultResponse
Parameter Platform Data Type Mandatory Description

data

iOS / Android

String

M

Payment data information.

fallbackData

iOS / Android

String

O

Payment fallback data information.

result

iOS / Android

ZaloPayResult

M

ZaloPay result data.

Refer to: ZaloPay Result

responseCode

iOS / Android

String

M

API response code.

Refer to: ZaloPay Payment Response Code

responseDescription

iOS / Android

String

M

API response description.

Refer to: ZaloPay Payment Response Code