processingAccounts

Create terminal order

Changed on

Use this method to order and configure terminals for a processing account.

Note: You need the ID of the processing account before you can create an order. If you don't know the processingAccountId, go to the Retrieve a Merchant Platform method.

In the request, specify the gateway settings, device settings, and application settings for the terminal.

In the response, our gateway returns information about the terminal order including its status and terminalOrderId that you can use to retrieve the terminal order.

Note: You can subscribe to the 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.

post/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.

Headers

Idempotency-Keystring uuid required

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request body

trainingProvider'partner' | 'payroc'

Indicates who provides training to the merchant for the solution.

Response

Successful request. We created 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