Clear Transaction

The Clear Transaction endpoint enables you to test the clearing of transactions using CTS Lite. This REST API enables you to perform these tests without the need to use the full Card Transaction System (CTS) functionality.

📘

Note

For more information on clearing transactions, see the Glossary.

You can perform a test by making a POST request to the Clear Transaction endpoint with the transaction id of the transaction you want to clear at the end of the URL. For example:

{{base-url}}/api/Clearing/PerformClearing?transactionId={{transactionId}}

📘

Note

You can get a transaction ID from a successful response when using the other CTS Lite endpoints, or from the Get Card Transaction endpoint.

A successful response will return a HTTP 200 response code with an acknowledgment value of 1 and a responseStatus of 00, confirming that the clearing has been successful.

📘

Note

The only values that can be returned from a successful response are 1, for acknowledgement, and 00 for responseStatus.

Below is an example response:

{
  "acknowledgement": 1,
  "responseStatus": "00"
}

👍

API Explorer

See the Perform Clearing for Selected Transaction endpoint.