NMnmi
Devices

Get Payment Request Status

Retrieve the status of an asynchronous payment request initiated on a cloud device. The request_id is obtained from the initial payment request response (e.g., from POST /api/v5/devices/{deviceId}/payment-requests/sale). The device_id must match the device that initiated the payment request. This endpoint uses the same underlying functionality as GET /api/asyncstatus.

get/v5/devices/{device_id}/payment-requests/{request_id}

Request

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

Path parameters

device_idstring required

The unique identifier of the cloud device that initiated the payment request

request_idstring required

The unique identifier of the payment request, obtained from the initial payment request response

Response

Payment request status retrieved successfully

object'payment-request' required

Resource type identifier

idstring required

Payment request ID

status'pending' | 'inFlight' | 'interactionComplete' | 'cancelled' | 'cancelledAtTerminal' | 'cancelledByApi' | 'cancelledByTimeout' | 'poiDeviceInUse' | 'poiDeviceDisconnected' | 'terminatedBadCardRead' required

Status of the payment request. When a payment request is first created, the status is always pending. When polling for status, values are more granular to show the progress of the transaction based on the device's status or customer's interaction.

Changes

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