Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 110 additions & 0 deletions website/content/gateway/api_reference/deprecated/deprecated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
---
title: "deprecated"
date: 2026-01-27T09:37:22+01:00
anchor: "deprecated"
weight: 360
---
## Deprecated
This section included snippets of the old documentation. As long as its available in this section its
still a valid way to work with the api.
### M4m and Vts snippet from 2025
#### Method: token

* `token[m4m]`: Mastercard Digital Enablement Service (MDES) for Merchants (M4M)
* `token[vts]`: Visa Token Service (VTS)

Requirement of some parameters depends on the initiator of the transaction; a parameter might be required for cardholder-initiated transactions (CITs) and otherwise optional. See the details for each parameter.

{{% notice %}}
**Notice**: Signing is required to use the `token` payment method.
{{% /notice %}}

#### Method: token[m4m]

The required values are found in either the MDES `transact` response or the Secure Card on File (SCOF) `checkout` response.

{{% description_list %}}
{{% description_term %}}token[m4m][tan] {{% regex %}}[0-9]{12,19}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Token Account Number (TAN) of the token to charge.

Found in `encryptedPayload.encryptedData.accountNumber` (MDES) or `encryptedPayload.token.paymentToken` (SCOF).
{{% /description_details %}}

{{% description_term %}}token[m4m][expire_month] {{% regex %}}[0-9]{2}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Expiry month of token to charge.

Found in `encryptedPayload.encryptedData.applicationExpiryDate` (MDES) or `encryptedPayload.token.tokenExpirationMonth` (SCOF).
{{% /description_details %}}

{{% description_term %}}token[m4m][expire_year] {{% regex %}}20[0-9]{2}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Expiry year of token to charge.

Found in `encryptedPayload.encryptedData.applicationExpiryDate` (MDES) or `encryptedPayload.token.tokenExpirationYear` (SCOF).
{{% /description_details %}}

{{% description_term %}}token[m4m][tav] {{% regex %}}[:base64:]{28}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Token Authentication Value (TAV). Also known as token cryptogram and Digital Secure Remote Payments (DSRP) cryptogram.

Only DSRP cryptograms are supported. The value must start with `[A-P]` to be a DSRP cryptogram.

Found in `encryptedPayload.encryptedData.de48se43Data` (MDES) or `encryptedPayload.dynamicData.dynamicDataValue` (SCOF).
{{% regex_optional %}}Required for CITs. For MITs it shall only be included on the first, tokenized transaction or if there is a change to the token.{{% /regex_optional %}}
{{% /description_details %}}

{{% description_term %}}token[m4m][rcai] {{% regex %}}[:base64:]{1..150}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Remote Commerce Acceptor Identifier.

Merchant identifier such as business website URL or reverse domain name (e.g. com.example.www). The identifier must be encoded as Base64.

Found in `customOutputData.remoteCommerceAcceptorIdentifier` (SCOF). (Not available in MDES.)
{{% regex_optional %}}Optional.{{% /regex_optional %}}
{{% /description_details %}}

