processingAccounts

List terminal orders

Changed on

Use this method to return a paginated list of terminal orders associated with a processing account.

Note: If you want to view the details of a specific terminal order and you have its terminalOrderId, use our Retrieve Terminal Order method.

Use the query parameters to filter the list of results that we return, for example, to search for terminal orders by their status.

To list the terminal orders for a processing account, you need its processingAccountId. If you don't have the processingAccountId, use our List Merchant Platforms method to search for a merchant platform and its processing accounts.

Our gateway returns the following information for each terminal order in the list:

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

For each terminal order, we also return its terminalOrderId, which you can use to perform follow-on actions.

get/processing-accounts/{processingAccountId}/terminal-orders

Request

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

Path parameters

processingAccountIdstring required

Unique identifier that we assigned to the processing account.

Query parameters

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

Filter terminal orders by status.

fromDateTimestring date-time
toDateTimestring date-time

Response

Successful request. Returns a list of terminal orders associated with the processing account.

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

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 9af893904873Revision changes
    • info

      api operation id listTerminalOrders removed and replaced with processingAccounts_listTerminalOrders