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.

`TransactionTokenResult`

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

The merchant-facing token identifiers the gateway generated when the card on a transaction was vaulted (HPP / Virtual Terminal "save card on payment"). Surfaced on `tokenResult` so ISVs / resellers / merchants can retrieve the reusable token from the transaction response (and the HPP callback / webhook) and charge it later.

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

numericToken required

integer (int64)

The numeric token identifier. 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.

cardFormatToken required

string

The card-format token identifier. 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.

publicReference required

string

Stable, URL-safe opaque external reference for the token. This is the identifier surfaced in the transaction-completed event and the HPP postMessage envelope for integrators to correlate the saved credential: never the internal vault Guid (PAN-correlated). 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.

This model has no documented fields.