Skip to main content

Stored Credentials

This feature is supported for Visa, Mastercard, Discover, and Amex.

Stored Credentials API fields are optional. If the Stored Credentials fields are submitted, they must be populated with valid values. Otherwise, the transaction may be rejected, or processed as a regular credit card transaction.

For Mastercard transactions, credentials must be sent for non-Canadian merchants only. Additional data fields will be ignored if sent for Canadian merchants (the transaction will be processed as a regular credit card transaction and the API fields for Stored Credentials won't be returned in the API response).

Visa, Mastercard and Discover

The following API fields are applicable:

Field NameValid Values
storedCredentials.indicatorVisa and Discover: 1 indicates a first time transaction, and S indicates subsequent transactions.

Mastercard: merchants should send S. Merchants do not need to separately identify first and subsequent transactions.
storedCredentials.initiationM = Merchant Initiated
C = Cardholder Initiated
storedCredentials.scheduleU = Unscheduled
S = Scheduled
(Visa only)
R = Reauthorization of Prior Amount
A = Resubmission
E = Estimated Authorization
(Space) = Default
(Visa and Discover only)
An identifier, assigned by Visa or Discover, to uniquely identify and link all related messages and records used to authorize and settle a transaction.

If Merchant requires the original transaction ID, submit the value new in the original authorization request. The transactionId field will be returned in the API response provided the transaction is approved.

If an original transaction ID is created, it must be submitted in any follow-up transaction (eg. with recurring transactions).

American Express

The following API fields are applicable. The above fields related to Visa, Mastercard & Discover fields should not be submitted.

Field NameValid Values
ecommerceFlag2 for payments scheduled at regular frequency.

Supports recurring transaction applications such as: membership dues, subscriptions services, insurance premiums, wireless services, and other regularly scheduled charges. The billing amount can vary but the frequency is scheduled.
ecommerceFlagX for Re-authorized Transactions.

Designates a non-recurring purchase using a card on file.

Supports use cases where the cardholder information is on file and billing frequency and amount are variable.

This value should also be used to denote an American Express Payment Token transaction where cryptogram data is unavailable."