admin_terminals_operations_post

curl --request POST \
  --url https://api.dintero.com/v1/accounts/{aid}/payments/admin/terminals/operations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "terminal_id": "<string>"
}
'

import requests

url = "https://api.dintero.com/v1/accounts/{aid}/payments/admin/terminals/operations"

payload = { "terminal_id": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({terminal_id: '<string>'})
};

fetch('https://api.dintero.com/v1/accounts/{aid}/payments/admin/terminals/operations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dintero.com/v1/accounts/{aid}/payments/admin/terminals/operations"

	payload := strings.NewReader("{\n  \"terminal_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dintero.com/v1/accounts/{aid}/payments/admin/terminals/operations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"terminal_id\": \"<string>\"\n}")
  .asString();

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "terminal_id": "<string>",
  "operation": "end_of_day",
  "status": "PENDING",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>",
  "account_id": "<string>"
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

Terminals

Post terminal operation

Send an administrative command to a payment terminal. These commands do not start a payment.

The response is returned immediately after the command is dispatched to the terminal, with status PENDING. The terminal’s response is processed asynchronously. Use GET /admin/terminals/operations to see how the operation finished.

While another operation of the same type is pending on the terminal, 409 is returned.

Each operation also requires the terminal to be in a suitable status. The operation field below lists the status for each. The request is rejected with 400 when the status does not allow it.

scopes:

admin:checkout
write:checkout:/admin/terminals

POST

https://api.dintero.com/v1

accounts

{aid}

payments

admin

terminals

operations

admin_terminals_operations_post

curl --request POST \
  --url https://api.dintero.com/v1/accounts/{aid}/payments/admin/terminals/operations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "terminal_id": "<string>"
}
'

import requests

url = "https://api.dintero.com/v1/accounts/{aid}/payments/admin/terminals/operations"

payload = { "terminal_id": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({terminal_id: '<string>'})
};

fetch('https://api.dintero.com/v1/accounts/{aid}/payments/admin/terminals/operations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dintero.com/v1/accounts/{aid}/payments/admin/terminals/operations"

	payload := strings.NewReader("{\n  \"terminal_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dintero.com/v1/accounts/{aid}/payments/admin/terminals/operations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"terminal_id\": \"<string>\"\n}")
  .asString();

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "terminal_id": "<string>",
  "operation": "end_of_day",
  "status": "PENDING",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>",
  "account_id": "<string>"
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication (token authentication) should be used for accessing the API.

Use Get Token to get an access token for client credentials. Pass the token in the request header:

Authorization: Bearer {access_token}

where the access_token is JSON Web Tokens (JWT).

Headers

Idempotency-Key

string<uuid>

Optional idempotency key to ensure the operation is only executed once.

Path Parameters

aid

string<^[PT]{1}\d{8}$>

required

An id that uniquely identifies the account.

Required string length: 9

Body

application/json

terminal_id

string

required

Terminal identifier

operation

enum<string>

required

The command to send to the terminal.

end_of_day: close the terminal's current batch and settle it with the acquirer. Run once per trading day, after the last payment. Requires the terminal to be ACTIVE.
send_logs: have the terminal upload its log files for troubleshooting. Requires the terminal to be ACTIVE.
check_update: have the terminal check for a software update and install one if available. The terminal can become unresponsive for a time while updating. Allowed when the terminal is ACTIVE, PENDING or ACTION_REQUIRED.
open_menu: open the settings menu on the terminal's own screen for an operator standing at the device. Allowed for any terminal status except PENDING.
poll_terminal: ping the terminal to see whether it is online and responding. Has no effect on the device and is allowed regardless of terminal status.
print_text: print lines on the terminal's printer. Dintero does not compose or check the content. Requires the terminal to be ACTIVE.
print_receipt: print a copy of the payment receipt of an in-person transaction. Requires the terminal to be ACTIVE.

Available options:

end_of_day,

send_logs,

check_update,

open_menu,

poll_terminal,

print_text,

print_receipt

parameters

object

Parameters for the chosen operation.

end_of_day: optional. operator_id (string) is the operator that runs end of day. Default: the current active operator.
print_text: required. lines is an array of 1 to 255 lines. Each line has text (string, max 255 bytes), size (small, medium or large) and align (left, center or right). A line fits 29 characters at small and medium, and 15 at large.
print_receipt: required. transaction_id (string) is the transaction to print the receipt for. type is customer or merchant.
Other operations take no parameters.

Response

Terminal operation created

Terminal operation. The shape depends on the operation field. When present, the fields inside result are camelCase, unlike the rest of the operation.

string<uuid>

required

Unique identifier for the terminal operation.

terminal_id

string

required

Identifier of the terminal the operation was sent to.

operation

enum<string>

required

The command that was sent to the terminal.

end_of_day: close the terminal's current batch and settle it with the acquirer. Run once per trading day, after the last payment.
send_logs: have the terminal upload its log files for troubleshooting. The logs are not returned through this API.
check_update: have the terminal check for a software update and install one if available. May reboot the terminal.
open_menu: open the settings menu on the terminal's own screen for an operator standing at the device. The terminal cannot take payments while the menu is open.
poll_terminal: ping the terminal to see whether it is online and responding. Has no effect on the device.
print_text: print lines on the terminal's printer. Dintero does not compose or check the content.
print_receipt: print a copy of a transaction's payment receipt.

Available options:

end_of_day,

send_logs,

check_update,

open_menu,

poll_terminal,

print_text,

print_receipt

status

enum<string>

required

Status of the terminal operation.

PENDING: Operation has been dispatched to the terminal and is awaiting a response.
COMPLETED: Terminal has responded and the operation finished successfully.
FAILED: Terminal responded but reported a failure.
TIMEOUT: No response was received from the terminal within the timeout window. A new operation can be dispatched.

Which statuses an operation can reach depends on the operation. open_menu and poll_terminal are never reported as FAILED, since the terminal does not report a failure for them - an unreachable terminal ends those operations as TIMEOUT. end_of_day, send_logs, check_update, print_text and print_receipt can be FAILED when the terminal answers but reports a problem; the result of the operation says what it was.

Available options:

PENDING,

COMPLETED,

FAILED,

TIMEOUT

created_at

string<date-time>

required

When the operation was created.

created_by

string

required

Identity of the user or system that created the operation.

updated_at

string<date-time>

required

When the operation was last updated.

updated_by

string

required

Identity of the user or system that last updated the operation.

account_id

string

Account identifier the operation belongs to.

Authentication

Sessions

Transactions

Merchant Initiated Payment

Card Tokens

Payout Destinations & Sellers

Payment Approvals

Payout Approvals

In-Person Payments

Settlements

Insight & Reports

Example Webhook Events

Example Callbacks

Post terminal operation

Authorizations

Headers

Path Parameters

Body

Response