{{% description_term %}}token[m4m][3dsecure][v2] {{% regex %}}dictionary{{% /regex %}}{{% /description_term %}}
{{% description_details %}}See [Authentication: [3dsecure][v2]](#authentication-3dsecure-v2).
{{% regex_optional %}}Optional{{% /regex_optional %}}
{{% /description_details %}}
{{% /description_list %}}

#### Method: token[vts]

The required values are found in the VTS provision token response.

{{% description_list %}}
{{% description_term %}}token[vts][tan] {{% regex %}}[0-9]{12,19}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Token Account Number (TAN) of the token to charge.

Found in `tokenInfo.encTokenInfo`.
{{% /description_details %}}

{{% description_term %}}token[vts][expire_month] {{% regex %}}[0-9]{2}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Expiry month of token to charge.

Found in `tokenInfo.expirationDate.month`.
{{% /description_details %}}

{{% description_term %}}token[vts][expire_year] {{% regex %}}20[0-9]{2}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Expiry year of token to charge.

Found in `tokenInfo.expirationDate.year`.
{{% /description_details %}}

{{% description_term %}}token[vts][eci] {{% regex %}}0[57]{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Electronic Commerce Indicator.

Found in `cryptogramInfo.eci`.
{{% regex_optional %}}Required for CITs; otherwise optional (defaults to `07`).{{% /regex_optional %}}
{{% /description_details %}}

{{% description_term %}}token[vts][tav] {{% regex %}}[:base64:]{28}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Token Authentication Value (TAV). Also known as token cryptogram and Token Authentication Verification Value (TAVV).

Found in `cryptogramInfo.cryptogram`.
{{% regex_optional %}}Required for CITs; otherwise optional.{{% /regex_optional %}}
{{% /description_details %}}

{{% description_term %}}token[vts][3dsecure][v2] {{% regex %}}dictionary{{% /regex %}}{{% /description_term %}}
{{% description_details %}}See [Authentication: [3dsecure][v2]](#authentication-3dsecure-v2).
{{% regex_optional %}}Optional{{% /regex_optional %}}
{{% /description_details %}}
{{% /description_list %}}
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ weight: 135
---
#### Method: token

Three token frameworks are supported:
Token frameworks supported:

* `clicktopay`: Click to Pay
* `token[m4m]`: Mastercard Digital Enablement Service (MDES) for Merchants (M4M)
* `token[vts]`: Visa Token Service (VTS)
* `token`: Visa and Mastercard
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Historically, I think we have add new fields/sections separately, and marked existing ones as deprecated. Then only once we fully deprecate them in the API, we go and remove the documentation. This way, parthers can still see documentation for their current integrations.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thejspr so i have added a 'deprecated' documentation section - which may should have been called legacy.
Situated beneath changes which include m4m and vts token in its entirety instead of using strike through.


[token[m4m]](#deprecated) and [token[vts]](#deprecated) is deprecated, but still works.

Requirement of some parameters depends on the initiator of the transaction; a parameter might be required for cardholder-initiated transactions (CITs) and otherwise optional. See the details for each parameter.

Expand Down Expand Up @@ -50,92 +51,92 @@ Click to Pay token payment method for both Visa and Mastercard CITs.
{{% /description_details %}}
{{% /description_list %}}

#### Method: token[m4m]
#### Method: token

Token payment method for both For both Visa Token Service (VTS) and Mastercard Digital Enablement Service (MDES)

The required values are found in either the MDES `transact` response or the Secure Card on File (SCOF) `checkout` response.
The required values are found in:
- the VTS provision token response.
- the MDES `transact` response
- the SCOF Secure Card on File `checkout` response.

{{% description_list %}}
{{% description_term %}}token[m4m][tan] {{% regex %}}[0-9]{12,19}{{% /regex %}}{{% /description_term %}}
{{% description_term %}}token[tan] {{% regex %}}[0-9]{12,19}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Token Account Number (TAN) of the token to charge.

Found in `encryptedPayload.encryptedData.accountNumber` (MDES) or `encryptedPayload.token.paymentToken` (SCOF).
| Response | Found in |
| ------ | --------- |
| VTS | `tokenInfo.encTokenInfo` |
| MDES | `encryptedPayload.encryptedData.accountNumber` |
| SCOF | `encryptedPayload.token.paymentToken` |
{{% /description_details %}}

{{% description_term %}}token[m4m][expire_month] {{% regex %}}[0-9]{2}{{% /regex %}}{{% /description_term %}}
{{% description_term %}}token[expire_month] {{% regex %}}[0-9]{2}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Expiry month of token to charge.

Found in `encryptedPayload.encryptedData.applicationExpiryDate` (MDES) or `encryptedPayload.token.tokenExpirationMonth` (SCOF).
{{% /description_details %}}

{{% description_term %}}token[m4m][expire_year] {{% regex %}}20[0-9]{2}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Expiry year of token to charge.

Found in `encryptedPayload.encryptedData.applicationExpiryDate` (MDES) or `encryptedPayload.token.tokenExpirationYear` (SCOF).
| Response | Found in |
| ------ | --------- |
| VTS | `tokenInfo.expirationDate.month` |
| MDES | `encryptedPayload.encryptedData.applicationExpiryDate ` |
| SCOF | `encryptedPayload.token.tokenExpirationMonth` |
{{% /description_details %}}

{{% description_term %}}token[m4m][tav] {{% regex %}}[:base64:]{28}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Token Authentication Value (TAV). Also known as token cryptogram and Digital Secure Remote Payments (DSRP) cryptogram.

Only DSRP cryptograms are supported. The value must start with `[A-P]` to be a DSRP cryptogram.
{{% description_term %}}token[expire_year] {{% regex %}}20[0-9]{2}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Expiry year of token to charge.

Found in `encryptedPayload.encryptedData.de48se43Data` (MDES) or `encryptedPayload.dynamicData.dynamicDataValue` (SCOF).
{{% regex_optional %}}Required for CITs. For MITs it shall only be included on the first, tokenized transaction or if there is a change to the token.{{% /regex_optional %}}
| Response | Found in |
| ------ | --------- |
| VTS | `tokenInfo.expirationDate.year` |
| MDES | `encryptedPayload.encryptedData.applicationExpiryDate ` |
| SCOF | `encryptedPayload.token.tokenExpirationYear` |
{{% /description_details %}}

{{% description_term %}}token[m4m][rcai] {{% regex %}}[:base64:]{1..150}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Remote Commerce Acceptor Identifier.
{{% description_term %}}token[eci] {{% regex %}}0[57]{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Electronic Commerce Indicator.

Merchant identifier such as business website URL or reverse domain name (e.g. com.example.www). The identifier must be encoded as Base64.

Found in `customOutputData.remoteCommerceAcceptorIdentifier` (SCOF). (Not available in MDES.)
{{% regex_optional %}}Optional.{{% /regex_optional %}}
{{% /description_details %}}

{{% description_term %}}token[m4m][3dsecure][v2] {{% regex %}}dictionary{{% /regex %}}{{% /description_term %}}
{{% description_details %}}See [Authentication: [3dsecure][v2]](#authentication-3dsecure-v2).
{{% regex_optional %}}Optional{{% /regex_optional %}}
| Response | Found in | Required for CITs |
| ------ | --------- | ---- |
| VTS | `cryptogramInfo.eci` | Yes, otherwise optional (defaults to `07`) |
| MDES | N/A | |
| SCOF | N/A | |
{{% /description_details %}}
{{% /description_list %}}

#### Method: token[vts]

The required values are found in the VTS provision token response.

{{% description_list %}}
{{% description_term %}}token[vts][tan] {{% regex %}}[0-9]{12,19}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Token Account Number (TAN) of the token to charge.
{{% description_term %}}token[tav] {{% regex %}}[:base64:]{28}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Token Authentication Value (TAV) also know as token cryptogram.

Found in `tokenInfo.encTokenInfo`.
{{% /description_details %}}
Visa specific name: Token Authentication Verification Value (TAVV).

{{% description_term %}}token[vts][expire_month] {{% regex %}}[0-9]{2}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Expiry month of token to charge.
Mastercard specific name: Digital Secure Remote Payments (DSRP) cryptogram.
For Mastercard only DSRP cryptograms are supported. The value must start with `[A-P]` to be a DSRP cryptogram.

Found in `tokenInfo.expirationDate.month`.
{{% /description_details %}}

{{% description_term %}}token[vts][expire_year] {{% regex %}}20[0-9]{2}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Expiry year of token to charge.

Found in `tokenInfo.expirationDate.year`.
| Response | Found in | Required for CITs |
| ------ | --------- | ---- |
| VTS | `cryptogramInfo.eci` | Yes; otherwise optional. |
| MDES | `encryptedPayload.encryptedData.de48se43Data` | Yes. For MITs it shall only be included on the first, tokenized transaction or if there is a change to the token|
| SCOF | `encryptedPayload.dynamicData.dynamicDataValue` | Yes. For MITs it shall only be included on the first, tokenized transaction or if there is a change to the token|
{{% /description_details %}}

{{% description_term %}}token[vts][eci] {{% regex %}}0[57]{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Electronic Commerce Indicator.

Found in `cryptogramInfo.eci`.
{{% regex_optional %}}Required for CITs; otherwise optional (defaults to `07`).{{% /regex_optional %}}
{{% /description_details %}}
{{% description_term %}}token[rcai] {{% regex %}}[:base64:]{1..150}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Remote Commerce Acceptor Identifier.

{{% description_term %}}token[vts][tav] {{% regex %}}[:base64:]{28}{{% /regex %}}{{% /description_term %}}
{{% description_details %}}Token Authentication Value (TAV). Also known as token cryptogram and Token Authentication Verification Value (TAVV).
| Response | Found in | Required? |
| ------ | --------- | - |
| VTS | N/A | N/A |
| MDES | N/A | N/A |
| SCOF | `customOutputData.remoteCommerceAcceptorIdentifier`| optional |

Found in `cryptogramInfo.cryptogram`.
{{% regex_optional %}}Required for CITs; otherwise optional.{{% /regex_optional %}}
Merchant identifier such as business website URL or reverse domain name (e.g. com.example.www). The identifier must be encoded as Base64.
{{% /description_details %}}

{{% description_term %}}token[vts][3dsecure][v2] {{% regex %}}dictionary{{% /regex %}}{{% /description_term %}}
{{% description_term %}}token[3dsecure][v2] {{% regex %}}dictionary{{% /regex %}}{{% /description_term %}}
{{% description_details %}}See [Authentication: [3dsecure][v2]](#authentication-3dsecure-v2).
{{% regex_optional %}}Optional{{% /regex_optional %}}
{{% /description_details %}}
{{% /description_list %}}