SchemaBoardingProcessing Accounts

Create terminal order

Use this method to order and configure terminals for a processing account. When you create an order, you specify the gateway settings, device settings, and application settings for the terminals. Note: You need the ID of the merchant’s processing account before you can create an order. If you don’t know the processingAccountId, go to Retrieve a Merchant Platform.

Path parameters

processingAccountIdstringRequired
Unique identifier of the processing account.

Headers

AuthorizationstringRequired

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

Idempotency-KeystringRequired

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
One or more items to be ordered
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 of the terminal order.
statusenum
Status of the terminal order.
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.
lastModifiedDatedatetime
Date that the terminal order was last changed.
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