Check Gateway
Request to check that the gateway is operating.
URL | https://test-nbkpayment.mtf.gateway.mastercard.com/api/rest/version/81/information |
HTTP Method | GET |
Authentication | None required. |
Request Parameters
There are no request parameters for this operation.
Response Parameters
gatewayVersion ASCII Text = Always Provided
Identifies the current version of the gateway platform.
Existence
Always Provided
Fixed value
Validation Rules
Data consists of ASCII characters
JSON type
String
minimum length
5
maximum length
32
status Enumeration = Always Provided
Indication of the ability of the gateway to process requests.
Existence
Always Provided
Fixed value
Validation Rules
Summarizes the ability of the gateway to perform operations.
JSON type
String
Value must be a member of the following list. The values are case sensitive.
OPERATING
The service is currently capable of processing requests.
SHUTDOWN
The service is currently not accepting requests.
gatewayVersion ASCII Text = Always Provided
Identifies the current version of the gateway platform.
Existence
Always Provided
Fixed value
Validation Rules
Data consists of ASCII characters
JSON type
String
minimum length
5
maximum length
32
status Enumeration = Always Provided
Indication of the ability of the gateway to process requests.
Existence
Always Provided
Fixed value
Validation Rules
Summarizes the ability of the gateway to perform operations.
JSON type
String
Value must be a member of the following list. The values are case sensitive.
OPERATING
The service is currently capable of processing requests.
SHUTDOWN
The service is currently not accepting requests.
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
JSON 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
JSON 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
JSON 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
JSON 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
JSON 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
JSON 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.