Deutsch (Deutschland)
Ελληνικά (Ελλάδα)
English (United States)
español (España)
español (México)
eesti (Etioopia)
français (Canada)
français (France)
italiano (Italia)
日本語 (日本)
lietuvių (Lietuva)
latviešu (Latvija)
polski (Polska)
português (Brasil)
română (România)
中文 (中国)
"
Integration Guidelines
API Reference
Troubleshooting & FAQs
Glossary
Downloads
MasterCard Payment Gateway API Reference:
Operations -
Version 12,
Protocol: NVP
Delete Token
Request to delete a token.
URL
https://ap-gateway.mastercard.com/api/nvp/version/12
HTTP Method
POST
Authentication
This operation requires authentication via one of the following methods:
Certificate authentication.
API password. An additional NVP parameter,
apiPassword
, must be supplied in the request containing your password for using the API.
Request Parameters
Common parameters
All parameters
apiOperation
String
=DELETE_TOKEN
FIXED
Existence
FIXED
Fixed value
DELETE_TOKEN
Validation Rules
Any sequence of zero or more unicode characters.
XSD type
string
merchant
Alphanumeric + additional characters
=
COMPULSORY
The unique identifier issued to you by your payment provider.
Existence
COMPULSORY
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
XSD type
string
minimum length
1
maximum length
40
token
Alphanumeric
=
COMPULSORY
Uniquely identifies a card and associated details.
Existence
COMPULSORY
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
1
maximum length
40
apiOperation
String
=DELETE_TOKEN
FIXED
Existence
FIXED
Fixed value
DELETE_TOKEN
Validation Rules
Any sequence of zero or more unicode characters.
XSD type
string
correlationId
String
=
OPTIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Existence
OPTIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
merchant
Alphanumeric + additional characters
=
COMPULSORY
The unique identifier issued to you by your payment provider.
Existence
COMPULSORY
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
XSD type
string
minimum length
1
maximum length
40
token
Alphanumeric
=
COMPULSORY
Uniquely identifies a card and associated details.
Existence
COMPULSORY
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
1
maximum length
40
Response Parameters
Common parameters
All parameters
Error parameters
result
Enumeration
=
Always Provided
A system-generated high level overall result of the operation.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
FAILURE
The operation was declined or rejected by the gateway, acquirer or issuer
PENDING
The operation is currently in progress or pending processing
SUCCESS
The operation was successfully processed
UNKNOWN
The result of the operation is unknown
correlationId
String
=
CONDITIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
result
Enumeration
=
Always Provided
A system-generated high level overall result of the operation.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
FAILURE
The operation was declined or rejected by the gateway, acquirer or issuer
PENDING
The operation is currently in progress or pending processing
SUCCESS
The operation was successfully processed
UNKNOWN
The result of the operation is unknown
error
=
CONDITIONAL
Information on possible error conditions that may occur while processing an operation using the API.
Fixed value
error.cause
Enumeration
=
CONDITIONAL
Broadly categorizes the cause of the error.
For example, errors may occur due to invalid requests or internal system failures.
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
INVALID_REQUEST
The request was rejected because it did not conform to the API protocol.
REQUEST_REJECTED
The request was rejected due to security reasons such as firewall rules, expired certificate, etc.
SERVER_BUSY
The server did not have enough resources to process the request at the moment.
SERVER_FAILED
There was an internal system failure.
error.explanation
String
=
CONDITIONAL
Textual description of the error based on the cause.
This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
1000
error.field
String
=
CONDITIONAL
Indicates the name of the field that failed validation.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
error.supportCode
String
=
CONDITIONAL
Indicates the code that helps the support team to quickly identify the exact cause of the error.
This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
error.validationType
Enumeration
=
CONDITIONAL
Indicates the type of field validation error.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
INVALID
The request contained a field with a value that did not pass validation.
MISSING
The request was missing a mandatory field.
UNSUPPORTED
The request contained a field that is unsupported.
result
Enumeration
=
CONDITIONAL
A system-generated high level overall result of the operation.
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ERROR
The operation resulted in an error and hence cannot be processed.
Copyright © 2023 MasterCard