How distinguish PreAuth, Auth and Sale transactions using Clover REST API

Question

question

aripa asked Jun 2, '22 kevnat answered Jun 10, '22

How distinguish PreAuth, Auth and Sale transactions using Clover REST API

I use Clover REST API to get payments. (https://api.clover.com/v3/merchants/)

And for me not clear how distinguish PreAuth, Auth and Sale transactions and if it's PreAuth or Auth I need understand whether it's captured or not.

For example I've got this payment:

It's PreAuth and then captured payment

{
  "result": "SUCCESS",
  "cardTransaction": {
    "type": "PREAUTH",
    "state": "PENDING",
    "captured": false
  }
}

Here not clear why captured is false and state is pending

It's Sale payment

{
  "result": "SUCCESS",
  "cardTransaction": {
    "type": "AUTH",
    "state": "CLOSED",
    "captured": false
  }  
}

Here not clear why type is auth and captured is false

REST API Sale Auth

10 |2000

Attachments: Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Welcome to the
Clover Developer Community

Answer 1 · 2022-06-10T21:41:14Z

kevnat answered Jun 10, '22

Hi Aripa,

Unfortunately, there is some internal business logic implied with the "captured" property, and it may not be useful to key off its value to determine the state of transactions.

I've also noticed that there are also some inconsistencies with this property's value transition between our platform, and Ecommerce API. I've made a ticket for our team to look into this.

In an attempt to simplify things, I'd recommend viewing our transaction types in the following manner:

Single Message
- Sales
  - Once submitted, the amount is non-adjustable.
  - ```
  "type":"AUTH",
  "state":"CLOSED",
  "result":"SUCCESS"
```
Dual Message
- Auths and Pre-Auths can either be adjusted (tip/increment), voided, or captured.
- Pre-auths (available through some of our interfaces) will look like this:
  - ```
  "type":"PREAUTH",
  "result": "SUCCESS"
```
- Auths and captured Pre-Auths:
  - ```
  "type":"PREAUTH",
  "state":"PENDING",
  "result": "SUCCESS"
```
- Once closeout runs successfully, both Pre-auths and Auths should look like this (if approved)
  - ```
  "type":"PREAUTH",
  "state":"CLOSED",
  "result": "SUCCESS"
```

Hope this helps.

- Kevin

10 |2000

Attachments: Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

question