SchemaBoardingProcessing Accounts

List terminal orders

Use this method to retrieve a list of terminal orders associated with a processing account.
Send the processingAccountId in the path parameter of your request.

Note: If you don’t know the processingAccountId, go to List merchant platform’s processing accounts.

Path parameters

processingAccountIdstringRequired

Unique identifier of the processing account.

Headers

AuthorizationstringRequired

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

Query parameters

statusenumOptional

Filter terminal orders by status.

Allowed values:
fromDateTimestringOptionalformat: "date-time"
toDateTimestringOptionalformat: "date-time"

Response

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

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.

createdDatestringformat: "date-time"

Date that we received the terminal order.

lastModifiedDatestringformat: "date-time"

Date that the terminal order was last changed.

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.