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 Payment Provider Request response: refer Deep Link Payment Result Response |
| universalPaymentResultObserver(url) | iOS | URL | O | Observer deep link payment url method. url: refer URL |
| supportGooglePayPayment(request, response) | Android | PaymentProviderRequest, PaymentResultResponseCallback | O | Verify google pay availability method. request: refer Payment Provider Request response: refer Google Pay Payment Result Response |
| supportGooglePayPayment(googlePayAPIEnvironment, request, response) | Android | Integer, PaymentProviderRequest, PaymentResultResponseCallback | O | Verify google pay availability method. googlePayAPIEnvironment: refer API environment request: refer Payment Provider Request response: refer Google Pay Payment Result Response |
| proceedGooglePayPayment(request, response) | Android | PaymentProviderRequest, PaymentResultResponseCallback | O | Proceed google pay payment method. request: refer Payment Provider Request response: refer Google Pay Payment Result Response |
| proceedGooglePayPayment(googlePayAPIEnvironment, request, response) | Android | Integer, PaymentProviderRequest, PaymentResultResponseCallback | O | Proceed google pay payment method. googlePayAPIEnvironment: refer API environment request: refer Payment Provider Request response: refer Google Pay Payment Result Response |
| proceedApplePayPayment(request, response) | iOS | PaymentProviderRequest, PaymentResultResponseCallback | O | Proceed apple pay payment method. request: refer Payment Provider Request response: refer Apple Pay Payment Result Response |
| supportApplePayPayment(request, response) | iOS | PaymentProviderRequest, PaymentResultResponseCallback | O | Verify apple pay availability method. request: refer Payment Provider Request response: refer Apple Pay Payment Result Response |
| proceedZaloPayPayment(request, response) | iOS / Android | PaymentProviderRequest, PaymentResultResponseCallback | O | Proceed ZaloPay payment method. request: refer Payment Provider Request response: refer Zalo Pay Payment Result Response |
| proceedZaloPayPayment(zaloPayAPIEnvironment, request, response) | iOS / Android | Environment, PaymentProviderRequest, PaymentResultResponseCallback | O | Proceed ZaloPay payment method. zaloPayAPIEnvironment: refer zalo pay guide request: refer Payment Provider Request response: refer 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 activity: refer app activity |
| uiViewController | iOS | UIViewController | C | iOS UI View controller. uiViewController: refer UI view controller |
| paymentProvider | iOS / Android | PaymentProvider | C | Payment provider info. Refer Payment Provider |
| transactionResultResponse | iOS / Android | TransactionResultResponse | C | Transaction result info. Refer Do Payment Response API |
| fxRate | iOS / Android | FXRate | O | Exchange rate info. Refer 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. |
| intent | Android | Intent | O | Payment intent from deep link. |
| responseCode | iOS / Android | String | M | API response code. |
| responseDescription | iOS / Android | String | M | API response description. |
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. |
| responseCode | Android | String | M | API response code. |
| responseDescription | Android | String | M | API response description. |
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. |
| responseDescription | iOS | String | M | API response description. |
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: ZaloPay Result |
| responseCode | iOS / Android | String | M | API response code. Refer: ZaloPay Payment Response Code |
| responseDescription | iOS / Android | String | M | API response description. Refer: ZaloPay Payment Response Code |
Updated 8 months ago