Release 5.0.3

Author: HeyPouya

CHANGELOG.md

@@ -1,6 +1,17 @@
 # Changelog
 
 For more information, see the [README](https://github.com/sumup/Android-MerchantSDK/blob/master/README.md)
+## Version 5.0.3
+* [ADDED] Introduces "configureRetryPolicy()" in the payment builder to configure the retry policy when the result of a transaction can not be retrieved at the end of a transaction. (see dedicated section in README [here](https://github.com/sumup/sumup-android-sdk#retry-policy-configuration) for more)
+    * Both `pollingInterval` and `maxWaitingTime` should be provided in milliseconds.
+    * If `disableBackButton` is set to true, the Android device's back button will be disabled while the retry screen is shown.
+    * If `maxWaitingTime` elapses without a response, `SumUpAPI.ResultCode.ERROR_UNKNOWN_TRANSACTION_STATUS` will be returned.
+    * If `disableBackButton` is set to false, pressing the back button while the retry screen is displayed will also return `SumUpAPI.ResultCode.ERROR_UNKNOWN_TRANSACTION_STATUS`.
+    * If `pollingInterval` is greater than `maxWaitingTime`, the value of `maxWaitingTime` will be adjusted to match `pollingInterval`.
+    * If either `pollingInterval` or `maxWaitingTime` is passed as a negative value, it will default to 0.
+    * If `configureRetryPolicy()` is not called, the SDK will default to returning the `SumUpAPI.ResultCode.ERROR_TRANSACTION_FAILED` error code, and default values will be used while trying to get the status of the transaction.
+    * Default values are 2000 ms for the `pollingInterval` and 60000 ms for the `maxWaitingTime`.
+
 ## Version 5.0.2
 * [FIXED] An issue where successful transactions were returned without all the relevant information in the SumUpAPI.Response.TX_INFO object, e.g. the card type
 * [FIXED] A bug where initiating a checkout while the Card Reader payment method was disabled in the merchant settings resulted in a transaction failure. The SDK now enables it intrinsically

README.md

@@ -46,7 +46,7 @@ allprojects {
 Add the dependency to a module:
 
 ```groovy
-implementation 'com.sumup:merchant-sdk:5.0.2'
+implementation 'com.sumup:merchant-sdk:5.0.3'
 ```
 
 
@@ -138,6 +138,8 @@ Several response fields are available when the callback activity is called:
     * SumUpAPI.Response.ResultCode.ERROR_ALREADY_LOGGED_IN = 11
     * SumUpAPI.Response.ResultCode.ERROR_INVALID_AMOUNT_DECIMALS = 12
     * SumUpAPI.Response.ResultCode.ERROR_API_LEVEL_TOO_LOW = 13
+    * SumUpAPI.Response.ResultCode.ERROR_CARD_READER_SETTINGS_OFF = 14
+    * SumUpAPI.Response.ResultCode.ERROR_UNKNOWN_TRANSACTION_STATUS = 15
 * SumUpAPI.Response.MESSAGE
   * Type: String
   * Description: A human readable message describing the result of the payment
@@ -207,6 +209,24 @@ A tip amount can be prompted directly in the card reader by using `tipOnCardRead
 > Note: Not all card readers support this feature. To find out if the feature is supported for the last-saved card reader, you should always check `SumUpApi.isTipOnCardReaderAvailable()`. You must handle this case yourself in order to avoid no tip from being prompted.
 Please also note that if both `tip` and `tipOnCardReader` are called then only `tipOnCardReader` amount will be considered during checkout if available.
 
+#### Retry Policy Configuration
+The `configureRetryPolicy()` feature allows you to set custom retry parameters for transaction result retrieval, using `pollingInterval`, `maxWaitingTime`, and `disableBackButton`.
+* Parameters: Both `pollingInterval` and `maxWaitingTime` should be provided in milliseconds, with default values of 2000 ms and 60000 ms, respectively. Setting `disableBackButton` to true disables the back button during retries.
+* Timeout: If `maxWaitingTime` elapses with no result, the SDK returns `SumUpAPI.ResultCode.ERROR_UNKNOWN_TRANSACTION_STATUS`. Pressing the back button (if enabled) during retries will also trigger this error.
+* Adjustments: If `pollingInterval` exceeds `maxWaitingTime`, `maxWaitingTime` will automatically be adjusted to match. Negative values for either parameter default to 0.
+* Default: If `configureRetryPolicy()` is not used, the SDK defaults to returning `SumUpAPI.ResultCode.ERROR_TRANSACTION_FAILED`.
+
+##### Querying the Transaction Status
+When using the SumUp payment as shown below:
+
+```java
+SumupPayment.builder()
+...
+.foreignTransactionId(UUID.randomUUID().toString())
+.configureRetryPolicy(2000, 60000, true)
+.build();
+```
+If there are connectivity issues and the transaction status can not be retrieved, the API will return `ERROR_UNKNOWN_TRANSACTION_STATUS`. In such cases, you can query the transaction status by calling [SumUp transaction status API](https://developer.sumup.com/api/transactions/get) using the specified `foreignTransactionId`.
 
 #### Transaction identifier
 The `foreignTransactionID` identifier will be associated with the transaction and can be used to retrieve details related to the transaction. See [API documentation](https://developer.sumup.com/rest-api/#tag/Transactions) for details. Please make sure that this ID is unique within the scope of the SumUp merchant account and sub-accounts. It must not be longer than 128 characters.

app/build.gradle

@@ -8,7 +8,7 @@ android {
         minSdkVersion 26
         targetSdkVersion 33
         versionCode 1
-        versionName "5.0.2"
+        versionName "5.0.3"
     }
 
     packagingOptions {
@@ -35,7 +35,7 @@ android {
 dependencies {
     implementation 'com.google.android.gms:play-services-location:21.0.1'
 
-    implementation 'com.sumup:merchant-sdk:5.0.2'
+    implementation 'com.sumup:merchant-sdk:5.0.3'
 
     coreLibraryDesugaring "com.android.tools:desugar_jdk_libs:1.1.5"
 }

app/src/main/java/com/sumup/sdksampleapp/MainActivity.java

@@ -75,6 +75,7 @@ public void onClick(View v) {
                         .addAdditionalInfo("AccountId", "taxi0334")
                         .addAdditionalInfo("From", "Paris")
                         .addAdditionalInfo("To", "Berlin")
+                        .configureRetryPolicy(2000, 60000, true)
                         // optional: foreign transaction ID, must be unique!
                         .foreignTransactionId(UUID.randomUUID().toString()) // can not exceed 128 chars
                         .build();