A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "terminal.batch_simulation",
"merchant_id": "<string>",
"terminal_id": "<string>",
"livemode": false,
"profiles": [
{
"reference": "<string>",
"items": [
{
"operation": "sale",
"amount": 123,
"transaction_id": "<string>",
"external_reference": "<string>",
"sequence": "<string>",
"occurred_at": 123
}
]
}
],
"created_at": 123,
"updated_at": 123
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Configure a Terminal batch scenario
Configures the durable current-batch situation for this simulated
Terminal. Submitted profiles replace their items, while omitted
existing profiles remain unchanged so an open batch cannot disappear
between observations. Calling POST /terminal_batches/refresh then creates
or updates the normal Ionic settlement profiles, batches, and batch
items; its response shape is identical for simulated and physical
Terminals.
A simulated Terminal with no configured batch scenario reports one empty default profile, so batch refresh is always supported.
A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "terminal.batch_simulation",
"merchant_id": "<string>",
"terminal_id": "<string>",
"livemode": false,
"profiles": [
{
"reference": "<string>",
"items": [
{
"operation": "sale",
"amount": 123,
"transaction_id": "<string>",
"external_reference": "<string>",
"sequence": "<string>",
"occurred_at": 123
}
]
}
],
"created_at": 123,
"updated_at": 123
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
A test-mode Merchant secret key, or an authorized Platform test key with delegation.
Headers
Merchant ID when an authorized Platform acts for a connected Merchant. Omit when authenticating directly as that Merchant.
^mer_[0-9A-Za-z]{14}$Reuse only when retrying the same route and request body.
1 - 255Path Parameters
Merchant-owned simulated Terminal ID.
^tmr_[0-9A-Za-z]{14}$Body
One to 10 profile updates. Omitted existing profiles remain unchanged.
1 - 10 elementsShow child attributes
Show child attributes
Response
The durable batch scenario.
Unique identifier for the batch scenario.
terminal.batch_simulation ID of the account that owns the scenario (mer_…).
^mer_[0-9A-Za-z]{14}$ID of the simulated terminal the scenario applies to (tmr_…).
^tmr_[0-9A-Za-z]{14}$false Simulated current-batch contents, grouped by processing profile.
Show child attributes
Show child attributes
Unix epoch seconds when the scenario was created.
Unix epoch seconds when the scenario was last updated.