Send a Terminal API request and receive a synchronous response

post/merchants/{merchantAccount}/devices/{deviceId}/sync

Sends a Terminal API request and receives the response synchronously.

The request body is a JSON object containing a Terminal API request. For the structure, see the various request types under Terminal API.

The response returns a Terminal API response. See Receiving a synchronous result.

To make this request, your API credential must have the following role:

  • Cloud Device API role
Endpoint destination URL
deviceIdstringRequired

The unique identifier of the payment device that you send this request to. Must be the same as the POIID in the MessageHeader of the Terminal API request.

In an integration with payment terminals, use the terminal ID in the format [terminal model]-[serial number], for example, P400‑123456789. In a Mobile solution, use the installation ID of the SDK.

merchantAccountstringRequired

The unique identifier of the merchant account.

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.