Skip to content

Files

Latest commit

 

History

History
 
 

php

README.md

DigitalEnablementClient

The MDES APIs are designed as RPC style stateless web services where each API endpoint represents an operation to be performed. All request and response payloads are sent in the JSON (JavaScript Object Notation) data-interchange format. Each endpoint in the API specifies the HTTP Method used to access it. All strings in request and response objects are to be UTF-8 encoded. Each API URI includes the major and minor version of API that it conforms to. This will allow multiple concurrent versions of the API to be deployed simultaneously.
Authentication Mastercard uses OAuth 1.0a with body hash extension for authenticating the API clients. This requires every request that you send to Mastercard to be signed with an RSA private key. A private-public RSA key pair must be generated consisting of:
1 . A private key for the OAuth signature for API requests. It is recommended to keep the private key in a password-protected or hardware keystore.
2. A public key is shared with Mastercard during the project setup process through either a certificate signing request (CSR) or the API Key Generator. Mastercard will use the public key to verify the OAuth signature that is provided on every API call.

An OAUTH1.0a signer library is available on GitHub
Encryption

All communications between Issuer web service and the Mastercard gateway is encrypted using TLS.
Additional Encryption of Sensitive Data In addition to the OAuth authentication, when using MDES Digital Enablement Service, any PCI sensitive and all account holder Personally Identifiable Information (PII) data must be encrypted. This requirement applies to the API fields containing encryptedData. Sensitive data is encrypted using a symmetric session (one-time-use) key. The symmetric session key is then wrapped with an RSA Public Key supplied by Mastercard during API setup phase (the Customer Encryption Key).

Java Client Encryption Library available on GitHub

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.2.10
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/DigitalEnablementClient/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new DigitalEnablementClient\Api\DeleteApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$delete_request_schema = new \DigitalEnablementClient\Model\DeleteRequestSchema(); // \DigitalEnablementClient\Model\DeleteRequestSchema | Contains the details of the request message.

try {
    $result = $apiInstance->deleteDigitization($delete_request_schema);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeleteApi->deleteDigitization: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.mastercard.com/mdes

Class Method HTTP request Description
DeleteApi deleteDigitization POST /digitization/static/1/0/delete Used to delete one or more Tokens. The API is limited to 10 Tokens per request.
GetAssetApi getAsset GET /assets/static/1/0/asset/{AssetId} Used to retrieve static Assets from the MDES repository.
GetTaskStatusApi getTaskStatus POST /digitization/static/1/0/getTaskStatus Used to check the status of any asynchronous task that was previously requested.
GetTokenApi getToken POST /digitization/static/1/0/getToken Used to get the status and details of a single given Token.
NotifyTokenUpdatedApi notifyTokenUpdateForTokenStateChange POST /digitization/static/1/0/notifyTokenUpdated Outbound API used by MDES to notify the Token Requestor of significant Token updates, such as when the Token is activated, suspended, unsuspended or deleted; or when information about the Token or its product configuration has changed.
SearchTokensApi searchTokens POST /digitization/static/1/0/searchTokens Used to get basic token information for all tokens on a specified device, or all tokens mapped to the given Account PAN.
SuspendApi createSuspend POST /digitization/static/1/0/suspend Used to temporarily suspend one or more Tokens.
TokenizeApi createTokenize POST /digitization/static/1/0/tokenize Used to digitize a card to create a server-based Token.
TransactApi createTransact POST /remotetransaction/static/1/0/transact Used by the Token Requestor to create a Digital Secure Remote Payment (&quot;DSRP&quot;) transaction cryptogram using the credentials stored within MDES in order to perform a DSRP transaction.
UnsuspendApi createUnsuspend POST /digitization/static/1/0/unsuspend Used to unsuspend one or more previously suspended Tokens. The API is limited to 10 Tokens per request.

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author