Payment methods
Overview
This page describes the configuration required for each payment method when using the mobile SDKs (iOS, Android™).
◯: Individual configuration required; △: Only the common configuration is needed; X: No special configuration required
iOS development setup
| Payment | URL Scheme | LSApplicationQueriesSchemes | Apple Pay Merchant ID |
|---|---|---|---|
| PayPay | △ | ◯ *1 | — |
| LINE Pay | △ | ◯ *1 | — |
| Merpay | △ | X | — |
| d Payment | X | X | — |
| au PAY | △ | ◯ *1 | — |
| Rakuten Pay | △ | ◯ | — |
| Paidy | X | X | — |
| atone | X | X | — |
| WeChat Pay | ◯ | ◯ | — |
| Alipay | △ | ◯ | — |
| UnionPay (UnionPay QuickPass) | △ | ◯ | ◯ |
| PayPal | X | ◯ | — |
| Apple Pay | X | X | ◯ |
| Credit card | X | X | — |
*1: Starting with SDK for iOS v3.2.1, you can use each payment app without adding its scheme to LSApplicationQueriesSchemes. If the payment app is not actually installed, the SDK returns error code "10110".
Android development setup
About payment method providers
GoAllpay
If you use GoAllpay, you need to add the GoAllpay SDK information to your project configuration.
For detailed setup instructions, refer to the GoAllpay SDK documentation (Chinese) or (English).
Setup
Add the following to the build.gradle at the root of your project.
repositories {
// ... other maven repos
// maven repo for GoAllpay SDK
maven {
url 'https://s01.oss.sonatype.org/content/repositories/releases/'
}
}Add the following to the build.gradle of your app module.
dependencies {
// ... other dependencies
api("io.github.goallpay:allpaysdk:5.2.5")
}Development setup for each payment method
| Payment | AndroidManifest.xml (Process Activity) | build.gradle (Library Dependency) |
|---|---|---|
| PayPay | ◯ | X |
| LINE Pay | ◯ | X |
| Merpay | ◯ | X |
| d Payment | X | X |
| au PAY | ◯ | X |
| Rakuten Pay | X | ◯ |
| Paidy | X | X |
| atone | X | X |
| WeChat Pay | ◯ | ◯ |
| Alipay | X | ◯ |
| UnionPay (UnionPay QuickPass) | X | X |
| PayPal | X | X |
| Apple Pay | X | X |
| Credit card | X | X |
Starting with Android SDK 1.8.0, the callback Activity specified in the AndroidManifest.xml file can be consolidated into a single Activity, as shown below. The per-payment-method configuration used up to 1.7.1 is no longer supported, so use ElepayCallbackActivity when using version 1.8.0 or later.
For how to obtain your dedicated URL Scheme, see "Get the URL Scheme for the iOS / Android SDK".
<activity
android:name="jp.elestyle.androidapp.elepay.activity.ElepayCallbackActivity"
android:launchMode="singleTask"
android:exported="true">
<intent-filter>
<data android:scheme="ep1234567890abcdef" /> ← Obtain this scheme from the "アプリ設定" (App settings) page.
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
</intent-filter>
</activity>Payment methods
LINE Pay
iOS
iOS 9 and later
Starting with ElepaySDK for iOS v3.2.1, you can use the payment app without adding the scheme below to LSApplicationQueriesSchemes. If the payment app is not actually installed, the SDK returns error code "10110".
For versions earlier than ElepaySDK for iOS v3.2.1, to hand off to the LINE app, add the LSApplicationQueriesSchemes key in the Info tab (or Info.plist) under PROJECT → TARGETS in Xcode.
<string>line</string>Callback URL Scheme for iOS apps
For the stera smart one default URL Scheme, see here.
Android
Starting with elepay Android SDK 1.8.0, the callback Activity specified in the AndroidManifest.xml file can be consolidated into ElepayCallbackActivity. The per-payment-method configuration used up to 1.7.1 is no longer supported, so use ElepayCallbackActivity when using version 1.8.0 or later. For details, see the overview page.
To use LINE Pay, add the "URL Scheme" from the "アプリ設定" (App settings) page of your stera smart one account to your project's AndroidManifest.xml.
<activity
android:name="jp.elestyle.androidapp.elepay.activity.linepay.LinePayActivity"
android:exported="true">
<intent-filter>
<data android:scheme="ep8bd64f25c5545b99c43e295"
android:host="linepay"/> ← Obtain this scheme from the "アプリ設定" (App settings) page.
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
</intent-filter>
</activity>To customize the Activity launched by the scheme, inherit from jp.elestyle.androidapp.elepay.activity.linepay.LinePayActivity.
PayPay
iOS
iOS 9 and later
Starting with ElepaySDK for iOS v3.2.1, you can use the payment app without adding the scheme below to LSApplicationQueriesSchemes. If the payment app is not actually installed, the SDK returns error code "10110".
For versions earlier than ElepaySDK for iOS v3.2.1, to hand off to the PayPay app, add the LSApplicationQueriesSchemes key in the Info tab (or Info.plist) under PROJECT → TARGETS in Xcode.
<string>paypay</string>Callback URL Scheme for iOS apps
For the stera smart one default URL Scheme, see here.
Android
Starting with elepay Android SDK 1.8.0, the callback Activity specified in the AndroidManifest.xml file can be consolidated into ElepayCallbackActivity. The per-payment-method configuration used up to 1.7.1 is no longer supported, so use ElepayCallbackActivity when using version 1.8.0 or later. For details, see the overview page.
To use PayPay, add the "URL Scheme" from the "アプリ設定" (App settings) page of your stera smart one account to your project's AndroidManifest.xml.
<activity
android:name="jp.elestyle.androidapp.elepay.activity.paypay.PayPayActivity"
android:exported="true">
<intent-filter>
<data android:scheme="ep8bd64f25c5545b99c43e295"
android:host="paypay"/> ← Obtain this scheme from the "アプリ設定" (App settings) page.
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
</intent-filter>
</activity>To customize the Activity launched by the scheme, inherit from jp.elestyle.androidapp.elepay.activity.paypay.PayPayActivity.
Merpay
Android
Starting with Android SDK 1.8.0, the callback Activity specified in the AndroidManifest.xml file can be consolidated into ElepayCallbackActivity. The per-payment-method configuration used up to 1.7.1 is no longer supported, so use ElepayCallbackActivity when using version 1.8.0 or later. For details, see the overview page.
To use Merpay, add the "URL Scheme" from the "アプリ設定" (App settings) page of your stera smart one account to your project's AndroidManifest.xml.
<activity
android:name="jp.elestyle.androidapp.elepay.activity.merpay.MerpayActivity"
android:exported="true">
<intent-filter>
<data
android:host="merpay"
android:scheme="ep33e72b55aaa6cce18c0abd7" /> ← Obtain this scheme from the "アプリ設定" (App settings) page.
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
</intent-filter>
</activity>d Payment (d払い)
Overview
No specific configuration is required.
au PAY
iOS
iOS 9 and later
Starting with SDK for iOS v3.2.1, you can use the payment app without adding the scheme below to LSApplicationQueriesSchemes. If the payment app is not actually installed, the SDK returns error code "10110".
For versions earlier than SDK for iOS v3.2.1, to hand off to the au PAY app, add the LSApplicationQueriesSchemes key in the Info tab (or Info.plist) under PROJECT → TARGETS in Xcode.
<string>auwallet</string>Callback URL Scheme for iOS apps
For the stera smart one default URL Scheme, see here.
Android
No special handling is required.
Rakuten Pay
iOS
To use RPay, in addition to the SDK, you need to add RPay's proprietary framework (not publicly available) to your project's build dependencies. For how to obtain RPayKit.framework and how to add the build dependency, contact stera smart one support.
iOS 9 and later
To hand off to the Rakuten Pay app, add the LSApplicationQueriesSchemes key in the Info tab (or Info.plist) under PROJECT → TARGETS in Xcode.
<string>rakutenpaysdk</string>Callback URL Scheme for iOS apps
For the stera smart one default URL Scheme, see here.
Android
To use RPay, in addition to the SDK, you need to add Rakuten Pay's proprietary AAR file (not publicly available) to your project's build dependencies. For how to add build dependencies, see the Android Developers official site.
For where to download the Rakuten Pay AAR file, contact stera smart one support.
Paidy
Overview
No specific configuration is required.
atone
Overview
No specific configuration is required.
Credit card
Overview
No specific configuration is required.
Apple Pay
Overview
This section describes how to implement Apple Pay.
How it works
Apple Pay is a simple payment method that turns an Apple device into a wallet.
Using Apple Pay on iOS
Apple Pay configuration
See Setting up Apple Pay.
-
Register an Apple Merchant ID
To use Apple Pay, you need to register an Apple Merchant ID.
-
Create an Apple Pay certificate
Obtain the certificate used for Apple Pay. During this process, you will be asked to generate a private/public key pair. Take great care not to lose the private key. Bundle the key pair in PKCS12 format and set an export password. Submit the PKCS12 file to the stera smart one team.
Google Pay
Android
Specify googlePayEnvironment when setting up the SDK.
To use Google Pay, you need to apply to Google. As part of the application, you may be asked to submit apps built for each of the TEST and PRODUCTION environments.
When applying in the Google Pay & Wallet Console, select Gateway as the Integration type.
When configuring the SDK, you can specify googlePayExistingPaymentRequired (default: true). This setting determines whether to verify that the user has a valid payment card in Google Pay.
true: At least one payable card is required in Google Pay.false: Payment cards in Google Pay are not verified. If the user has no card, they can add one in the payment dialog.
val configuration = ElepayConfiguration(
apiKey = "" // test key or live key
googlePayEnvironment = GooglePayEnvironment.TEST // or GooglePayEnvironment.PRODUCTION
googlePayExistingPaymentRequired = false // default true
)
Elepay.setup(configuration)Google Pay depends on Google Play Services, so you need to check whether Google Play Services is available before use. The SDK provides the following method for checking Google Pay availability.
// Checks whether Google Pay is available.
fun checkIfGooglePayIsReadyToUse(
activity: Activity,
resultHandler: (Boolean) -> Unit
)Google Pay development
- Ensure that
minSdkVersionmeets the official requirements: https://developers.google.com/pay/api/android/guides/setup#app%20prerequisites - Configure
AndroidManifest.xml:
<application>
...
<meta-data
android:name="com.google.android.gms.wallet.api.enabled"
android:value="true" />
</application>Google Pay PRODUCTION verification
Per Google's requirements, Google Pay in the PRODUCTION environment requires a Google Play release signature. Follow the steps below.
- Apply for access to the Google Pay API. a. https://developers.google.com/pay/api/android/guides/test-and-deploy/publish-your-integration
- Always download the app from the Google Play Store to test it (a locally installed release-signed APK is not accepted). a. https://developers.google.com/pay/api/android/guides/setup#app%20prerequisites b. After signing with your release key and uploading to the Google Play Store, download the app with a tester account and verify the Google Pay functionality.
- Use
GooglePayEnvironment.PRODUCTIONinstead ofGooglePayEnvironment.TEST.
Differences between TEST and PRODUCTION
When googlePayExistingPaymentRequired is set to true:
- Test environment: The Google Wallet app is required. For testing, install the Google Wallet app and register a credit card in it. Otherwise, the Google Pay payment dialog does not launch and
checkIfGooglePayIsReadyToUsereturnsfalse(forcing a payment returns error code 10100). - Production environment: Real users must have a payment card registered in Google Wallet or their Google account. If not,
checkIfGooglePayIsReadyToUsereturnsfalse(forcing a payment returns error code 10100).
When googlePayExistingPaymentRequired is set to false:
- Test environment: Test card information is automatically filled in the Google Pay payment dialog.
- Production environment: If a real user has no payment card registered in Google Pay, the payment dialog prompts them to add a card.
Amazon Pay
Overview
No specific configuration is required.
PayPal
Overview
Callback URL Scheme for iOS apps
For the stera smart one default URL Scheme, see here.
In addition, add a PayPal-specific URL Scheme that starts with your app's Bundle ID.
Check the URL Scheme > PayPal item under stera smart one dashboard > 開発設定 (Developer settings) > アプリ設定 (App settings).
iOS 9 and later
To hand off to the PayPal app, add the LSApplicationQueriesSchemes key in the Info tab (or Info.plist) under PROJECT → TARGETS in Xcode.
<string>com.paypal.ppclient.touch.v1</string>
<string>com.paypal.ppclient.touch.v2</string>Alipay
iOS
iOS 9 and later
To hand off to the Alipay app, add the LSApplicationQueriesSchemes key in the Info tab (or Info.plist) under PROJECT → TARGETS in Xcode.
<string>alipay</string>Callback URL Scheme for iOS apps
For the stera smart one default URL Scheme, see here.
Android
To use Alipay, download the Alipay SDK and place it in your project's libs folder.
The Alipay SDK file name looks like this: alipaySdk-15.6.8-20191021122455-noUtdid.aar
Then add the Alipay SDK dependency to your app's build.gradle.
dependencies {
// ... other dependencies
implementation files('libs/alipaySdk-20170725.jar')
}WeChat Pay
Prerequisites
To invoke WeChat Pay from a native app, you first need to create a WeChat Open Platform account and obtain an App ID.
See the following WeChat Pay documentation. https://pay.weixin.qq.com/doc/global/v3/en/4012356387
For "1. Select Access Mode", note that stera smart one's access mode is "1.2 Institutional Mode".
iOS
Callback URL Scheme for iOS apps
For the payment module default URL Scheme, see here.
In addition, a WeChat-specific URL Scheme (starting with wx) is required.
Check the URL Scheme > WeChat Pay item under stera smart one dashboard > 開発設定 (Developer settings) > アプリ設定 (App settings). If WeChat Pay is not enabled, this item is not displayed.
iOS 9 and later
To hand off to the WeChat Pay app, add the LSApplicationQueriesSchemes key in the Info tab (or Info.plist) under PROJECT → TARGETS in Xcode.
<string>weixin</string>
<string>weixinULAPI</string>Android
WeChat Pay depends on the WeChat library, so add the WeChat SDK dependency to build.gradle.
We recommend the latest version of the WeChat SDK; for the latest version, see wechat sdk maven.
dependencies {
// ... other dependencies
implementation "com.tencent.mm.opensdk:wechat-sdk-android-without-mta:version"
}Then add an activity-alias like the one below to your project's AndroidManifest.xml.
WeChat Pay looks for your.package.name.wxapi.WXPayEntryActivity; this alias links it to the existing code in the SDK.
<!-- Other activity declarations -->
<activity name="...">
</activity>
<!-- Required to use WeChat Pay -->
<activity-alias
android:name="your.package.name.wxapi.WXPayEntryActivity"
android:exported="true"
android:targetActivity="jp.elestyle.androidapp.elepay.activity.wxapi.WXPayEntryActivity" />UnionPay (UnionPay QuickPass)
Overview
iOS 9 and later
To hand off to UnionPay-related apps, add the LSApplicationQueriesSchemes key in the Info tab (or Info.plist) under PROJECT → TARGETS in Xcode.
<string>uppaysdk</string>
<string>uppaywallet</string>
<string>uppayx1</string>
<string>uppayx2</string>
<string>uppayx3</string>Callback URL Scheme for iOS apps
For the stera smart one default URL Scheme, see here.
Payment Station (convenience store payment / bank transfer)
Payment method (paymentMethod)
- Convenience store payment: paymentMethod = konbini
- Bank transfer: paymentMethod = banktransfer
The system redirects the user to a designated page, where they complete the rest of the payment process.
Payment flow and statuses
Both convenience store payments and bank transfers have long processing cycles, so the following statuses are added compared with regular online payments:
| Status | |
|---|---|
| waiting | When the user enters the information required for payment, the payment information is generated and the payment enters this status. |
| notified | The payment moves to this status when the user attempts to pay at a convenience store. The store side usually completes its reconciliation within one week, and if successful, the payment moves to captured. |
| amount_mismatch | The payment enters this status when the amount received by the bank differs from the expected amount. |
Payment deadlines and limitations
- Payment waiting period for convenience store payments: up to 60 days
- Payment waiting period for bank transfers: up to 365 days
During this period, the system keeps waiting for the user's payment, and the revoke operation is not supported (EasyCheckout cannot be deactivated and invoices cannot be canceled).
Handling unexpected payments
Unexpected payments may occur, for example when a user pays twice, pays an incorrect amount, or splits the payment into transfers from multiple bank accounts.
Because the payment service cannot control these cases, merchants must log in to Payment Station, check the payment status, and contact the user directly to arrange any additional payment, refund, or other adjustment.
Last updated on