Sign in
Readers

Terminate a Reader Checkout

Terminate a Reader Checkout stops the current transaction on the target device.

This process is asynchronous and the actual termination may take some time to be performed on the device.

There are some caveats when using this endpoint:

  • The target device must be online, otherwise terminate won't be accepted
  • The action will succeed only if the device is waiting for cardholder action: e.g: waiting for card, waiting for PIN, etc.
  • There is no confirmation of the termination.

If a transaction is successfully terminated and return_url was provided on Checkout, the transaction status will be sent as failed to the provided URL.

Note: If the target device is a Solo, it must be in version 3.3.28.0 or higher.

post/v0.1/merchants/{merchant_code}/readers/{reader_id}/terminate

Path parameters

merchant_codestring required

Merchant Code

reader_idstring required

The unique identifier of the Reader

Response

The Terminate action was successfully dispatched for the given reader.

Changes

Changed in 2 of the 53 revisions of this API.12

  • cd79d83b07e07See the full diff
    • ○

      added the media type application/problem+json for the response with the status 400

      response-media-type-added

    • ○

      added the media type application/problem+json for the response with the status 401

      response-media-type-added

    • ○

      added the media type application/problem+json for the response with the status 422

      response-media-type-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 502

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 504

      response-non-success-status-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • bef1083e05805See the full diff
    • ○

      added the required property errors/type to the response with the 400 status

      response-required-property-added

    • ○

      added the required property errors/type to the response with the 401 status

      response-required-property-added

    • ○

      added the required property errors/type to the response with the 500 status

      response-required-property-added

    • ○

      added the required property errors/type to the response with the 502 status

      response-required-property-added

    • ○

      added the required property errors/type to the response with the 504 status

      response-required-property-added

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog