From 615fb13c1ecc658ae75f4d07f54b11195b55ec17 Mon Sep 17 00:00:00 2001 From: AlexDLL31 Date: Thu, 16 Jul 2026 15:29:57 +0200 Subject: [PATCH 1/2] updated 2.29.0 with Next changes/fixes that were sitting on next and apply to 2.29.0 were added to the restendpoints and objects pages --- .../version-REST API 2.29.0/restendpoints.md | 11 ++- .../version-REST API 2.29.0/restobjects.md | 81 ++++++++++++++++++- 2 files changed, 85 insertions(+), 7 deletions(-) diff --git a/restapi_versioned_docs/version-REST API 2.29.0/restendpoints.md b/restapi_versioned_docs/version-REST API 2.29.0/restendpoints.md index 0734e2a..d57c2b7 100644 --- a/restapi_versioned_docs/version-REST API 2.29.0/restendpoints.md +++ b/restapi_versioned_docs/version-REST API 2.29.0/restendpoints.md @@ -1385,13 +1385,16 @@ This endpoint allows to Cancel/Void/Reverse a previous transaction without a rea | `Body: amount` Optional
*String* | Decimal amount in String, ISO 4217; Required for partial-reversals. *Only if your acquirer supports partial-reversals*. | | `Body: currency` Optional
*String* | Required for partial-reversals *Only if your acquirer supports partial-reversals*. | | `Body: messageReasonCode` Optional
*String* | default: CUSTOMER_CANCELLATION. See [allowed values](restobjects.md#messageReasonCode)| +| `Body: timestamp` Optional
*String* | Timestamp in `YYYYMMDDHHmmssSSS` format (17 characters). Defaults to the current server time when not provided. | **Returns** -| Response | Response Code | -| ----------- | ----------- | -| [DeferredTokenizationResponse](restobjects.md#deferredTokenizationResponse) | Response code 200. | -| **BadRequest** | Response code 400. Returned when the transaction type is not eligible for deferred tokenization. | +| Result | Notes | +| ------ | ----- | +| `200` | Reversal accepted and processed. Response body is a [ReversalResponse](restobjects.md#reversalResponse) object. | +| `400` | Business rule error from the gateway (for example, the transaction was already reversed, or a partial-reversal `amount` exceeds the original amount). Returned as `BadRequestError` with `error.code` and `error.details`. | +| `403` | Forbidden — the API key does not belong to a merchant. Partner keys are not accepted by this endpoint. | +| `422` | Payload validation error (`VALIDATION_FAILED`) — missing `originalGuid`, invalid `messageReasonCode` enum value, or invalid `currency` length. | **Code Example** diff --git a/restapi_versioned_docs/version-REST API 2.29.0/restobjects.md b/restapi_versioned_docs/version-REST API 2.29.0/restobjects.md index 12cd4a6..a5d5043 100644 --- a/restapi_versioned_docs/version-REST API 2.29.0/restobjects.md +++ b/restapi_versioned_docs/version-REST API 2.29.0/restobjects.md @@ -1052,11 +1052,11 @@ The exact shape is very similar across these operations; some fields (such as `o ## Reversal {#reversal} -### ViscusReversalRequest {#viscusReversalRequest} +### ReversalRequest {#reversalRequest} -`ViscusReversalRequest` Object +`ReversalRequest` Object -Object used by the [`POST /v1/reversal`](restendpoints#reversal-operations) endpoint to reverse any reversible transaction. Only `originalGuid` is required; all other fields are optional and default to sensible values when not provided. +Object used by the [`POST /v1/reversal`](restendpoints#reversal) endpoint to reverse any reversible transaction. Only `originalGuid` is required; all other fields are optional and default to sensible values when not provided. **Properties** @@ -1150,6 +1150,81 @@ curl --location --request POST 'https://cloud.handpoint.io/reversal' \ --- +### ReversalResponse {#reversalResponse} + +`ReversalResponse` Object + +Object returned by [`POST /v1/reversal`](restendpoints#reversal) when the reversal is accepted and processed by the gateway. + +**Properties** + +| Property | Description | +| -------- | ----------- | +| `httpStatus`
*String* | HTTP status code as returned by the gateway (for example, `"200"`). | +| `acquirerTid`
*String* | Acquirer terminal identifier used to process the reversal. | +| `agreementNumber`
*String* | Merchant agreement number used for the reversal. | +| `amount`
*String* | Amount that was reversed, in major units. Matches the original transaction amount for a full reversal, or the requested `amount` for a partial reversal. | +| `approvalCode`
*String* | Approval code returned by the issuer for the reversal. | +| `batchNumber`
*String* | Batch number the reversal was recorded against, provided the acquirer returns it. | +| `cardTypeName`
*String* | Card brand of the reversed transaction (for example, `"Visa"`). | +| `currency`
*String* | ISO 4217 3-character currency code of the reversed amount. | +| `customFields`
*Object* | Additional gateway metadata for the reversal, returned as an `entry` array of `{key, value}` pairs (for example, the applied `messageReasonCode` and `tenderType`). | +| `expiryDateMMYY`
*String* | Card expiry date in `MMYY` format. | +| `f25`
*String* | ISO 8583 field 25 (POS condition code) returned by the acquirer. | +| `issuerResponseCode`
*String* | Issuer response code for the reversal (for example, `"00"` for approved). | +| `issuerResponseText`
*String* | Human-readable description of the issuer response (for example, `"Successful"`). | +| `maskedCardNumber`
*String* | Masked PAN of the reversed transaction. | +| `serverDateTime`
*String* | Gateway server timestamp (`YYYYMMDDHHmmssSSS`) when the reversal was processed. | +| `terminalDateTime`
*String* | Terminal timestamp (`YYYYMMDDHHmmssSSS`), echoed back from the request or generated by the gateway when not provided. | +| `transactionReference`
*String* | `transactionReference` of the original transaction, echoed back for reconciliation. | +| `authorizationGuid`
*String* | GUID of the original authorization/sale being reversed. | +| `originalGuid`
*String* | GUID of the transaction that was reversed. Mirrors the `originalGuid` from the request. | +| `reversalGuid`
*String* | Unique identifier generated by the gateway for this reversal operation. | + +**Code example** + +```json +{ + "httpStatus": 200, + "acquirerTid": "ACQUIRER_TID", + "agreementNumber": "123456789010102", + "amount": "0.04", + "approvalCode": "123456", + "batchNumber": "123", + "cardTypeName": "Visa", + "currency": "USD", + "customFields": { + "entry": [ + { + "key": "messageReasonCode", + "value": "4000" + }, + { + "key": "tenderType", + "value": "Credit" + }, + { + "key": "issuerResponseCode", + "value": "00" + } + ] + }, + "expiryDateMMYY": "1027", + "f25": "4000", + "issuerResponseCode": "00", + "issuerResponseText": "Successful", + "maskedCardNumber": "************0936", + "serverDateTime": "20260709074155101", + "terminalDateTime": "20260709074155083", + "transactionReference": "ee47c0b5-ff0b-4847-977c-cb8b6c4a848c", + "authorizationGuid": "9db20c30-7b69-11f1-9754-81955277651b", + "originalGuid": "9db20c30-7b69-11f1-9754-81955277651b", + "reversalGuid": "a8534cd0-7b69-11f1-a47e-6df6451d705a" +} +``` + +--- + ## Batch {#batch} ### BatchCloseRequest {#batchCloseRequest} From 101ec12d54a65a3b9c51418d2dbfa97a8860c8ee Mon Sep 17 00:00:00 2001 From: AlexDLL31 Date: Mon, 27 Jul 2026 13:12:15 +0200 Subject: [PATCH 2/2] docs: fix Reversal/Sale/Refund docs, correct release-notes attribution, and repair dead anchors REST API (2.28.0 & 2.29.0): - Reversal (no-reader) endpoint: add info note clarifying that reversals through this endpoint are attributed to the original device in Analytics and won't appear in the Handpoint Payments App. - Sale and Refund (MOTO) endpoints: add 200 OK example response tabs. - MOTO Reversal: remove the incorrect "Optional merchant references: customerReference, transactionReference" line - MotoReversalRequest does not support these fields. - Release notes: move the "Reversal without reader" feature entry to a new 2.28.0 section, since that's the version it actually shipped in, and note that batchNumber is now optional on POST /close in 2.29.0. Windows SDK (all versions, 3.2.0 through current): - Fix #status-info anchor to match the real statusInfo heading ID (kept the legacy kebab-case form in 3.2.0, the one version whose heading has no explicit anchor and still relies on the auto-slug). - Fix OperationStartResul typo (missing trailing "t") to OperationStartResult in windowstransactions.md. - Remove two dead self-page anchor links (#7 on ConnectionStatusChanged, #11 on TransactionResultReady) that pointed to nonexistent legacy numbered anchors; kept the surrounding text, just de-linked it. Android SDK (all versions with the section): - Add the missing {#cloudTokenizedPaymentsOperations} anchor to the "Cloud Tokenized Payments Operations" heading, fixing a broken cross-plugin anchor referenced from the Windows, JavaScript, and REST API docs. yarn build passes with no new broken links/anchors introduced. Co-Authored-By: Claude Sonnet 5 --- android/androidtransactions.md | 2 +- .../androidtransactions.md | 2 +- .../androidtransactions.md | 2 +- .../androidtransactions.md | 2 +- .../androidtransactions.md | 2 +- .../androidtransactions.md | 2 +- .../androidtransactions.md | 2 +- .../androidtransactions.md | 2 +- .../androidtransactions.md | 2 +- .../androidtransactions.md | 2 +- .../androidtransactions.md | 2 +- .../version-REST API 2.28.0/restendpoints.md | 54 ++++++++++++++++++- .../restreleasenotes.md | 5 ++ .../version-REST API 2.29.0/restendpoints.md | 54 ++++++++++++++++++- .../restreleasenotes.md | 11 +++- windows/windowsintegrationguide.md | 4 +- windows/windowsobjects.md | 2 +- windows/windowstransactions.md | 10 ++-- .../windowsintegrationguide.md | 4 +- .../windowsobjects.md | 2 +- .../windowsintegrationguide.md | 4 +- .../windowsobjects.md | 2 +- .../windowstransactions.md | 2 +- .../windowsintegrationguide.md | 4 +- .../windowsobjects.md | 2 +- .../windowstransactions.md | 2 +- .../windowsintegrationguide.md | 6 +-- .../windowsobjects.md | 2 +- .../windowstransactions.md | 2 +- .../windowsintegrationguide.md | 4 +- .../windowsobjects.md | 2 +- .../windowstransactions.md | 2 +- .../windowsintegrationguide.md | 4 +- .../windowsobjects.md | 2 +- .../windowstransactions.md | 2 +- .../windowsintegrationguide.md | 4 +- .../windowsobjects.md | 2 +- .../windowstransactions.md | 10 ++-- .../windowsintegrationguide.md | 4 +- .../windowsobjects.md | 2 +- .../windowstransactions.md | 10 ++-- .../windowsintegrationguide.md | 4 +- .../windowsobjects.md | 2 +- .../windowstransactions.md | 10 ++-- .../windowsintegrationguide.md | 4 +- .../windowsobjects.md | 2 +- .../windowstransactions.md | 10 ++-- 47 files changed, 195 insertions(+), 79 deletions(-) diff --git a/android/androidtransactions.md b/android/androidtransactions.md index 7df8589..e12dd80 100644 --- a/android/androidtransactions.md +++ b/android/androidtransactions.md @@ -1334,7 +1334,7 @@ The **`tokenizedOperation`** method allows integrators to provide a specific ope --- -## Cloud Tokenized Payments Operations +## Cloud Tokenized Payments Operations{#cloudTokenizedPaymentsOperations} `cloudTokenizedPaymentsOperations` diff --git a/android_versioned_docs/version-Android SDK 7.1009.5/androidtransactions.md b/android_versioned_docs/version-Android SDK 7.1009.5/androidtransactions.md index 806c3ab..c5ba101 100644 --- a/android_versioned_docs/version-Android SDK 7.1009.5/androidtransactions.md +++ b/android_versioned_docs/version-Android SDK 7.1009.5/androidtransactions.md @@ -1334,7 +1334,7 @@ The **`tokenizedOperation`** method allows integrators to provide a specific ope --- -## Cloud Tokenized Payments Operations +## Cloud Tokenized Payments Operations{#cloudTokenizedPaymentsOperations} `cloudTokenizedPaymentsOperations` diff --git a/android_versioned_docs/version-Android SDK 7.1010.1/androidtransactions.md b/android_versioned_docs/version-Android SDK 7.1010.1/androidtransactions.md index 7df8589..e12dd80 100644 --- a/android_versioned_docs/version-Android SDK 7.1010.1/androidtransactions.md +++ b/android_versioned_docs/version-Android SDK 7.1010.1/androidtransactions.md @@ -1334,7 +1334,7 @@ The **`tokenizedOperation`** method allows integrators to provide a specific ope --- -## Cloud Tokenized Payments Operations +## Cloud Tokenized Payments Operations{#cloudTokenizedPaymentsOperations} `cloudTokenizedPaymentsOperations` diff --git a/android_versioned_docs/version-Android SDK 7.1010.2/androidtransactions.md b/android_versioned_docs/version-Android SDK 7.1010.2/androidtransactions.md index 7df8589..e12dd80 100644 --- a/android_versioned_docs/version-Android SDK 7.1010.2/androidtransactions.md +++ b/android_versioned_docs/version-Android SDK 7.1010.2/androidtransactions.md @@ -1334,7 +1334,7 @@ The **`tokenizedOperation`** method allows integrators to provide a specific ope --- -## Cloud Tokenized Payments Operations +## Cloud Tokenized Payments Operations{#cloudTokenizedPaymentsOperations} `cloudTokenizedPaymentsOperations` diff --git a/android_versioned_docs/version-Android SDK 7.1010.3/androidtransactions.md b/android_versioned_docs/version-Android SDK 7.1010.3/androidtransactions.md index 7df8589..e12dd80 100644 --- a/android_versioned_docs/version-Android SDK 7.1010.3/androidtransactions.md +++ b/android_versioned_docs/version-Android SDK 7.1010.3/androidtransactions.md @@ -1334,7 +1334,7 @@ The **`tokenizedOperation`** method allows integrators to provide a specific ope --- -## Cloud Tokenized Payments Operations +## Cloud Tokenized Payments Operations{#cloudTokenizedPaymentsOperations} `cloudTokenizedPaymentsOperations` diff --git a/android_versioned_docs/version-Android SDK 7.1010.5/androidtransactions.md b/android_versioned_docs/version-Android SDK 7.1010.5/androidtransactions.md index 7df8589..e12dd80 100644 --- a/android_versioned_docs/version-Android SDK 7.1010.5/androidtransactions.md +++ b/android_versioned_docs/version-Android SDK 7.1010.5/androidtransactions.md @@ -1334,7 +1334,7 @@ The **`tokenizedOperation`** method allows integrators to provide a specific ope --- -## Cloud Tokenized Payments Operations +## Cloud Tokenized Payments Operations{#cloudTokenizedPaymentsOperations} `cloudTokenizedPaymentsOperations` diff --git a/android_versioned_docs/version-Android SDK 7.1010.6/androidtransactions.md b/android_versioned_docs/version-Android SDK 7.1010.6/androidtransactions.md index 7df8589..e12dd80 100644 --- a/android_versioned_docs/version-Android SDK 7.1010.6/androidtransactions.md +++ b/android_versioned_docs/version-Android SDK 7.1010.6/androidtransactions.md @@ -1334,7 +1334,7 @@ The **`tokenizedOperation`** method allows integrators to provide a specific ope --- -## Cloud Tokenized Payments Operations +## Cloud Tokenized Payments Operations{#cloudTokenizedPaymentsOperations} `cloudTokenizedPaymentsOperations` diff --git a/android_versioned_docs/version-Android SDK 7.1010.7/androidtransactions.md b/android_versioned_docs/version-Android SDK 7.1010.7/androidtransactions.md index 7df8589..e12dd80 100644 --- a/android_versioned_docs/version-Android SDK 7.1010.7/androidtransactions.md +++ b/android_versioned_docs/version-Android SDK 7.1010.7/androidtransactions.md @@ -1334,7 +1334,7 @@ The **`tokenizedOperation`** method allows integrators to provide a specific ope --- -## Cloud Tokenized Payments Operations +## Cloud Tokenized Payments Operations{#cloudTokenizedPaymentsOperations} `cloudTokenizedPaymentsOperations` diff --git a/android_versioned_docs/version-Android SDK 7.1010.8/androidtransactions.md b/android_versioned_docs/version-Android SDK 7.1010.8/androidtransactions.md index 7df8589..e12dd80 100644 --- a/android_versioned_docs/version-Android SDK 7.1010.8/androidtransactions.md +++ b/android_versioned_docs/version-Android SDK 7.1010.8/androidtransactions.md @@ -1334,7 +1334,7 @@ The **`tokenizedOperation`** method allows integrators to provide a specific ope --- -## Cloud Tokenized Payments Operations +## Cloud Tokenized Payments Operations{#cloudTokenizedPaymentsOperations} `cloudTokenizedPaymentsOperations` diff --git a/android_versioned_docs/version-Android SDK 7.1011.0/androidtransactions.md b/android_versioned_docs/version-Android SDK 7.1011.0/androidtransactions.md index ce69acd..e80782d 100644 --- a/android_versioned_docs/version-Android SDK 7.1011.0/androidtransactions.md +++ b/android_versioned_docs/version-Android SDK 7.1011.0/androidtransactions.md @@ -1355,7 +1355,7 @@ The **`tokenizedOperation`** method allows integrators to provide a specific ope --- -## Cloud Tokenized Payments Operations +## Cloud Tokenized Payments Operations{#cloudTokenizedPaymentsOperations} `cloudTokenizedPaymentsOperations` diff --git a/android_versioned_docs/version-Android SDK 7.1012.3/androidtransactions.md b/android_versioned_docs/version-Android SDK 7.1012.3/androidtransactions.md index 7df8589..e12dd80 100644 --- a/android_versioned_docs/version-Android SDK 7.1012.3/androidtransactions.md +++ b/android_versioned_docs/version-Android SDK 7.1012.3/androidtransactions.md @@ -1334,7 +1334,7 @@ The **`tokenizedOperation`** method allows integrators to provide a specific ope --- -## Cloud Tokenized Payments Operations +## Cloud Tokenized Payments Operations{#cloudTokenizedPaymentsOperations} `cloudTokenizedPaymentsOperations` diff --git a/restapi_versioned_docs/version-REST API 2.28.0/restendpoints.md b/restapi_versioned_docs/version-REST API 2.28.0/restendpoints.md index 3902c58..e07789a 100644 --- a/restapi_versioned_docs/version-REST API 2.28.0/restendpoints.md +++ b/restapi_versioned_docs/version-REST API 2.28.0/restendpoints.md @@ -1375,6 +1375,10 @@ curl -X GET \ This endpoint allows to Cancel/Void/Reverse a previous transaction without a reader. +:::info +Note that any reversal using this endpoint will be associated in Analytics to the original device, and this transaction won't show in the Handpoint Payments App (since it's not processed by the App in the Payment Device) +::: + **Parameters** | Parameter | Notes | @@ -1926,6 +1930,30 @@ curl -X POST \ **Responses** + + +```json +{ + "@type": "sale", + "httpStatus": 200, + "acquirerTid": "VT000000023751", + "amount": "20.00", + "approvalCode": "TAS075", + "batchNumber": "1", + "cardTypeName": "MASTERCARD", + "currency": "USD", + "expiryDateMMYY": "1225", + "guid": "65289350-631f-11f1-9e88-671da9fb0fb7", + "issuerResponseCode": "00", + "issuerResponseText": "APPROVAL", + "maskedCardNumber": "************5439", + "serverDateTime": "20260608094951749", + "terminalDateTime": "20260608094951000" +} +``` + + + ```json @@ -2056,6 +2084,31 @@ curl -X POST \ **Responses** + + +```json +{ + "@type": "refund", + "httpStatus": 200, + "acquirerTid": "123456789", + "amount": "11.00", + "approvalCode": "123456", + "cardTypeName": "Visa", + "currency": "EUR", + "expiryDateMMYY": "0529", + "guid": "ad16fbc0-8764-11f1-a47e-6df6451d705a", + "issuerResponseCode": "00", + "issuerResponseText": "Approved or completed successfully", + "maskedCardNumber": "************1234", + "serverDateTime": "20260724133629564", + "terminalDateTime": "20260724133629000", + "transactionReference": "941d6f18-a65e-4f9e-bca3-9f4423bc4a9b", + "originalGuid": "1a41d9f0-cf72-11f0-95b2-770b7d1d8e67" +} +``` + + + ```json @@ -2128,7 +2181,6 @@ Typical fields (see [MotoReversalRequest](restobjects#motoReversalRequest) for f * `originalGuid` Required – GUID of the original sale to be reversed. * `amount` Required – String amount to reverse in MAJOR units (e.g. `"20.00"` for $20.00). Must be a positive integer string. * `currency` Optional – 3-character ISO 4217 code; if provided, must respect `minLength = 3`, `maxLength = 3` and may need to match the original transaction’s currency. -* Optional merchant references: `customerReference`, `transactionReference`. #### Returns diff --git a/restapi_versioned_docs/version-REST API 2.28.0/restreleasenotes.md b/restapi_versioned_docs/version-REST API 2.28.0/restreleasenotes.md index 3a34bc8..f8d911c 100644 --- a/restapi_versioned_docs/version-REST API 2.28.0/restreleasenotes.md +++ b/restapi_versioned_docs/version-REST API 2.28.0/restreleasenotes.md @@ -9,6 +9,11 @@ id: restreleasenotes Don’t miss any updates on our latest releases. Contact your Handpoint relationship manager to subscribe to the Handpoint Newsletter! ::: +## 2.28.0 +**Features:** + +New Endpoint without reader for /Reversal allowing more operations that don't require the card to be present to be performed without going through the reader. + ## 2.27.0 **Features:** diff --git a/restapi_versioned_docs/version-REST API 2.29.0/restendpoints.md b/restapi_versioned_docs/version-REST API 2.29.0/restendpoints.md index d57c2b7..7370952 100644 --- a/restapi_versioned_docs/version-REST API 2.29.0/restendpoints.md +++ b/restapi_versioned_docs/version-REST API 2.29.0/restendpoints.md @@ -1376,6 +1376,10 @@ curl -X GET \ This endpoint allows to Cancel/Void/Reverse a previous transaction without a reader. +:::info +Note that any reversal using this endpoint will be associated in Analytics to the original device, and this transaction won't show in the Handpoint Payments App (since it's not processed by the App in the Payment Device) +::: + **Parameters** | Parameter | Notes | @@ -1930,6 +1934,30 @@ curl -X POST \ **Responses** + + +```json +{ + "@type": "sale", + "httpStatus": 200, + "acquirerTid": "VT000000023751", + "amount": "20.00", + "approvalCode": "TAS075", + "batchNumber": "1", + "cardTypeName": "MASTERCARD", + "currency": "USD", + "expiryDateMMYY": "1225", + "guid": "65289350-631f-11f1-9e88-671da9fb0fb7", + "issuerResponseCode": "00", + "issuerResponseText": "APPROVAL", + "maskedCardNumber": "************5439", + "serverDateTime": "20260608094951749", + "terminalDateTime": "20260608094951000" +} +``` + + + ```json @@ -2060,6 +2088,31 @@ curl -X POST \ **Responses** + + +```json +{ + "@type": "refund", + "httpStatus": 200, + "acquirerTid": "123456789", + "amount": "11.00", + "approvalCode": "123456", + "cardTypeName": "Visa", + "currency": "EUR", + "expiryDateMMYY": "0529", + "guid": "ad16fbc0-8764-11f1-a47e-6df6451d705a", + "issuerResponseCode": "00", + "issuerResponseText": "Approved or completed successfully", + "maskedCardNumber": "************1234", + "serverDateTime": "20260724133629564", + "terminalDateTime": "20260724133629000", + "transactionReference": "941d6f18-a65e-4f9e-bca3-9f4423bc4a9b", + "originalGuid": "1a41d9f0-cf72-11f0-95b2-770b7d1d8e67" +} +``` + + + ```json @@ -2132,7 +2185,6 @@ Typical fields (see [MotoReversalRequest](restobjects#motoReversalRequest) for f * `originalGuid` Required – GUID of the original sale to be reversed. * `amount` Required – String amount to reverse in MAJOR units (e.g. `"20.00"` for $20.00). Must be a positive integer string. * `currency` Optional – 3-character ISO 4217 code; if provided, must respect `minLength = 3`, `maxLength = 3` and may need to match the original transaction’s currency. -* Optional merchant references: `customerReference`, `transactionReference`. #### Returns diff --git a/restapi_versioned_docs/version-REST API 2.29.0/restreleasenotes.md b/restapi_versioned_docs/version-REST API 2.29.0/restreleasenotes.md index 964daf1..734e4a4 100644 --- a/restapi_versioned_docs/version-REST API 2.29.0/restreleasenotes.md +++ b/restapi_versioned_docs/version-REST API 2.29.0/restreleasenotes.md @@ -10,9 +10,16 @@ Don’t miss any updates on our latest releases. Contact your Handpoint relation ::: ## 2.29.0 +**Changes:** + +`NoTransactionToCancel` error (error code `1005`) is now returned from [`POST /transactions`](restendpoints.md#operation-requests) when a `stopCurrentTransaction` operation is attempted but there is no transaction currently in progress to cancel. Previously this case was reported as the generic `CancelOperationNotAllowed` error (`1003`). + +Change on the batch /close endpoint where batchNumber parameter is now *optional* + +## 2.28.0 **Features:** -New `NoTransactionToCancel` error (error code `1005`) is now returned from [`POST /transactions`](restendpoints.md#operation-requests) when a `stopCurrentTransaction` operation is attempted but there is no transaction currently in progress to cancel. Previously this case was reported as the generic `CancelOperationNotAllowed` error (`1003`). +New Endpoint without reader for /Reversal allowing more operations that don't require the card to be present to be performed without going through the reader. ## 2.27.0 **Features:** @@ -163,4 +170,4 @@ The new `duplicate_check` parameter is available under the [Transaction Request ## 2.4.0 **Features:** -- Transaction result retrieval through API endpoint GET .../transaction-result/\{transactionResultId\} +- Transaction result retrieval through API endpoint GET .../transaction-result/\{transactionResultId\} \ No newline at end of file diff --git a/windows/windowsintegrationguide.md b/windows/windowsintegrationguide.md index ef1e4fe..5b9888c 100644 --- a/windows/windowsintegrationguide.md +++ b/windows/windowsintegrationguide.md @@ -440,7 +440,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **1. Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) @@ -1149,7 +1149,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) diff --git a/windows/windowsobjects.md b/windows/windowsobjects.md index 311e005..5a5ba1c 100644 --- a/windows/windowsobjects.md +++ b/windows/windowsobjects.md @@ -247,7 +247,7 @@ A static class containing information about the current status of the SDK |`inTransaction`
*bool* |Checks whether the SDK is in transaction or not. True if the SDK is in transaction, false otherwise. This might return a true if there is a communication error between the SDK and payment terminal but the transaction has been completed on the card reader.| |`SdkVersion`
*String* |Gets the current Sdk version.| |`IsTransactionResultPending`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This function checks if there is a pending [*Transaction Result*](#14). This field is only updated when connecting to a device. If this function returns true the [*Transaction Result*](#14) (which includes the receipt) can be fetched with hapi.GetPendingTransactionResult();. This function serves the same functionality as the event PendingTransactionResult(Device device), so every time that event is invoked, HapiManager.IsTransactionResultPending() is true until the result is fetched.| -|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via [*TransactionResultReady*](#11). The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| +|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via *TransactionResultReady*. The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| **Code example** diff --git a/windows/windowstransactions.md b/windows/windowstransactions.md index c013743..e930807 100644 --- a/windows/windowstransactions.md +++ b/windows/windowstransactions.md @@ -610,7 +610,7 @@ This event is invoked when the transaction is completed, it contains the transac `StopCurrentTransaction` Method -This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#status-info) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. +This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#statusInfo) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. **Code example** @@ -688,7 +688,7 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| ## Pre-Auth Increase/Decrease @@ -746,7 +746,7 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| ## Pre-Auth Capture @@ -882,7 +882,7 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| ## Pre-Auth/Capture Reversal @@ -935,4 +935,4 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| diff --git a/windows_versioned_docs/version-Windows SDK 3.2.0/windowsintegrationguide.md b/windows_versioned_docs/version-Windows SDK 3.2.0/windowsintegrationguide.md index 084322c..1755397 100644 --- a/windows_versioned_docs/version-Windows SDK 3.2.0/windowsintegrationguide.md +++ b/windows_versioned_docs/version-Windows SDK 3.2.0/windowsintegrationguide.md @@ -407,7 +407,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) @@ -1078,7 +1078,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **1. Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) diff --git a/windows_versioned_docs/version-Windows SDK 3.2.0/windowsobjects.md b/windows_versioned_docs/version-Windows SDK 3.2.0/windowsobjects.md index d8acf1a..e8a1861 100644 --- a/windows_versioned_docs/version-Windows SDK 3.2.0/windowsobjects.md +++ b/windows_versioned_docs/version-Windows SDK 3.2.0/windowsobjects.md @@ -509,7 +509,7 @@ A static class containing information about the current status of the SDK |`inTransaction`
*bool* |Checks whether the SDK is in transaction or not. True if the SDK is in transaction, false otherwise. This might return a true if there is a communication error between the SDK and card reader but the transaction has been completed on the card reader.| |`SdkVersion`
*String* |Gets the current Sdk version.| |`IsTransactionResultPending`
*boolean* |In the case of a communication failure between the device and the API a [*Transaction Result*](#14) might have not been delivered to the API. This function checks if there is a pending [*Transaction Result*](#14). This field is only updated when connecting to a device. If this function returns true the [*Transaction Result*](#14) (which includes the receipt) can be fetched with hapi.GetPendingTransactionResult();. This function serves the same functionality as the event PendingTransactionResult(Device device), so every time that event is invoked, HapiManager.IsTransactionResultPending() is true until the result is fetched.| -|`Settings.AutoRecoverTransactionResult`
*boolean* |In the case of a communication failure between the device and the API a [*Transaction Result*](#14) might have not been delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via **[*TransactionResultReady*](#11)**. The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| +|`Settings.AutoRecoverTransactionResult`
*boolean* |In the case of a communication failure between the device and the API a [*Transaction Result*](#14) might have not been delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via **TransactionResultReady**. The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| **Code example** diff --git a/windows_versioned_docs/version-Windows SDK 3.2.4/windowsintegrationguide.md b/windows_versioned_docs/version-Windows SDK 3.2.4/windowsintegrationguide.md index 0dc7ece..4148163 100644 --- a/windows_versioned_docs/version-Windows SDK 3.2.4/windowsintegrationguide.md +++ b/windows_versioned_docs/version-Windows SDK 3.2.4/windowsintegrationguide.md @@ -407,7 +407,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **1. Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) @@ -1097,7 +1097,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) diff --git a/windows_versioned_docs/version-Windows SDK 3.2.4/windowsobjects.md b/windows_versioned_docs/version-Windows SDK 3.2.4/windowsobjects.md index 072a7a6..6add340 100644 --- a/windows_versioned_docs/version-Windows SDK 3.2.4/windowsobjects.md +++ b/windows_versioned_docs/version-Windows SDK 3.2.4/windowsobjects.md @@ -501,7 +501,7 @@ A static class containing information about the current status of the SDK |`inTransaction`
*bool* |Checks whether the SDK is in transaction or not. True if the SDK is in transaction, false otherwise. This might return a true if there is a communication error between the SDK and payment terminal but the transaction has been completed on the card reader.| |`SdkVersion`
*String* |Gets the current Sdk version.| |`IsTransactionResultPending`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This function checks if there is a pending [*Transaction Result*](#14). This field is only updated when connecting to a device. If this function returns true the [*Transaction Result*](#14) (which includes the receipt) can be fetched with hapi.GetPendingTransactionResult();. This function serves the same functionality as the event PendingTransactionResult(Device device), so every time that event is invoked, HapiManager.IsTransactionResultPending() is true until the result is fetched.| -|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via [*TransactionResultReady*](#11). The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| +|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via *TransactionResultReady*. The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| **Code example** diff --git a/windows_versioned_docs/version-Windows SDK 3.2.4/windowstransactions.md b/windows_versioned_docs/version-Windows SDK 3.2.4/windowstransactions.md index ad1653b..b7b55ab 100644 --- a/windows_versioned_docs/version-Windows SDK 3.2.4/windowstransactions.md +++ b/windows_versioned_docs/version-Windows SDK 3.2.4/windowstransactions.md @@ -530,7 +530,7 @@ This event is invoked when the transaction is completed, it contains the transac `StopCurrentTransaction` Method -This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#status-info) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. +This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#statusInfo) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. **Code example** diff --git a/windows_versioned_docs/version-Windows SDK 3.2.5/windowsintegrationguide.md b/windows_versioned_docs/version-Windows SDK 3.2.5/windowsintegrationguide.md index 86b64f0..7049f42 100644 --- a/windows_versioned_docs/version-Windows SDK 3.2.5/windowsintegrationguide.md +++ b/windows_versioned_docs/version-Windows SDK 3.2.5/windowsintegrationguide.md @@ -407,7 +407,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **1. Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) @@ -1097,7 +1097,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) diff --git a/windows_versioned_docs/version-Windows SDK 3.2.5/windowsobjects.md b/windows_versioned_docs/version-Windows SDK 3.2.5/windowsobjects.md index e3de453..b46e3d9 100644 --- a/windows_versioned_docs/version-Windows SDK 3.2.5/windowsobjects.md +++ b/windows_versioned_docs/version-Windows SDK 3.2.5/windowsobjects.md @@ -501,7 +501,7 @@ A static class containing information about the current status of the SDK |`inTransaction`
*bool* |Checks whether the SDK is in transaction or not. True if the SDK is in transaction, false otherwise. This might return a true if there is a communication error between the SDK and payment terminal but the transaction has been completed on the card reader.| |`SdkVersion`
*String* |Gets the current Sdk version.| |`IsTransactionResultPending`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This function checks if there is a pending [*Transaction Result*](#14). This field is only updated when connecting to a device. If this function returns true the [*Transaction Result*](#14) (which includes the receipt) can be fetched with hapi.GetPendingTransactionResult();. This function serves the same functionality as the event PendingTransactionResult(Device device), so every time that event is invoked, HapiManager.IsTransactionResultPending() is true until the result is fetched.| -|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via [*TransactionResultReady*](#11). The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| +|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via *TransactionResultReady*. The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| **Code example** diff --git a/windows_versioned_docs/version-Windows SDK 3.2.5/windowstransactions.md b/windows_versioned_docs/version-Windows SDK 3.2.5/windowstransactions.md index ad1653b..b7b55ab 100644 --- a/windows_versioned_docs/version-Windows SDK 3.2.5/windowstransactions.md +++ b/windows_versioned_docs/version-Windows SDK 3.2.5/windowstransactions.md @@ -530,7 +530,7 @@ This event is invoked when the transaction is completed, it contains the transac `StopCurrentTransaction` Method -This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#status-info) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. +This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#statusInfo) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. **Code example** diff --git a/windows_versioned_docs/version-Windows SDK 3.3.0/windowsintegrationguide.md b/windows_versioned_docs/version-Windows SDK 3.3.0/windowsintegrationguide.md index 1af836e..1bca0d5 100644 --- a/windows_versioned_docs/version-Windows SDK 3.3.0/windowsintegrationguide.md +++ b/windows_versioned_docs/version-Windows SDK 3.3.0/windowsintegrationguide.md @@ -407,7 +407,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **1. Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) @@ -544,7 +544,7 @@ namespace GettingStartedApp api.Disconnect(); } - public void **[*ConnectionStatusChanged*](#7)**(ConnectionStatus status, Device device) + public void ***ConnectionStatusChanged***(ConnectionStatus status, Device device) { Console.WriteLine("***ConnectionStatus*** " + status); if (status == ConnectionStatus.Connected) @@ -1097,7 +1097,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) diff --git a/windows_versioned_docs/version-Windows SDK 3.3.0/windowsobjects.md b/windows_versioned_docs/version-Windows SDK 3.3.0/windowsobjects.md index 9779e51..844d1cf 100644 --- a/windows_versioned_docs/version-Windows SDK 3.3.0/windowsobjects.md +++ b/windows_versioned_docs/version-Windows SDK 3.3.0/windowsobjects.md @@ -502,7 +502,7 @@ A static class containing information about the current status of the SDK |`inTransaction`
*bool* |Checks whether the SDK is in transaction or not. True if the SDK is in transaction, false otherwise. This might return a true if there is a communication error between the SDK and payment terminal but the transaction has been completed on the card reader.| |`SdkVersion`
*String* |Gets the current Sdk version.| |`IsTransactionResultPending`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This function checks if there is a pending [*Transaction Result*](#14). This field is only updated when connecting to a device. If this function returns true the [*Transaction Result*](#14) (which includes the receipt) can be fetched with hapi.GetPendingTransactionResult();. This function serves the same functionality as the event PendingTransactionResult(Device device), so every time that event is invoked, HapiManager.IsTransactionResultPending() is true until the result is fetched.| -|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via [*TransactionResultReady*](#11). The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| +|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via *TransactionResultReady*. The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| **Code example** diff --git a/windows_versioned_docs/version-Windows SDK 3.3.0/windowstransactions.md b/windows_versioned_docs/version-Windows SDK 3.3.0/windowstransactions.md index b0c7281..70959eb 100644 --- a/windows_versioned_docs/version-Windows SDK 3.3.0/windowstransactions.md +++ b/windows_versioned_docs/version-Windows SDK 3.3.0/windowstransactions.md @@ -534,7 +534,7 @@ This event is invoked when the transaction is completed, it contains the transac `StopCurrentTransaction` Method -This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#status-info) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. +This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#statusInfo) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. **Code example** diff --git a/windows_versioned_docs/version-Windows SDK 3.4.0/windowsintegrationguide.md b/windows_versioned_docs/version-Windows SDK 3.4.0/windowsintegrationguide.md index 81140e7..a9a0968 100644 --- a/windows_versioned_docs/version-Windows SDK 3.4.0/windowsintegrationguide.md +++ b/windows_versioned_docs/version-Windows SDK 3.4.0/windowsintegrationguide.md @@ -406,7 +406,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **1. Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) @@ -1096,7 +1096,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) diff --git a/windows_versioned_docs/version-Windows SDK 3.4.0/windowsobjects.md b/windows_versioned_docs/version-Windows SDK 3.4.0/windowsobjects.md index 8dee292..8ced119 100644 --- a/windows_versioned_docs/version-Windows SDK 3.4.0/windowsobjects.md +++ b/windows_versioned_docs/version-Windows SDK 3.4.0/windowsobjects.md @@ -517,7 +517,7 @@ A static class containing information about the current status of the SDK |`inTransaction`
*bool* |Checks whether the SDK is in transaction or not. True if the SDK is in transaction, false otherwise. This might return a true if there is a communication error between the SDK and payment terminal but the transaction has been completed on the card reader.| |`SdkVersion`
*String* |Gets the current Sdk version.| |`IsTransactionResultPending`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This function checks if there is a pending [*Transaction Result*](#14). This field is only updated when connecting to a device. If this function returns true the [*Transaction Result*](#14) (which includes the receipt) can be fetched with hapi.GetPendingTransactionResult();. This function serves the same functionality as the event PendingTransactionResult(Device device), so every time that event is invoked, HapiManager.IsTransactionResultPending() is true until the result is fetched.| -|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via [*TransactionResultReady*](#11). The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| +|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via *TransactionResultReady*. The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| **Code example** diff --git a/windows_versioned_docs/version-Windows SDK 3.4.0/windowstransactions.md b/windows_versioned_docs/version-Windows SDK 3.4.0/windowstransactions.md index 4b42a92..c523f4d 100644 --- a/windows_versioned_docs/version-Windows SDK 3.4.0/windowstransactions.md +++ b/windows_versioned_docs/version-Windows SDK 3.4.0/windowstransactions.md @@ -535,7 +535,7 @@ This event is invoked when the transaction is completed, it contains the transac `StopCurrentTransaction` Method -This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#status-info) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. +This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#statusInfo) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. **Code example** diff --git a/windows_versioned_docs/version-Windows SDK 4.0.0/windowsintegrationguide.md b/windows_versioned_docs/version-Windows SDK 4.0.0/windowsintegrationguide.md index 73ab293..fee9c0f 100644 --- a/windows_versioned_docs/version-Windows SDK 4.0.0/windowsintegrationguide.md +++ b/windows_versioned_docs/version-Windows SDK 4.0.0/windowsintegrationguide.md @@ -439,7 +439,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **1. Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) @@ -1148,7 +1148,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) diff --git a/windows_versioned_docs/version-Windows SDK 4.0.0/windowsobjects.md b/windows_versioned_docs/version-Windows SDK 4.0.0/windowsobjects.md index a3af3db..94b6187 100644 --- a/windows_versioned_docs/version-Windows SDK 4.0.0/windowsobjects.md +++ b/windows_versioned_docs/version-Windows SDK 4.0.0/windowsobjects.md @@ -522,7 +522,7 @@ A static class containing information about the current status of the SDK |`inTransaction`
*bool* |Checks whether the SDK is in transaction or not. True if the SDK is in transaction, false otherwise. This might return a true if there is a communication error between the SDK and payment terminal but the transaction has been completed on the card reader.| |`SdkVersion`
*String* |Gets the current Sdk version.| |`IsTransactionResultPending`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This function checks if there is a pending [*Transaction Result*](#14). This field is only updated when connecting to a device. If this function returns true the [*Transaction Result*](#14) (which includes the receipt) can be fetched with hapi.GetPendingTransactionResult();. This function serves the same functionality as the event PendingTransactionResult(Device device), so every time that event is invoked, HapiManager.IsTransactionResultPending() is true until the result is fetched.| -|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via [*TransactionResultReady*](#11). The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| +|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via *TransactionResultReady*. The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| **Code example** diff --git a/windows_versioned_docs/version-Windows SDK 4.0.0/windowstransactions.md b/windows_versioned_docs/version-Windows SDK 4.0.0/windowstransactions.md index 0d82746..cf2f94c 100644 --- a/windows_versioned_docs/version-Windows SDK 4.0.0/windowstransactions.md +++ b/windows_versioned_docs/version-Windows SDK 4.0.0/windowstransactions.md @@ -535,7 +535,7 @@ This event is invoked when the transaction is completed, it contains the transac `StopCurrentTransaction` Method -This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#status-info) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. +This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#statusInfo) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. **Code example** diff --git a/windows_versioned_docs/version-Windows SDK 4.1.0/windowsintegrationguide.md b/windows_versioned_docs/version-Windows SDK 4.1.0/windowsintegrationguide.md index ef1e4fe..5b9888c 100644 --- a/windows_versioned_docs/version-Windows SDK 4.1.0/windowsintegrationguide.md +++ b/windows_versioned_docs/version-Windows SDK 4.1.0/windowsintegrationguide.md @@ -440,7 +440,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **1. Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) @@ -1149,7 +1149,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) diff --git a/windows_versioned_docs/version-Windows SDK 4.1.0/windowsobjects.md b/windows_versioned_docs/version-Windows SDK 4.1.0/windowsobjects.md index 9a35feb..4b5f9a4 100644 --- a/windows_versioned_docs/version-Windows SDK 4.1.0/windowsobjects.md +++ b/windows_versioned_docs/version-Windows SDK 4.1.0/windowsobjects.md @@ -247,7 +247,7 @@ A static class containing information about the current status of the SDK |`inTransaction`
*bool* |Checks whether the SDK is in transaction or not. True if the SDK is in transaction, false otherwise. This might return a true if there is a communication error between the SDK and payment terminal but the transaction has been completed on the card reader.| |`SdkVersion`
*String* |Gets the current Sdk version.| |`IsTransactionResultPending`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This function checks if there is a pending [*Transaction Result*](#14). This field is only updated when connecting to a device. If this function returns true the [*Transaction Result*](#14) (which includes the receipt) can be fetched with hapi.GetPendingTransactionResult();. This function serves the same functionality as the event PendingTransactionResult(Device device), so every time that event is invoked, HapiManager.IsTransactionResultPending() is true until the result is fetched.| -|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via [*TransactionResultReady*](#11). The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| +|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via *TransactionResultReady*. The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| **Code example** diff --git a/windows_versioned_docs/version-Windows SDK 4.1.0/windowstransactions.md b/windows_versioned_docs/version-Windows SDK 4.1.0/windowstransactions.md index 664b792..8f68da8 100644 --- a/windows_versioned_docs/version-Windows SDK 4.1.0/windowstransactions.md +++ b/windows_versioned_docs/version-Windows SDK 4.1.0/windowstransactions.md @@ -579,7 +579,7 @@ This event is invoked when the transaction is completed, it contains the transac `StopCurrentTransaction` Method -This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#status-info) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. +This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#statusInfo) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. **Code example** @@ -657,7 +657,7 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| ## Pre-Auth Increase/Decrease @@ -715,7 +715,7 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| ## Pre-Auth Capture @@ -851,7 +851,7 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| ## Pre-Auth/Capture Reversal @@ -904,4 +904,4 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| diff --git a/windows_versioned_docs/version-Windows SDK 4.2.0/windowsintegrationguide.md b/windows_versioned_docs/version-Windows SDK 4.2.0/windowsintegrationguide.md index ef1e4fe..5b9888c 100644 --- a/windows_versioned_docs/version-Windows SDK 4.2.0/windowsintegrationguide.md +++ b/windows_versioned_docs/version-Windows SDK 4.2.0/windowsintegrationguide.md @@ -440,7 +440,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **1. Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) @@ -1149,7 +1149,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) diff --git a/windows_versioned_docs/version-Windows SDK 4.2.0/windowsobjects.md b/windows_versioned_docs/version-Windows SDK 4.2.0/windowsobjects.md index 647d6eb..5c61b1a 100644 --- a/windows_versioned_docs/version-Windows SDK 4.2.0/windowsobjects.md +++ b/windows_versioned_docs/version-Windows SDK 4.2.0/windowsobjects.md @@ -247,7 +247,7 @@ A static class containing information about the current status of the SDK |`inTransaction`
*bool* |Checks whether the SDK is in transaction or not. True if the SDK is in transaction, false otherwise. This might return a true if there is a communication error between the SDK and payment terminal but the transaction has been completed on the card reader.| |`SdkVersion`
*String* |Gets the current Sdk version.| |`IsTransactionResultPending`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This function checks if there is a pending [*Transaction Result*](#14). This field is only updated when connecting to a device. If this function returns true the [*Transaction Result*](#14) (which includes the receipt) can be fetched with hapi.GetPendingTransactionResult();. This function serves the same functionality as the event PendingTransactionResult(Device device), so every time that event is invoked, HapiManager.IsTransactionResultPending() is true until the result is fetched.| -|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via [*TransactionResultReady*](#11). The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| +|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via *TransactionResultReady*. The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| **Code example** diff --git a/windows_versioned_docs/version-Windows SDK 4.2.0/windowstransactions.md b/windows_versioned_docs/version-Windows SDK 4.2.0/windowstransactions.md index ae75618..0397ed5 100644 --- a/windows_versioned_docs/version-Windows SDK 4.2.0/windowstransactions.md +++ b/windows_versioned_docs/version-Windows SDK 4.2.0/windowstransactions.md @@ -605,7 +605,7 @@ This event is invoked when the transaction is completed, it contains the transac `StopCurrentTransaction` Method -This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#status-info) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. +This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#statusInfo) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. **Code example** @@ -683,7 +683,7 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| ## Pre-Auth Increase/Decrease @@ -741,7 +741,7 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| ## Pre-Auth Capture @@ -877,7 +877,7 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| ## Pre-Auth/Capture Reversal @@ -930,4 +930,4 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| diff --git a/windows_versioned_docs/version-Windows SDK 4.3.1/windowsintegrationguide.md b/windows_versioned_docs/version-Windows SDK 4.3.1/windowsintegrationguide.md index ef1e4fe..5b9888c 100644 --- a/windows_versioned_docs/version-Windows SDK 4.3.1/windowsintegrationguide.md +++ b/windows_versioned_docs/version-Windows SDK 4.3.1/windowsintegrationguide.md @@ -440,7 +440,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **1. Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) @@ -1149,7 +1149,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) diff --git a/windows_versioned_docs/version-Windows SDK 4.3.1/windowsobjects.md b/windows_versioned_docs/version-Windows SDK 4.3.1/windowsobjects.md index 3597a1a..ce67376 100644 --- a/windows_versioned_docs/version-Windows SDK 4.3.1/windowsobjects.md +++ b/windows_versioned_docs/version-Windows SDK 4.3.1/windowsobjects.md @@ -247,7 +247,7 @@ A static class containing information about the current status of the SDK |`inTransaction`
*bool* |Checks whether the SDK is in transaction or not. True if the SDK is in transaction, false otherwise. This might return a true if there is a communication error between the SDK and payment terminal but the transaction has been completed on the card reader.| |`SdkVersion`
*String* |Gets the current Sdk version.| |`IsTransactionResultPending`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This function checks if there is a pending [*Transaction Result*](#14). This field is only updated when connecting to a device. If this function returns true the [*Transaction Result*](#14) (which includes the receipt) can be fetched with hapi.GetPendingTransactionResult();. This function serves the same functionality as the event PendingTransactionResult(Device device), so every time that event is invoked, HapiManager.IsTransactionResultPending() is true until the result is fetched.| -|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via [*TransactionResultReady*](#11). The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| +|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via *TransactionResultReady*. The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| **Code example** diff --git a/windows_versioned_docs/version-Windows SDK 4.3.1/windowstransactions.md b/windows_versioned_docs/version-Windows SDK 4.3.1/windowstransactions.md index c013743..e930807 100644 --- a/windows_versioned_docs/version-Windows SDK 4.3.1/windowstransactions.md +++ b/windows_versioned_docs/version-Windows SDK 4.3.1/windowstransactions.md @@ -610,7 +610,7 @@ This event is invoked when the transaction is completed, it contains the transac `StopCurrentTransaction` Method -This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#status-info) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. +This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#statusInfo) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. **Code example** @@ -688,7 +688,7 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| ## Pre-Auth Increase/Decrease @@ -746,7 +746,7 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| ## Pre-Auth Capture @@ -882,7 +882,7 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| ## Pre-Auth/Capture Reversal @@ -935,4 +935,4 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| diff --git a/windows_versioned_docs/version-Windows SDK 4.4.0/windowsintegrationguide.md b/windows_versioned_docs/version-Windows SDK 4.4.0/windowsintegrationguide.md index ef1e4fe..5b9888c 100644 --- a/windows_versioned_docs/version-Windows SDK 4.4.0/windowsintegrationguide.md +++ b/windows_versioned_docs/version-Windows SDK 4.4.0/windowsintegrationguide.md @@ -440,7 +440,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **1. Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) @@ -1149,7 +1149,7 @@ namespace GettingStartedApp ### Let´s notify the user when the app is connected and ready to send the transaction **Update the ConnectionLabel to notify the user of the connection status** -Get the connection status from the method **[*ConnectionStatusChanged*](#7)** in MyClass.cs. +Get the connection status from the method ***ConnectionStatusChanged*** in MyClass.cs. ```csharp public void ConnectionStatusChanged(ConnectionStatus status, Device device) diff --git a/windows_versioned_docs/version-Windows SDK 4.4.0/windowsobjects.md b/windows_versioned_docs/version-Windows SDK 4.4.0/windowsobjects.md index 043127c..63243de 100644 --- a/windows_versioned_docs/version-Windows SDK 4.4.0/windowsobjects.md +++ b/windows_versioned_docs/version-Windows SDK 4.4.0/windowsobjects.md @@ -247,7 +247,7 @@ A static class containing information about the current status of the SDK |`inTransaction`
*bool* |Checks whether the SDK is in transaction or not. True if the SDK is in transaction, false otherwise. This might return a true if there is a communication error between the SDK and payment terminal but the transaction has been completed on the card reader.| |`SdkVersion`
*String* |Gets the current Sdk version.| |`IsTransactionResultPending`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This function checks if there is a pending [*Transaction Result*](#14). This field is only updated when connecting to a device. If this function returns true the [*Transaction Result*](#14) (which includes the receipt) can be fetched with hapi.GetPendingTransactionResult();. This function serves the same functionality as the event PendingTransactionResult(Device device), so every time that event is invoked, HapiManager.IsTransactionResultPending() is true until the result is fetched.| -|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via [*TransactionResultReady*](#11). The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| +|`Settings.AutoRecoverTransactionResult`
*boolean* |In case of a communication failure between the device and the API a [*Transaction Result*](#14) might not be delivered to the API. This property can be set to true or false. If set to true, the SDK will automatically fetch the pending [*Transaction Result*](#14) when detected and return it via *TransactionResultReady*. The function PendingTransactionResult is never invoked if this property is set to true. If set to false PendingTransactionResult will be called when a TransactionResult is pending.| **Code example** diff --git a/windows_versioned_docs/version-Windows SDK 4.4.0/windowstransactions.md b/windows_versioned_docs/version-Windows SDK 4.4.0/windowstransactions.md index dff9125..c60cc20 100644 --- a/windows_versioned_docs/version-Windows SDK 4.4.0/windowstransactions.md +++ b/windows_versioned_docs/version-Windows SDK 4.4.0/windowstransactions.md @@ -610,7 +610,7 @@ This event is invoked when the transaction is completed, it contains the transac `StopCurrentTransaction` Method -This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#status-info) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. +This method attempts to cancel the current transaction on the payment terminal. Note that operations can only be cancelled before requests are sent to the gateway. There is a flag called [cancelAllowed](windowobjects#statusInfo) in the currentTransactionStatus event that can be used to check if the transaction is in a state allowing the transaction to be cancelled. **Code example** @@ -688,7 +688,7 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| ## Pre-Auth Increase/Decrease @@ -746,7 +746,7 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| ## Pre-Auth Capture @@ -882,7 +882,7 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| ## Pre-Auth/Capture Reversal @@ -935,4 +935,4 @@ This event is invoked when the transaction is completed, it contains the transac | Parameter | Notes | | ----------- | ----------- | -| *[OperationStartResult](windowsobjects.md#OperationStartResul)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.| +| *[OperationStartResult](windowsobjects.md#OperationStartResult)*| Object containing information about the financial operation performed. Most specifically the `transactionReference` which **must** be saved on your end in case you do not get back the transaction result object at the end of the transaction. The `transactionReference` will allow you to query the Handpoint Gateway directly to know the outcome of the transaction in case it is not delivered as planned by the terminal at the end of the transaction.|