Override a Terminal payment scenario

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "terminal.payment_simulation",
  "merchant_id": "<string>",
  "terminal_id": "<string>",
  "payment_intent_id": "<string>",
  "livemode": false,
  "outcome": "succeeded",
  "consumed": true,
  "created_at": 123,
  "failure_code": "do_not_honor",
  "resolution_outcome": "succeeded",
  "resolution_available_at": 123,
  "consumed_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>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

POST

test_helpers

terminals

{id}

payment_scenarios

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "terminal.payment_simulation",
  "merchant_id": "<string>",
  "terminal_id": "<string>",
  "payment_intent_id": "<string>",
  "livemode": false,
  "outcome": "succeeded",
  "consumed": true,
  "created_at": 123,
  "failure_code": "do_not_honor",
  "resolution_outcome": "succeeded",
  "resolution_available_at": 123,
  "consumed_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>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A test-mode Merchant secret key, or an authorized Platform test key with delegation.

Headers

Ionic-Account

string

Merchant ID when an authorized Platform acts for a connected Merchant. Omit when authenticating directly as that Merchant.

Pattern: ^mer_[0-9A-Za-z]{14}$

Idempotency-Key

string

required

Reuse only when retrying the same route and request body.

Required string length: 1 - 255

Path Parameters

string

required

Merchant-owned simulated Terminal ID.

Pattern: ^tmr_[0-9A-Za-z]{14}$

Body

application/json

payment_intent_id

string

required

Test-mode PaymentIntent owned by the same Merchant.

Pattern: ^pi_[0-9A-Za-z]{24}$

outcome

enum<string>

required

The result the simulated payment reports. unknown can remain unresolved or resolve later. dispatch_not_started simulates a failure that occurs before payment processing begins.

Available options:

succeeded,

voided,

declined,

failed,

canceled,

unknown,

dispatch_not_started

failure_code

enum<string>

Required for declined and failed final outcomes. Declines accept do_not_honor, insufficient_funds, incorrect_pin, pin_attempts_exceeded, or transaction_not_permitted. Failures accept processor_error, invalid_routing, or pin_processing_error. Omit it for every other final outcome.

Available options:

do_not_honor,

insufficient_funds,

incorrect_pin,

pin_attempts_exceeded,

transaction_not_permitted,

processor_error,

invalid_routing,

pin_processing_error

resolution_outcome

enum<string>

Final result for an unknown scenario. Omit for every other initial outcome.

Available options:

succeeded,

voided,

declined,

failed,

canceled

resolution_delay_seconds

integer

Required and greater than zero when resolution_outcome is set; otherwise omit it.

Required range: 0 <= x <= 86400

Response

The armed one-shot override.

string<uuid>

required

object

enum<string>

required

Available options:

terminal.payment_simulation

merchant_id

string

required

Pattern: ^mer_[0-9A-Za-z]{14}$

terminal_id

string

required

Pattern: ^tmr_[0-9A-Za-z]{14}$

payment_intent_id

string

required

Pattern: ^pi_[0-9A-Za-z]{24}$

livemode

enum<boolean>

required

Available options:

false

outcome

enum<string>

required

The result the simulated payment reports. unknown can remain unresolved or resolve later. dispatch_not_started simulates a failure that occurs before payment processing begins.

Available options:

succeeded,

voided,

declined,

failed,

canceled,

unknown,

dispatch_not_started

consumed

boolean

required

created_at

integer<int64>

required

failure_code

enum<string>

Available options:

do_not_honor,

insufficient_funds,

incorrect_pin,

pin_attempts_exceeded,

transaction_not_permitted,

processor_error,

invalid_routing,

pin_processing_error

resolution_outcome

enum<string>

Available options:

succeeded,

voided,

declined,

failed,

canceled

resolution_available_at

integer<int64>

Unix epoch seconds when a delayed unknown result can resolve.

consumed_at

integer<int64>

Unix epoch seconds when a process command first consumed the scenario.

Start here

Checkout

Commerce

Checkout endpoints

Payment link endpoints

Catalog endpoints

Payments

Terminal locations

Terminal management

Terminal testing

Terminal payments

Invoices

Subscriptions

Test clocks

Setup intents

Credit notes

Webhook endpoints

Customer endpoints

API key endpoints

Payment method endpoints

Override a Terminal payment scenario

Authorizations

Headers

Path Parameters

Body

Response