Create terminal order

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.

Path parameters

processingAccountIdstringRequired
Unique identifier that we assigned to the processing account.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringRequiredformat: "uuid"

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

This endpoint expects an object.
orderItemslist of objectsRequired
Array of order items. Provide a minimum of 1 order item and a maximum of 10 order items.
trainingProviderenumOptionalDefaults to partner
Indicates who provides training to the merchant for the solution.
Allowed values:
shippingobjectOptional

Object that contains the shipping details for the terminal order. If you don’t provide a shipping address, we use the Doing Business As (DBA) address of the processing account.

Response

Successful request. We created the terminal order.
terminalOrderIdstring
Unique identifier that we assigned to the terminal order.
statusenum

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.

Allowed values:
orderItemslist of objects
Array of orderItem objects. Provide a minimum of 1 order item and a maximum of 20 order items.
createdDatedatetime

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

lastModifiedDatedatetime

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

trainingProviderenum or nullDefaults to partner
Indicates who provides training to the merchant for the solution.
Allowed values:
shippingobject or null

Object that contains the shipping details for the terminal order. If you don’t provide a shipping address, we use the Doing Business As (DBA) address of the processing account.

Errors