WinkPG Docs

View as Markdown

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.

`LoopbackSimulation`

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

The persisted record of what the loopback sandbox processor simulated on a transaction: which published triggers the request actually fired, and which response values came from a default rather than from a trigger.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description

entries required

array of LoopbackSimulationEntry array of LoopbackSimulationEntry

One entry per trigger the simulator honoured, plus one per response value it filled in from a default. Ordered as the simulator resolved them. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each LoopbackSimulationEntry:

Field Type Description

family required

string

Which part of the simulator produced this entry, as one of the `LoopbackSimulationFamilies` names. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

catalogId required

string

The published identifier this entry resolves against in the loopback catalog, or `null` when the entry records something the catalog does not enumerate. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

resolvedCode required

string

The verification response code the simulator returned, on an address-verification or cardholder-verification entry. `null` on every other family. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

matchedOn required

string

What the simulator matched on, in prose: "Amount cents", "Billing ZIP", "Latency profile". nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

observedValue required

string

The value that was matched, when it is safe to carry. `null` otherwise. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

effect required

string

What the simulator did as a result, stated as an observed fact rather than as documentation. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isDefault required

boolean

`true` when this entry records a response value the simulator filled in from a default because nothing matched, rather than a trigger that fired.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This model has no documented fields.