NMnmi
Devices

Cancel Payment Request on Device

Cancel an in-flight asynchronous payment request on a cloud device before authorization completes. If the transaction cannot be cancelled (for example, it has already completed), process a void once the transaction is complete. After a successful cancellation, polling GET /api/v5/devices/{device_id}/payment-requests/{request_id} may report a cancelled status such as cancelledByApi.

delete/v5/devices/{device_id}/payment-requests

Request

  • Base URL
    https://sandbox.nmi.com/api
  • URL
    https://sandbox.nmi.com/api/v5/devices/{device_id}/payment-requests
  • Auth
    API key in header Authorization

Path parameters

device_idstring required

The unique identifier of the cloud device whose in-flight payment request should be cancelled

Response

Cancellation request processed

object'payment-request-cancellation' required

Resource type identifier

successboolean required

Whether the cancellation request was accepted

messagestring required

Human-readable result message from the cancellation request

response_codestring nullable

Processor/gateway response code for the cancellation request

Changes

No recorded changes to this operation across all 1 revision of this API.