terminalOrders

Retrieve terminal order

Changed on

Use this method to retrieve information about a terminal order.

To retrieve a terminal order, you need it's terminalOrderId. Our gateway returned the terminalOrderId in the response of the Create Terminal Order method.

Note: If you don't have the terminalOrderId, use our List Terminal Orders method to search for the terminal order.

Our gateway returns the following information about the terminal order:

  • Status of the order
  • Items in the order
  • Training provider
  • Shipping information

Note: You can subscribe to our terminalOrder.status.changed event to get notifications when we update the status of a terminal order. For more information about how to subscribe to events, go to Events Subscriptions.

get/terminal-orders/{terminalOrderId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/terminal-orders/{terminalOrderId}
  • Auth
    HTTP bearer

Path parameters

terminalOrderIdstring required

Unique identifier of the terminal order.

Response

Successful request. Returns the terminal order.

terminalOrderIdstring required

Unique identifier that we assigned to the terminal order.

status'open' | 'held' | 'dispatched' | 'fulfilled' | 'cancelled' required

Status of the terminal order.

Note: You can subscribe to our terminalOrder.status.changed event to get notifications when we update the status of a terminal order. For more information about how to subscribe to events, go to Event Subscriptions.

trainingProvider'partner' | 'payroc'

Indicates who provides training to the merchant for the solution.

createdDatestring date-time required

Date that we received the terminal order. We return this value in the ISO-8601 format.

lastModifiedDatestring date-time required

Date that the terminal order was last changed. We return this value in the ISO-8601 format.

Changes