Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ npm run docusaurus docs:version:android "Android SDK 7.1013.0"
Automatically, it will create the new folder for this version (version-Android SDK 7.1011.0) in `android_versioned_docs`.

```console
npm run docusaurus docs:version:restapi "REST API 2.29.0"
npm run docusaurus docs:version:restapi "REST API 2.30.0"
```

**To see it published you will have to restart docusaurus.**
Expand Down
84 changes: 64 additions & 20 deletions restapi/restendpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ POST endpoint used to send a financial operation to the payment terminal. The tr
| **BadRequest DeviceIsBusy Error** | The response code 400 with error 1001 is received from the API if the payment terminal is already processing a transaction. |
| **BadRequest DeviceNotResponding Error** | The response code 400 with error 1002 is received from the API if the payment terminal is offline. |
| **BadRequest CancelOperationNotAllowed Error** | The response code 400 with error 1003 is received from the API if the stopCurrentTransaction operation cannot be executed. A transaction can only be cancelled at specific steps of the transaction, while waiting for the card to be inserted or on PIN screen. |
| **BadRequest NoTransactionToCancel Error** | The response code 400 with error 1005 is received from the API if the stopCurrentTransaction operation is attempted but there is no transaction currently in progress to cancel. |

**Code Example**

Expand Down Expand Up @@ -1447,37 +1448,80 @@ curl --location --request POST 'https://cloud.handpoint.io/reversal' \

```json
{
"httpStatus": 200,
"acquirerTid": "ACQUIRER_TID",
"agreementNumber": "123456789010102",
"cardToken": "665630867",
"cardTokenizationGuid": "7df78050-21dc-11f1-991b-6f80eaf25911",
"expiryDateMMYY": "0927",
"httpStatus": "200",
"maskedCardNumber": "************3555",
"serverDateTime": "20260317083711509",
"transactionReference": "75413c40-21db-11f1-991b-6f80eaf25911"
"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"
}
```

</TabItem>
<TabItem value="400" label="400">
<TabItem value="Already Reversed" label="Already Reversed">

```json
{
"error": {
"statusCode": 400,
"name": "BadRequestError",
"message": "Already reversed",
"code": "3051",
"details": {
"body": {
"error": {
"errorCode": "3112",
"errorGuid": "624d05e0-21dd-11f1-991b-6f80eaf25911",
"httpStatus": "403",
"reason": "Transaction type is not eligible for deferred tokenization"
}
},
"status": 403
},
"message": "Viscus operation failed",
"errorCode": "3051",
"errorGuid": "c267a170-7b69-11f1-9754-81955277651b",
"httpStatus": 409,
"reason": "Already reversed"
}
}
}
```

</TabItem>
<TabItem value="Exceeds original amount" label="Exceeds original amount">

```json
{
"error": {
"statusCode": 400,
"name": "BadRequestError",
"statusCode": 400
"message": "Partial reversal amount exceeds original amount",
"code": "4066",
"details": {
"errorCode": "4066",
"errorGuid": "e5197770-7b69-11f1-9754-81955277651b",
"httpStatus": 400,
"reason": "Partial reversal amount exceeds original amount"
}
}
}
```
Expand Down
5 changes: 5 additions & 0 deletions restapi/restreleasenotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.29.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`).

## 2.27.0
**Features:**

Expand Down
83 changes: 63 additions & 20 deletions restapi_versioned_docs/version-REST API 2.28.0/restendpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -1447,37 +1447,80 @@ curl --location --request POST 'https://cloud.handpoint.io/reversal' \

```json
{
"httpStatus": 200,
"acquirerTid": "ACQUIRER_TID",
"agreementNumber": "123456789010102",
"cardToken": "665630867",
"cardTokenizationGuid": "7df78050-21dc-11f1-991b-6f80eaf25911",
"expiryDateMMYY": "0927",
"httpStatus": "200",
"maskedCardNumber": "************3555",
"serverDateTime": "20260317083711509",
"transactionReference": "75413c40-21db-11f1-991b-6f80eaf25911"
"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"
}
```

</TabItem>
<TabItem value="400" label="400">
<TabItem value="Already Reversed" label="Already Reversed">

```json
{
"error": {
"statusCode": 400,
"name": "BadRequestError",
"message": "Already reversed",
"code": "3051",
"details": {
"body": {
"error": {
"errorCode": "3112",
"errorGuid": "624d05e0-21dd-11f1-991b-6f80eaf25911",
"httpStatus": "403",
"reason": "Transaction type is not eligible for deferred tokenization"
}
},
"status": 403
},
"message": "Viscus operation failed",
"errorCode": "3051",
"errorGuid": "c267a170-7b69-11f1-9754-81955277651b",
"httpStatus": 409,
"reason": "Already reversed"
}
}
}
```

</TabItem>
<TabItem value="Exceeds original amount" label="Exceeds original amount">

```json
{
"error": {
"statusCode": 400,
"name": "BadRequestError",
"statusCode": 400
"message": "Partial reversal amount exceeds original amount",
"code": "4066",
"details": {
"errorCode": "4066",
"errorGuid": "e5197770-7b69-11f1-9754-81955277651b",
"httpStatus": 400,
"reason": "Partial reversal amount exceeds original amount"
}
}
}
```
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions restapi_versioned_docs/version-REST API 2.29.0/restdownloads.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
sidebar_position: 4
id: restapidownloads
---

# POSTMAN Collection

Below is a Postman collection to get started with the REST API integration. In this collection you will find examples of different [operations](restobjects#operation-types-description) such as initialize, ping device, sale, sale (money remittance example), MOTO sale, sale and tokenize, sale reversal, sale with partial approval, refund, linked refund, refund reversal, print receipt(Bitmap and custom receipt), tokenize card, update terminal, tip-adjustment, Pre-Auth, MOTO Pre-Auth, [GetTransactionResult](restendpoints.md#transaction-resulttransactionresultid) and [GetTransactionStatus](restendpoints.md#transactionstransactionreferencestatus).

[Download this Postman Collection](/files/API_REST_Nov2023.postman_collection.json.zip)
Loading
Loading