オフラインでカード支払いを回収する
インターネット接続の問題が生じているときにカード支払いを回収します。
The Terminal SDK allows your application to continue collecting payments using a mobile reader without a network connection.
よくある間違い
When operating offline, payment information is collected at the time of sale, and authorization is only attempted after connectivity is restored and the payment is forwarded. You, as the user, assume all decline and tamper-related risks associated with an offline transaction. If your tampered reader cannot forward payments to Stripe, or the issuer declines the transaction, there’s no way to recover the funds, and you might not receive payment from the customer for goods or services already provided.
カード発行会社による拒否を減らすため、以下のことが推奨されます。
- できる限り早急にインターネット接続を再確立して、支払いを Stripe に記録します。
- 所定の金額を超える場合は取引を制限します。
- Fail all offline payments if the SDK has stored a set of transactions whose sum exceeds a certain amount.
オフライン中に決済を回収する
オフライン決済の手順は、オンライン決済と同じで、決済の作成、回収、処理、およびキャプチャーが含まれます。このプロセスのどの段階でも、デバイスをオンラインからオフラインにできます。
- オフラインモードを有効にする
- オフライン中にリーダーに接続する
- オフラインイベントを処理する
- オフライン中に PaymentIntent を作成する
- 支払い方法を収集する
- 支払いを確定する
- 支払いが転送されるまで待つ
- (オプション) 支払いをキャプチャーする
- (Optional) Examine payments collected offline
オフラインモードを有効にする
オフラインモードを使用するには、アプリケーションが Terminal iOS SDK のバージョン 3.
以降を使用している必要があります。
Use a Configuration object to enable offline mode for the supported devices at your Location
.
After you enable offline mode on a Configuration
object, you can assign it to a Location
. You can also enable offline mode by default for all Locations
by updating the default Configuration
object for your account. Configuration API changes can take several minutes to propagate to your SDK and reader, and require you to disconnect from and reconnect to your reader to take effect.
オフライン中にリーダーに接続する
The SDK stores necessary Location
information locally after connecting online. On subsequent offline connections, it uses the stored configuration information from that Location
.
To collect payments with a smart reader while offline, you must have previously connected to any mobile reader of the same type at the same Location
while online within the last 30 days, and have updated your reader’s software within that time.
If you attempt to connect to a reader while offline without meeting these requirements, the request fails with an error.
エラー | 解決策 |
---|---|
The SDK isn’t connected to the internet | Make sure the Location you’re using is configured for offline mode. Otherwise, connect to any reader while online, and then connect to a reader of the same type while offline. |
選択したリーダーをオフラインでの支払い回収に使用するには、ソフトウェアの更新が必要です。 | The reader’s software hasn’t been updated in 30 days or more. Connect to the reader while online to update it. |
選択したリーダーをオフラインでの支払い回収に使用するには、この場所でオンラインのペアリングを行う必要があります。 | POS がこれまでオンライン中に接続していないタイプのリーダーに接続しようとしています。まずオンライン中に、このリーダーまたは同じタイプのリーダーに接続する必要があります。または、オフライン中に接続する場合は、以前オンライン中に POS が接続していたタイプのリーダーに接続できます。 |
If you reinstall the application or perform any operation that clears the disk storage for the SDK (such as clearing your POS app’s cache in the POS device’s settings) you lose any payments that the SDK has stored and not yet forwarded. Make sure there are no stored payments before you perform any destructive action.
オフラインイベントを処理するクライアント側
To allow your application to receive updates about the SDK’s network status and the state of forwarded payments, implement the OfflineDelegate
protocol and pass it to the Terminal SDK. You must set OfflineDelegate
before collecting payments offline.
オフライン中に PaymentIntent を作成するクライアント側
To support operating offline, use the SDK’s createPaymentIntent
to create PaymentIntent objects. This allows the SDK to create PaymentIntents while offline and forward them to Stripe after you’ve re-established connectivity.
While operating offline, PaymentIntent
objects have a null stripeId
. We recommend adding a custom identifier to the PaymentIntent’s metadata to help reconcile PaymentIntent
objects created offline in your database.
After the PaymentIntent
has been successfully forwarded to Stripe in Step 7, use your custom identifier to reconcile it in the OfflineDelegate.
callback.
The Terminal.
accepts a CreateConfiguration
parameter. By default, if you’re operating offline, the Terminal SDK stores all offline payments, then forwards them to Stripe’s backend when connectivity is restored.
To customize this behavior, you can pass in a CreateConfiguration
object with an offlineBehavior
attribute set to as REQUIRE_
, PREFER_
or FORCE_
.
Managing risk
Setting offlineBehavior
to REQUIRE_
fails the current transaction if you’re operating offline. For example, you might want to disallow transactions above a certain amount or disallow all offline transactions if the SDK has stored a set of transactions whose sum exceeds a certain amount.
SDK では、リスクを管理しやすいように、次の 2 つのプロパティーを公開しています。
Terminal.
offlineStatus. sdk. offlinePaymentsCount Terminal.
offlineStatus. sdk. offlinePaymentAmountsByCurrency
オフライン時の遅延管理
Based on your network connectivity, the Terminal SDK automatically determines whether to collect payments online or offline. However, you might want to operate offline despite having an active network connection (for example, if you need to collect transactions quickly and your network connection is slow). You can pass a CreateConfiguration
object with offlineBehavior
set to FORCE_
to collect the payment offline regardless of connectivity.
Payments collected offline while the Terminal SDK has an active network connection are forwarded in the background.
支払い方法を収集するクライアント側
注
Payment liability is your responsibility when operating your reader offline. Because magnetic stripe data is easy to spoof, Stripe disallows this option while operating offline. Tapping cards is also not supported in markets where Strong Customer Authentication is required.
Collecting payments while offline is similar to collecting payments while online. Use the didRequestReaderInput
method to display the valid card presentment options to the customer.
注
Inspecting payment method details before authorization isn’t supported while offline. Although you can still use the initWithUpdatePaymentIntent
parameter in CollectConfiguration
, the paymentMethod
field on the PaymentIntent is absent if the SDK is operating offline.
支払いを確定するクライアント側
Confirming payments while offline is similar to confirming payments while online. The primary difference is that your integration must handle offline-specific error cases, such as when the transaction exceeds the Stripe-enforced offline maximum of 10,000 USD or equivalent in your operating currency.
In some cases, the SDK might create a PaymentIntent
online, but confirm it while offline. When this happens, the PaymentIntent
might have a non-null stripeId
. If it was confirmed offline, offlineDetails
will be defined and populated.
領収書の提供
オフライン時に支払いの完了に使用されたカードの情報が必要になることがあります。たとえば、購入時の領収書を求める顧客に領収書を生成する必要がある場合などです。
If the PaymentIntent is confirmed offline, retrieve its OfflineCardPresentDetails from the paymentIntent.
property.
This hash contains a ReceiptDetails property you can use to generate a receipt, as well as other card details like the cardholder name and card brand.
The account_
and authorization_
receipt fields are unavailable on PaymentIntents processed offline. Prebuilt email receipts are only sent after connectivity is restored and the payment is successfully captured.
支払いが転送されるまで待つクライアント側
インターネットアクセスが復旧すると、SDK は保存されていたオフラインの支払いの転送を自動的に開始します。
The SDK attempts to forward payments even if its network status is offline. This means your connection token provider might receive a request to provide a connection token even when the device is offline.
If you power off your POS device too soon, your payments might not be forwarded. You can query Terminal.
to make sure your POS is online and can forward payments, and Terminal.
to check how many payments the Terminal SDK has to be forwarded.
決済をキャプチャーする
While offline, you can create PaymentIntents with captureMethod
set to automatic
.
After you confirm these PaymentIntents, they have a Succeeded
status instead of RequiresCapture
. Stripe automatically captures the payments after you forward them.
If you opt for manual capture, payments that are successfully forwarded and authorized require capture from your backend or application.
- To capture payments from your backend, use webhooks to listen for PaymentIntents with a
requires_
status.capture - To capture payments from your application, wait for your application to receive calls to
OfflineDelegate.
for each PaymentIntent as the SDK forwards it. A PaymentIntent is ready to capture if its status isdidForwardPayment RequiresCapture
and theofflineDetails
is null or has arequiresUpload
value ofNO
.
オフライン決済は、 SDK によって OfflineDelegate の didForwardPaymentIntent
で転送された後にキャプチャーします。
オフラインで回収した支払いを調べる
After authorization, you can use the PaymentIntents API to examine offline details on a payment. Access the payment method details on the latest Charge object on a PaymentIntent
to determine if it was collected offline.