Order a terminal
processingAccountId
of the account you want to order the terminal for. To get the processingAccountId
, go to Retrieve Merchant Platform.To order one or more terminals for a processing account, provide the following information:
- Training provider who will train the merchant to use the solution.
- Shipping address for hardware devices and peripheral devices.
- Solution details for each terminal including gateway settings, device settings, and application settings.
Integration steps
- Create a terminal order.
Before you begin
Bearer tokens
Use our Identity Service to generate a Bearer token to include in the header of your requests. To generate your Bearer token, complete the following steps:
- Include your API key in the x-api-key parameter in the header of a POST request.
- Send your request to https://identity.payroc.com/authorize.
Note: You need to generate a new Bearer token before the previous Bearer token expires.
Example request
Example response
If your request is successful, we return a response that contains your Bearer token, information about its scope, and when it expires.
Headers
To create the header of each POST request, you must include the following parameters:
- Content-Type: Include application/json as the value for this parameter.
- Authorization: Include your Bearer token in this parameter.
- Idempotency-Key: Include a UUID v4 to make the request idempotent.
Errors
If your request is unsuccessful, we return an error. For more information about errors, see Errors.
Create a terminal order
To order a terminal, send a POST request to our processing accounts endpoint.
Request parameters
To create the body of your request, use the following parameters:
Request
Example request
Response fields
If the request is successful, we create the terminal order and return the following response:
Status code 201
Successful request. We created the terminal order.