├── .github
└── workflows
│ └── broken-links.yml
├── .gitignore
├── LICENSE
├── README.md
├── csharp
├── .openapi-generator
│ ├── FILES
│ └── VERSION
├── Acme.App.MastercardApi.Client.Tests
│ ├── Acme.App.MastercardApi.Client.Tests.csproj
│ ├── TokenizeApiTest.cs
│ └── _Resources
│ │ ├── digital-enablement-sandbox-decryption-key.key
│ │ ├── digital-enablement-sandbox-encryption-key.crt
│ │ └── fake-signing-key.p12
├── Acme.App.MastercardApi.Client
│ ├── Acme.App.MastercardApi.Client.csproj
│ ├── Api
│ │ ├── DeleteApi.cs
│ │ ├── GetAssetApi.cs
│ │ ├── GetTaskStatusApi.cs
│ │ ├── GetTokenApi.cs
│ │ ├── NotifyTokenUpdatedApi.cs
│ │ ├── SearchTokensApi.cs
│ │ ├── SuspendApi.cs
│ │ ├── TokenizeApi.cs
│ │ ├── TransactApi.cs
│ │ └── UnsuspendApi.cs
│ ├── Client
│ │ ├── ApiClient.cs
│ │ ├── ApiException.cs
│ │ ├── ApiResponse.cs
│ │ ├── ClientUtils.cs
│ │ ├── Configuration.cs
│ │ ├── ExceptionFactory.cs
│ │ ├── GlobalConfiguration.cs
│ │ ├── HttpMethod.cs
│ │ ├── IApiAccessor.cs
│ │ ├── IAsynchronousClient.cs
│ │ ├── IReadableConfiguration.cs
│ │ ├── ISynchronousClient.cs
│ │ ├── MastercardApiClient.cs
│ │ ├── Multimap.cs
│ │ ├── OpenAPIDateConverter.cs
│ │ ├── RequestOptions.cs
│ │ └── RetryConfiguration.cs
│ └── Model
│ │ ├── AbstractOpenAPISchema.cs
│ │ ├── AccountHolderData.cs
│ │ ├── AccountHolderDataOutbound.cs
│ │ ├── AssetResponseSchema.cs
│ │ ├── AuthenticationMethods.cs
│ │ ├── BillingAddress.cs
│ │ ├── CardAccountDataInbound.cs
│ │ ├── CardAccountDataOutbound.cs
│ │ ├── DecisioningData.cs
│ │ ├── DeleteRequestSchema.cs
│ │ ├── DeleteResponseSchema.cs
│ │ ├── EncryptedPayload.cs
│ │ ├── EncryptedPayloadTransact.cs
│ │ ├── Error.cs
│ │ ├── ErrorsResponse.cs
│ │ ├── FundingAccountData.cs
│ │ ├── FundingAccountInfo.cs
│ │ ├── FundingAccountInfoEncryptedPayload.cs
│ │ ├── GatewayError.cs
│ │ ├── GatewayErrorsResponse.cs
│ │ ├── GatewayErrorsSchema.cs
│ │ ├── GetTaskStatusRequestSchema.cs
│ │ ├── GetTaskStatusResponseSchema.cs
│ │ ├── GetTokenRequestSchema.cs
│ │ ├── GetTokenResponseSchema.cs
│ │ ├── MediaContent.cs
│ │ ├── NotifyTokenEncryptedPayload.cs
│ │ ├── NotifyTokenUpdatedRequestSchema.cs
│ │ ├── NotifyTokenUpdatedResponseSchema.cs
│ │ ├── PhoneNumber.cs
│ │ ├── ProductConfig.cs
│ │ ├── SearchTokensRequestSchema.cs
│ │ ├── SearchTokensResponseSchema.cs
│ │ ├── SuspendRequestSchema.cs
│ │ ├── SuspendResponseSchema.cs
│ │ ├── Token.cs
│ │ ├── TokenDetail.cs
│ │ ├── TokenDetailData.cs
│ │ ├── TokenDetailDataGetTokenOnly.cs
│ │ ├── TokenDetailDataPAROnly.cs
│ │ ├── TokenDetailGetTokenOnly.cs
│ │ ├── TokenDetailPAROnly.cs
│ │ ├── TokenForGetToken.cs
│ │ ├── TokenForLCM.cs
│ │ ├── TokenForNTU.cs
│ │ ├── TokenInfo.cs
│ │ ├── TokenInfoForNTUAndGetToken.cs
│ │ ├── TokenizeRequestSchema.cs
│ │ ├── TokenizeResponseSchema.cs
│ │ ├── TransactEncryptedData.cs
│ │ ├── TransactError.cs
│ │ ├── TransactRequestSchema.cs
│ │ ├── TransactResponseSchema.cs
│ │ ├── UnSuspendRequestSchema.cs
│ │ └── UnSuspendResponseSchema.cs
├── Acme.App.sln
├── MDES_Digital_Enablement.yaml
├── README.md
├── config.json
├── docs
│ ├── AccountHolderData.md
│ ├── AccountHolderDataOutbound.md
│ ├── AssetResponseSchema.md
│ ├── AuthenticationMethods.md
│ ├── BillingAddress.md
│ ├── CardAccountDataInbound.md
│ ├── CardAccountDataOutbound.md
│ ├── DecisioningData.md
│ ├── DeleteApi.md
│ ├── DeleteRequestSchema.md
│ ├── DeleteResponseSchema.md
│ ├── EncryptedPayload.md
│ ├── EncryptedPayloadTransact.md
│ ├── Error.md
│ ├── ErrorsResponse.md
│ ├── FundingAccountData.md
│ ├── FundingAccountInfo.md
│ ├── FundingAccountInfoEncryptedPayload.md
│ ├── GatewayError.md
│ ├── GatewayErrorsResponse.md
│ ├── GatewayErrorsSchema.md
│ ├── GetAssetApi.md
│ ├── GetTaskStatusApi.md
│ ├── GetTaskStatusRequestSchema.md
│ ├── GetTaskStatusResponseSchema.md
│ ├── GetTokenApi.md
│ ├── GetTokenRequestSchema.md
│ ├── GetTokenResponseSchema.md
│ ├── MediaContent.md
│ ├── NotifyTokenEncryptedPayload.md
│ ├── NotifyTokenUpdatedApi.md
│ ├── NotifyTokenUpdatedRequestSchema.md
│ ├── NotifyTokenUpdatedResponseSchema.md
│ ├── PhoneNumber.md
│ ├── ProductConfig.md
│ ├── SearchTokensApi.md
│ ├── SearchTokensRequestSchema.md
│ ├── SearchTokensResponseSchema.md
│ ├── SuspendApi.md
│ ├── SuspendRequestSchema.md
│ ├── SuspendResponseSchema.md
│ ├── Token.md
│ ├── TokenDetail.md
│ ├── TokenDetailData.md
│ ├── TokenDetailDataGetTokenOnly.md
│ ├── TokenDetailDataPAROnly.md
│ ├── TokenDetailGetTokenOnly.md
│ ├── TokenDetailPAROnly.md
│ ├── TokenForGetToken.md
│ ├── TokenForLCM.md
│ ├── TokenForNTU.md
│ ├── TokenInfo.md
│ ├── TokenInfoForNTUAndGetToken.md
│ ├── TokenizeApi.md
│ ├── TokenizeRequestSchema.md
│ ├── TokenizeResponseSchema.md
│ ├── TransactApi.md
│ ├── TransactEncryptedData.md
│ ├── TransactError.md
│ ├── TransactRequestSchema.md
│ ├── TransactResponseSchema.md
│ ├── UnSuspendRequestSchema.md
│ ├── UnSuspendResponseSchema.md
│ └── UnsuspendApi.md
├── generate-api-client.sh
└── openapitools.json
├── java
├── .openapi-generator
│ ├── FILES
│ └── VERSION
├── MDES_Digital_Enablement.yaml
├── README.md
├── config.json
├── docs
│ ├── AccountHolderData.md
│ ├── AccountHolderDataOutbound.md
│ ├── AssetResponseSchema.md
│ ├── AuthenticationMethods.md
│ ├── BillingAddress.md
│ ├── CardAccountDataInbound.md
│ ├── CardAccountDataOutbound.md
│ ├── DecisioningData.md
│ ├── DeleteApi.md
│ ├── DeleteRequestSchema.md
│ ├── DeleteResponseSchema.md
│ ├── EncryptedPayload.md
│ ├── EncryptedPayloadTransact.md
│ ├── Error.md
│ ├── ErrorsResponse.md
│ ├── FundingAccountData.md
│ ├── FundingAccountInfo.md
│ ├── FundingAccountInfoEncryptedPayload.md
│ ├── GatewayError.md
│ ├── GatewayErrorsResponse.md
│ ├── GatewayErrorsSchema.md
│ ├── GetAssetApi.md
│ ├── GetTaskStatusApi.md
│ ├── GetTaskStatusRequestSchema.md
│ ├── GetTaskStatusResponseSchema.md
│ ├── GetTokenApi.md
│ ├── GetTokenRequestSchema.md
│ ├── GetTokenResponseSchema.md
│ ├── MediaContent.md
│ ├── NotifyTokenEncryptedPayload.md
│ ├── NotifyTokenUpdatedApi.md
│ ├── NotifyTokenUpdatedRequestSchema.md
│ ├── NotifyTokenUpdatedResponseSchema.md
│ ├── PhoneNumber.md
│ ├── ProductConfig.md
│ ├── SearchTokensApi.md
│ ├── SearchTokensRequestSchema.md
│ ├── SearchTokensResponseSchema.md
│ ├── SuspendApi.md
│ ├── SuspendRequestSchema.md
│ ├── SuspendResponseSchema.md
│ ├── Token.md
│ ├── TokenDetail.md
│ ├── TokenDetailData.md
│ ├── TokenDetailDataGetTokenOnly.md
│ ├── TokenDetailDataPAROnly.md
│ ├── TokenDetailGetTokenOnly.md
│ ├── TokenDetailPAROnly.md
│ ├── TokenForGetToken.md
│ ├── TokenForLCM.md
│ ├── TokenForNTU.md
│ ├── TokenInfo.md
│ ├── TokenInfoForNTUAndGetToken.md
│ ├── TokenizeApi.md
│ ├── TokenizeRequestSchema.md
│ ├── TokenizeResponseSchema.md
│ ├── TransactApi.md
│ ├── TransactEncryptedData.md
│ ├── TransactError.md
│ ├── TransactRequestSchema.md
│ ├── TransactResponseSchema.md
│ ├── UnSuspendRequestSchema.md
│ ├── UnSuspendResponseSchema.md
│ └── UnsuspendApi.md
├── generate-api-client.sh
├── openapitools.json
├── pom.xml
└── src
│ ├── main
│ └── java
│ │ └── com
│ │ └── mastercard
│ │ └── developer
│ │ └── mdes_digital_enablement_client
│ │ ├── ApiCallback.java
│ │ ├── ApiClient.java
│ │ ├── ApiException.java
│ │ ├── ApiResponse.java
│ │ ├── Configuration.java
│ │ ├── GzipRequestInterceptor.java
│ │ ├── JSON.java
│ │ ├── Pair.java
│ │ ├── ProgressRequestBody.java
│ │ ├── ProgressResponseBody.java
│ │ ├── ServerConfiguration.java
│ │ ├── ServerVariable.java
│ │ ├── StringUtil.java
│ │ ├── api
│ │ ├── DeleteApi.java
│ │ ├── GetAssetApi.java
│ │ ├── GetTaskStatusApi.java
│ │ ├── GetTokenApi.java
│ │ ├── NotifyTokenUpdatedApi.java
│ │ ├── SearchTokensApi.java
│ │ ├── SuspendApi.java
│ │ ├── TokenizeApi.java
│ │ ├── TransactApi.java
│ │ └── UnsuspendApi.java
│ │ ├── auth
│ │ ├── ApiKeyAuth.java
│ │ ├── Authentication.java
│ │ ├── HttpBasicAuth.java
│ │ └── HttpBearerAuth.java
│ │ └── model
│ │ ├── AbstractOpenApiSchema.java
│ │ ├── AccountHolderData.java
│ │ ├── AccountHolderDataOutbound.java
│ │ ├── AssetResponseSchema.java
│ │ ├── AuthenticationMethods.java
│ │ ├── BillingAddress.java
│ │ ├── CardAccountDataInbound.java
│ │ ├── CardAccountDataOutbound.java
│ │ ├── DecisioningData.java
│ │ ├── DeleteRequestSchema.java
│ │ ├── DeleteResponseSchema.java
│ │ ├── EncryptedPayload.java
│ │ ├── EncryptedPayloadTransact.java
│ │ ├── Error.java
│ │ ├── ErrorsResponse.java
│ │ ├── FundingAccountData.java
│ │ ├── FundingAccountInfo.java
│ │ ├── FundingAccountInfoEncryptedPayload.java
│ │ ├── GatewayError.java
│ │ ├── GatewayErrorsResponse.java
│ │ ├── GatewayErrorsSchema.java
│ │ ├── GetTaskStatusRequestSchema.java
│ │ ├── GetTaskStatusResponseSchema.java
│ │ ├── GetTokenRequestSchema.java
│ │ ├── GetTokenResponseSchema.java
│ │ ├── MediaContent.java
│ │ ├── NotifyTokenEncryptedPayload.java
│ │ ├── NotifyTokenUpdatedRequestSchema.java
│ │ ├── NotifyTokenUpdatedResponseSchema.java
│ │ ├── PhoneNumber.java
│ │ ├── ProductConfig.java
│ │ ├── SearchTokensRequestSchema.java
│ │ ├── SearchTokensResponseSchema.java
│ │ ├── SuspendRequestSchema.java
│ │ ├── SuspendResponseSchema.java
│ │ ├── Token.java
│ │ ├── TokenDetail.java
│ │ ├── TokenDetailData.java
│ │ ├── TokenDetailDataGetTokenOnly.java
│ │ ├── TokenDetailDataPAROnly.java
│ │ ├── TokenDetailGetTokenOnly.java
│ │ ├── TokenDetailPAROnly.java
│ │ ├── TokenForGetToken.java
│ │ ├── TokenForLCM.java
│ │ ├── TokenForNTU.java
│ │ ├── TokenInfo.java
│ │ ├── TokenInfoForNTUAndGetToken.java
│ │ ├── TokenizeRequestSchema.java
│ │ ├── TokenizeResponseSchema.java
│ │ ├── TransactEncryptedData.java
│ │ ├── TransactError.java
│ │ ├── TransactRequestSchema.java
│ │ ├── TransactResponseSchema.java
│ │ ├── UnSuspendRequestSchema.java
│ │ └── UnSuspendResponseSchema.java
│ └── test
│ ├── java
│ └── com
│ │ └── mastercard
│ │ └── developer
│ │ └── mdes_digital_enablement_client
│ │ └── api
│ │ └── TokenizeApiTest.java
│ └── resources
│ ├── digital-enablement-sandbox-decryption-key.key
│ ├── digital-enablement-sandbox-encryption-key.crt
│ └── fake-signing-key.p12
├── nodejs
├── .babelrc
├── .openapi-generator
│ ├── FILES
│ └── VERSION
├── MDES_Digital_Enablement.yaml
├── README.md
├── config.json
├── docs
│ ├── AccountHolderData.md
│ ├── AccountHolderDataOutbound.md
│ ├── AssetResponseSchema.md
│ ├── AuthenticationMethods.md
│ ├── BillingAddress.md
│ ├── CardAccountDataInbound.md
│ ├── CardAccountDataOutbound.md
│ ├── DecisioningData.md
│ ├── DeleteApi.md
│ ├── DeleteRequestSchema.md
│ ├── DeleteResponseSchema.md
│ ├── EncryptedPayload.md
│ ├── EncryptedPayloadTransact.md
│ ├── Error.md
│ ├── ErrorsResponse.md
│ ├── FundingAccountData.md
│ ├── FundingAccountInfo.md
│ ├── FundingAccountInfoEncryptedPayload.md
│ ├── GatewayError.md
│ ├── GatewayErrorsResponse.md
│ ├── GatewayErrorsSchema.md
│ ├── GetAssetApi.md
│ ├── GetTaskStatusApi.md
│ ├── GetTaskStatusRequestSchema.md
│ ├── GetTaskStatusResponseSchema.md
│ ├── GetTokenApi.md
│ ├── GetTokenRequestSchema.md
│ ├── GetTokenResponseSchema.md
│ ├── MediaContent.md
│ ├── NotifyTokenEncryptedPayload.md
│ ├── NotifyTokenUpdatedApi.md
│ ├── NotifyTokenUpdatedRequestSchema.md
│ ├── NotifyTokenUpdatedResponseSchema.md
│ ├── PhoneNumber.md
│ ├── ProductConfig.md
│ ├── SearchTokensApi.md
│ ├── SearchTokensRequestSchema.md
│ ├── SearchTokensResponseSchema.md
│ ├── SuspendApi.md
│ ├── SuspendRequestSchema.md
│ ├── SuspendResponseSchema.md
│ ├── Token.md
│ ├── TokenDetail.md
│ ├── TokenDetailData.md
│ ├── TokenDetailDataGetTokenOnly.md
│ ├── TokenDetailDataPAROnly.md
│ ├── TokenDetailGetTokenOnly.md
│ ├── TokenDetailPAROnly.md
│ ├── TokenForGetToken.md
│ ├── TokenForLCM.md
│ ├── TokenForNTU.md
│ ├── TokenInfo.md
│ ├── TokenInfoForNTUAndGetToken.md
│ ├── TokenizeApi.md
│ ├── TokenizeRequestSchema.md
│ ├── TokenizeResponseSchema.md
│ ├── TransactApi.md
│ ├── TransactEncryptedData.md
│ ├── TransactError.md
│ ├── TransactRequestSchema.md
│ ├── TransactResponseSchema.md
│ ├── UnSuspendRequestSchema.md
│ ├── UnSuspendResponseSchema.md
│ └── UnsuspendApi.md
├── generate-api-client.sh
├── mocha.opts
├── package-lock.json
├── package.json
├── src
│ ├── ApiClient.js
│ ├── api
│ │ ├── DeleteApi.js
│ │ ├── GetAssetApi.js
│ │ ├── GetTaskStatusApi.js
│ │ ├── GetTokenApi.js
│ │ ├── NotifyTokenUpdatedApi.js
│ │ ├── SearchTokensApi.js
│ │ ├── SuspendApi.js
│ │ ├── TokenizeApi.js
│ │ ├── TransactApi.js
│ │ └── UnsuspendApi.js
│ ├── index.js
│ └── model
│ │ ├── AccountHolderData.js
│ │ ├── AccountHolderDataOutbound.js
│ │ ├── AssetResponseSchema.js
│ │ ├── AuthenticationMethods.js
│ │ ├── BillingAddress.js
│ │ ├── CardAccountDataInbound.js
│ │ ├── CardAccountDataOutbound.js
│ │ ├── DecisioningData.js
│ │ ├── DeleteRequestSchema.js
│ │ ├── DeleteResponseSchema.js
│ │ ├── EncryptedPayload.js
│ │ ├── EncryptedPayloadTransact.js
│ │ ├── Error.js
│ │ ├── ErrorsResponse.js
│ │ ├── FundingAccountData.js
│ │ ├── FundingAccountInfo.js
│ │ ├── FundingAccountInfoEncryptedPayload.js
│ │ ├── GatewayError.js
│ │ ├── GatewayErrorsResponse.js
│ │ ├── GatewayErrorsSchema.js
│ │ ├── GetTaskStatusRequestSchema.js
│ │ ├── GetTaskStatusResponseSchema.js
│ │ ├── GetTokenRequestSchema.js
│ │ ├── GetTokenResponseSchema.js
│ │ ├── MediaContent.js
│ │ ├── NotifyTokenEncryptedPayload.js
│ │ ├── NotifyTokenUpdatedRequestSchema.js
│ │ ├── NotifyTokenUpdatedResponseSchema.js
│ │ ├── PhoneNumber.js
│ │ ├── ProductConfig.js
│ │ ├── SearchTokensRequestSchema.js
│ │ ├── SearchTokensResponseSchema.js
│ │ ├── SuspendRequestSchema.js
│ │ ├── SuspendResponseSchema.js
│ │ ├── Token.js
│ │ ├── TokenDetail.js
│ │ ├── TokenDetailData.js
│ │ ├── TokenDetailDataGetTokenOnly.js
│ │ ├── TokenDetailDataPAROnly.js
│ │ ├── TokenDetailGetTokenOnly.js
│ │ ├── TokenDetailPAROnly.js
│ │ ├── TokenForGetToken.js
│ │ ├── TokenForLCM.js
│ │ ├── TokenForNTU.js
│ │ ├── TokenInfo.js
│ │ ├── TokenInfoForNTUAndGetToken.js
│ │ ├── TokenizeRequestSchema.js
│ │ ├── TokenizeResponseSchema.js
│ │ ├── TransactEncryptedData.js
│ │ ├── TransactError.js
│ │ ├── TransactRequestSchema.js
│ │ ├── TransactResponseSchema.js
│ │ ├── UnSuspendRequestSchema.js
│ │ └── UnSuspendResponseSchema.js
└── test
│ ├── api
│ └── TokenizeApi.spec.js
│ └── resources
│ ├── digital-enablement-sandbox-decryption-key.key
│ ├── digital-enablement-sandbox-encryption-key.crt
│ └── fake-signing-key.p12
└── python
├── .gitignore
├── .openapi-generator
├── FILES
└── VERSION
├── MDES_Digital_Enablement.yaml
├── README.md
├── docs
├── AccountHolderData.md
├── AccountHolderDataOutbound.md
├── AssetResponseSchema.md
├── AuthenticationMethods.md
├── BillingAddress.md
├── CardAccountDataInbound.md
├── CardAccountDataOutbound.md
├── DecisioningData.md
├── DeleteApi.md
├── DeleteRequestSchema.md
├── DeleteResponseSchema.md
├── EncryptedPayload.md
├── EncryptedPayloadTransact.md
├── Error.md
├── ErrorsResponse.md
├── FundingAccountData.md
├── FundingAccountInfo.md
├── FundingAccountInfoEncryptedPayload.md
├── GatewayError.md
├── GatewayErrorsResponse.md
├── GatewayErrorsSchema.md
├── GetAssetApi.md
├── GetTaskStatusApi.md
├── GetTaskStatusRequestSchema.md
├── GetTaskStatusResponseSchema.md
├── GetTokenApi.md
├── GetTokenRequestSchema.md
├── GetTokenResponseSchema.md
├── MediaContent.md
├── NotifyTokenEncryptedPayload.md
├── NotifyTokenUpdatedApi.md
├── NotifyTokenUpdatedRequestSchema.md
├── NotifyTokenUpdatedResponseSchema.md
├── PhoneNumber.md
├── ProductConfig.md
├── SearchTokensApi.md
├── SearchTokensRequestSchema.md
├── SearchTokensResponseSchema.md
├── SuspendApi.md
├── SuspendRequestSchema.md
├── SuspendResponseSchema.md
├── Token.md
├── TokenDetail.md
├── TokenDetailData.md
├── TokenDetailDataGetTokenOnly.md
├── TokenDetailDataPAROnly.md
├── TokenDetailGetTokenOnly.md
├── TokenDetailPAROnly.md
├── TokenForGetToken.md
├── TokenForLCM.md
├── TokenForNTU.md
├── TokenInfo.md
├── TokenInfoForNTUAndGetToken.md
├── TokenizeApi.md
├── TokenizeRequestSchema.md
├── TokenizeResponseSchema.md
├── TransactApi.md
├── TransactEncryptedData.md
├── TransactError.md
├── TransactRequestSchema.md
├── TransactResponseSchema.md
├── UnSuspendRequestSchema.md
├── UnSuspendResponseSchema.md
└── UnsuspendApi.md
├── generate-api-client.sh
├── openapi_client
├── __init__.py
├── api
│ ├── __init__.py
│ ├── delete_api.py
│ ├── get_asset_api.py
│ ├── get_task_status_api.py
│ ├── get_token_api.py
│ ├── notify_token_updated_api.py
│ ├── search_tokens_api.py
│ ├── suspend_api.py
│ ├── tokenize_api.py
│ ├── transact_api.py
│ └── unsuspend_api.py
├── api_client.py
├── apis
│ └── __init__.py
├── configuration.py
├── exceptions.py
├── model
│ ├── __init__.py
│ ├── account_holder_data.py
│ ├── account_holder_data_outbound.py
│ ├── asset_response_schema.py
│ ├── authentication_methods.py
│ ├── billing_address.py
│ ├── card_account_data_inbound.py
│ ├── card_account_data_outbound.py
│ ├── decisioning_data.py
│ ├── delete_request_schema.py
│ ├── delete_response_schema.py
│ ├── encrypted_payload.py
│ ├── encrypted_payload_transact.py
│ ├── error.py
│ ├── errors_response.py
│ ├── funding_account_data.py
│ ├── funding_account_info.py
│ ├── funding_account_info_encrypted_payload.py
│ ├── gateway_error.py
│ ├── gateway_errors_response.py
│ ├── gateway_errors_schema.py
│ ├── get_task_status_request_schema.py
│ ├── get_task_status_response_schema.py
│ ├── get_token_request_schema.py
│ ├── get_token_response_schema.py
│ ├── media_content.py
│ ├── notify_token_encrypted_payload.py
│ ├── notify_token_updated_request_schema.py
│ ├── notify_token_updated_response_schema.py
│ ├── phone_number.py
│ ├── product_config.py
│ ├── search_tokens_request_schema.py
│ ├── search_tokens_response_schema.py
│ ├── suspend_request_schema.py
│ ├── suspend_response_schema.py
│ ├── token.py
│ ├── token_detail.py
│ ├── token_detail_data.py
│ ├── token_detail_data_get_token_only.py
│ ├── token_detail_data_par_only.py
│ ├── token_detail_get_token_only.py
│ ├── token_detail_par_only.py
│ ├── token_for_get_token.py
│ ├── token_for_lcm.py
│ ├── token_for_ntu.py
│ ├── token_info.py
│ ├── token_info_for_ntu_and_get_token.py
│ ├── tokenize_request_schema.py
│ ├── tokenize_response_schema.py
│ ├── transact_encrypted_data.py
│ ├── transact_error.py
│ ├── transact_request_schema.py
│ ├── transact_response_schema.py
│ ├── un_suspend_request_schema.py
│ └── un_suspend_response_schema.py
├── model_utils.py
├── models
│ └── __init__.py
└── rest.py
├── requirements.txt
├── setup.cfg
├── setup.py
├── test-requirements.txt
├── test
├── __init__.py
├── resources
│ └── fle_config.json
└── test_tokenize_api.py
└── tox.ini
/.github/workflows/broken-links.yml:
--------------------------------------------------------------------------------
1 | on:
2 | push:
3 | branches: main
4 | schedule:
5 | - cron: "0 16 * * *"
6 | name: broken links?
7 | jobs:
8 | linkChecker:
9 | runs-on: ubuntu-latest
10 | steps:
11 | - uses: actions/checkout@v2
12 | - name: Link Checker
13 | id: lc
14 | uses: peter-evans/link-checker@v1.2.2
15 | with:
16 | args: -v ./README.md ./csharp/README.md ./java/README.md ./nodejs/README.md ./php/README.md ./python/README.md ./ruby/README.md -x (GIT_REPO_ID|api.mastercard.com)
17 | - name: Fail?
18 | run: exit ${{ steps.lc.outputs.exit_code }}
19 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | #
2 | # OpenAPI generator
3 | #
4 | **/.openapi-generator-ignore
5 | **/git_push.sh
6 | **/.gitignore
7 | **/.travis.yml
8 |
9 | #
10 | # C#
11 | #
12 | **/*.sln
13 | **/AssemblyInfo.cs
14 | **/project.json
15 | **/.vs
16 | **/obj
17 | **/bin
18 | **/*.nuget.cache
19 | **/*.nuget.props
20 |
21 | #
22 | # Java
23 | #
24 | **/.idea
25 | **/target
26 | **/.gradle
27 | **/build
28 |
29 | #
30 | # PHP
31 | #
32 | **/vendor
33 | **/*.iml
34 | **/out.trace
35 | **/.phpunit.result.cache
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2019-2021 Mastercard
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Generating and Configuring a Mastercard API Client
2 | [](https://developer.mastercard.com/)
3 |
4 | [](https://github.com/Mastercard/mastercard-api-client-tutorial/actions?query=workflow%3A%22broken+links%3F%22)
5 | [](https://github.com/Mastercard/mastercard-api-client-tutorial/blob/master/LICENSE)
6 |
7 | [Generating and Configuring a Mastercard API Client](https://developer.mastercard.com/platform/documentation/security-and-authentication/generating-and-configuring-a-mastercard-api-client/) explains how to generate and configure simple API clients for consuming APIs offered on the [Mastercard Developer portal](https://developer.mastercard.com/apis).
8 |
9 | Languages used in this tutorial: Java, Python, NodeJS, and C#.
10 |
--------------------------------------------------------------------------------
/csharp/.openapi-generator/VERSION:
--------------------------------------------------------------------------------
1 | 7.5.0
2 |
--------------------------------------------------------------------------------
/csharp/Acme.App.MastercardApi.Client.Tests/Acme.App.MastercardApi.Client.Tests.csproj:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | netcoreapp3.1
5 |
6 | false
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 | Always
20 |
21 |
22 | Always
23 |
24 |
25 | Always
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
--------------------------------------------------------------------------------
/csharp/Acme.App.MastercardApi.Client.Tests/_Resources/digital-enablement-sandbox-decryption-key.key:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Mastercard/mastercard-api-client-tutorial/5f884c764152164271d4ce8efdaf89060e2975b7/csharp/Acme.App.MastercardApi.Client.Tests/_Resources/digital-enablement-sandbox-decryption-key.key
--------------------------------------------------------------------------------
/csharp/Acme.App.MastercardApi.Client.Tests/_Resources/digital-enablement-sandbox-encryption-key.crt:
--------------------------------------------------------------------------------
1 | -----BEGIN CERTIFICATE-----
2 | MIIEZDCCA0ygAwIBAgIQQUmirRSB0Og8AbLmOXxo/DANBgkqhkiG9w0BAQUFADCB
3 | rjETMBEGCgmSJomT8ixkARkWA2NvbTEaMBgGCgmSJomT8ixkARkWCm1hc3RlcmNh
4 | cmQxHTAbBgNVBAoTFE1hc3RlckNhcmQgV29ybGRXaWRlMSQwIgYDVQQLExtHbG9i
5 | YWwgSW5mb3JtYXRpb24gU2VjdXJpdHkxNjA0BgNVBAMTLVBSRCBNQyBQcm9kdWN0
6 | aW9uIE5ldHdvcmsgQXBwbGljYXRpb25zIHN1YiBDQTAeFw0xNjAxMDUwODEwMzJa
7 | Fw0yMDAxMDMyMzA2MjBaMIHKMUcwRQYDVQQDEz5XcmFwcGluZyBLZXkgLSBUb2tl
8 | bml6YXRpb24gQVBJIFNhbmRib3ggRW5jcnlwdCAtIE1ERVMgRGVjcnlwdDETMBEG
9 | A1UECxMKTURFUyAtIE1URjE0MDIGA1UEChMrTWFzdGVyQ2FyZCBXb3JsZFdpZGUg
10 | LSBDb21tb24gUHJvZEluZnJhIFNTTDEUMBIGA1UEBxMLU2FpbnQgTG91aXMxETAP
11 | BgNVBAgTCE1pc3NvdXJpMQswCQYDVQQGEwJVUzCCASIwDQYJKoZIhvcNAQEBBQAD
12 | ggEPADCCAQoCggEBALMQmc1tg4Olwn15Zu20Ojxn10U5p/IwhM7oXZTC+p1LnCYl
13 | A0So+R1BOXaCRqCJvVxprJW2l1nBJ/mBcPP1B0V8OoQErYDFQoBzxnbf6aRdoJ7Y
14 | L/OBb1GYOvFoDtE4+iGvW9sCHD0uYHiOhYFm5JsJ24Tq9qj0xEo/2qcqcpibBnzE
15 | EqxUaaIyurbzGSTctohq2fnuj8jLt87r9JBXlV5Jb1oKMK3sR7zRz6l6oip6bgfy
16 | tHyonQAqbuxuhKj7IqFjE+UyEos5anhP+gKB+PUm59BDI9KKik9xiLhzOL8JSNYG
17 | 1Vew0QFFr5dpjc4ZAEDgcp8g/fpgkbKHUzwIdhECAwEAAaNgMF4wHwYDVR0jBBgw
18 | FoAUPeXQ5iyKbL1ne56Kq3GEPOrclQUwDAYDVR0TBAUwAwIBADAOBgNVHQ8BAf8E
19 | BAMCBaAwHQYDVR0OBBYEFOqIblm9zwz+xo1K9WzEZ0MI8asSMA0GCSqGSIb3DQEB
20 | BQUAA4IBAQCMcAHSlE8N4r0yvtNU4R2qhlmDltBjv63XADjNSRxYzdtkgq/4Cbjg
21 | iLqNGKbkkba9hDsUcjRzTe86lnRL7HG1M5j0lV5b6i0nHaQEjDcdOfTwfOkCyP9a
22 | RD08POGA8tday45pBvegMLwNudDNZ5Rhc4LVbyHNxF0NNCIsXCzqpQoQ3FV6A3/8
23 | /fV7Fwj1vKxZVtvh7cjZwlArfE9BncDD2X5FBKdIUxYmhq8AeFHUZiLwBK0DLRpo
24 | E7nKUQ6KkgSG4YF3r7XuF+WTJAF4wdb2Opt7BY7kj/WHuxU+gps3qO1JwkvYcKrF
25 | 2r2MYyNJqNB/esCUspOtA8vMNS/WmhB4
26 | -----END CERTIFICATE-----
--------------------------------------------------------------------------------
/csharp/Acme.App.MastercardApi.Client.Tests/_Resources/fake-signing-key.p12:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Mastercard/mastercard-api-client-tutorial/5f884c764152164271d4ce8efdaf89060e2975b7/csharp/Acme.App.MastercardApi.Client.Tests/_Resources/fake-signing-key.p12
--------------------------------------------------------------------------------
/csharp/Acme.App.MastercardApi.Client/Client/MastercardApiClient.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Security.Cryptography;
3 | using Mastercard.Developer.ClientEncryption.Core.Encryption;
4 | using Mastercard.Developer.ClientEncryption.RestSharpV2.Interceptors;
5 | using Mastercard.Developer.OAuth1Signer.RestSharpV2.Signers;
6 | using RestSharp;
7 |
8 | namespace Acme.App.MastercardApi.Client.Client
9 | {
10 | partial class ApiClient
11 | {
12 | private readonly Uri _basePath;
13 | private readonly RestSharpSigner _signer;
14 | private readonly RestSharpEncryptionInterceptor _encryptionInterceptor;
15 |
16 | ///
17 | /// Construct an ApiClient which will automatically:
18 | /// - Sign requests
19 | /// - Encrypt/decrypt requests and responses
20 | ///
21 | public ApiClient(RSA signingKey, string basePath, string consumerKey, EncryptionConfig config)
22 | {
23 | _baseUrl = basePath;
24 | _basePath = new Uri(basePath);
25 | _signer = new RestSharpSigner(consumerKey, signingKey);
26 | _encryptionInterceptor = RestSharpEncryptionInterceptor.From(config);
27 | }
28 |
29 | partial void InterceptRequest(RestRequest request)
30 | {
31 | _encryptionInterceptor.InterceptRequest(request);
32 | _signer.Sign(_basePath, request);
33 | }
34 | }
35 | }
36 |
--------------------------------------------------------------------------------
/csharp/config.json:
--------------------------------------------------------------------------------
1 | {
2 | "targetFramework" : "netstandard2.0",
3 | "packageName" : "Acme.App.MastercardApi.Client",
4 | "packageVersion" : "1.0.0",
5 | "sourceFolder" : "",
6 | "netCoreProjectFile": true,
7 | "optionalAssemblyInfo": false
8 | }
9 |
--------------------------------------------------------------------------------
/csharp/docs/AccountHolderData.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.AccountHolderData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **AccountHolderName** | **string** | **(OPTIONAL)** The name of the cardholder in the format LASTNAME/FIRSTNAME or FIRSTNAME LASTNAME | [optional]
8 | **AccountHolderAddress** | [**BillingAddress**](BillingAddress.md) | | [optional]
9 | **ConsumerIdentifier** | **string** | **(OPTIONAL)** Customer Identifier that may be required in some regions. | [optional]
10 | **AccountHolderEmailAddress** | **string** | **(OPTIONAL)** The e-mail address of the Account Holder | [optional]
11 | **AccountHolderMobilePhoneNumber** | [**PhoneNumber**](PhoneNumber.md) | | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/csharp/docs/AccountHolderDataOutbound.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.AccountHolderDataOutbound
2 | **(CONDITIONAL)** Present in tokenize response if supported by the Merchant, if using a pushAccountReceipt and if there is account holder data associated with the pushAccountReceipt in case that the issuer decision is APPROVED. Refer to MDES Token Connect Token Requestor Implementation Guide and Specification for more details.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **AccountHolderName** | **string** | **(OPTIONAL)** The name of the cardholder | [optional]
9 | **AccountHolderAddress** | [**BillingAddress**](BillingAddress.md) | | [optional]
10 | **AccountHolderEmailAddress** | **string** | **(OPTIONAL)** The e-mail address of the Account Holder | [optional]
11 | **AccountHolderMobilePhoneNumber** | [**PhoneNumber**](PhoneNumber.md) | | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/csharp/docs/AssetResponseSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.AssetResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **MediaContents** | [**List<MediaContent>**](MediaContent.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/csharp/docs/AuthenticationMethods.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.AuthenticationMethods
2 | \"authenticationMethods not currently used for MDES for Merchants\"
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **Id** | **int** | Unique identifier assigned to this Authentication Method. | [optional]
9 | **Type** | **string** | Specifies the authentication method type and provided in the tokenize response. See table here - https://developer.mastercard.com/mdes-digital-enablement/documentation/code-and-formats/#authentication-method-codes | [optional]
10 | **Value** | **string** | Specifies the authentication method value (meaning varies depending on the authentication method type). | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/csharp/docs/BillingAddress.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.BillingAddress
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Line1** | **string** | **(OPTIONAL)** The first line of the street address for the billing address. | [optional]
8 | **Line2** | **string** | **(OPTIONAL)** The second line of the street address for the billing address. | [optional]
9 | **City** | **string** | **(OPTIONAL)** The city of the billing address. | [optional]
10 | **CountrySubdivision** | **string** | **(OPTIONAL)** The state or country subdivision of the billing address. | [optional]
11 | **PostalCode** | **string** | **(OPTIONAL)** The postal of code of the billing address. | [optional]
12 | **Country** | **string** | **(OPTIONAL)** The country of the billing address. | [optional]
13 |
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 |
16 |
--------------------------------------------------------------------------------
/csharp/docs/CardAccountDataInbound.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.CardAccountDataInbound
2 | **(CONDITIONAL)** Required in Tokenize or Search Tokens unless a valid panUniqueReference, tokenUniqueReference or pushAccountReceipt is also given in FundingAccountInfo.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **AccountNumber** | **string** | The account number of the credit or debit card. **(CONDITIONAL)** required in a Tokenize, or Get Digital Asset request, unless a valid panUniqueReference or tokenUniqueReference or pushAccountReceipt was given in FundingAccountInfo. **NOTE**:Only 6 digits can be supplied in SearchTokens if the TokenUniqueReference is provided in fundingAccountInfo. | [optional]
9 | **ExpiryMonth** | **string** | The expiry month for the account. Two numeric digits must be supplied. Only supplied in tokenization requests if panUniqueReference or tokenUniqueReferenceForPanInfo or pushAccountReceipt is not present. **Format: MM** | [optional]
10 | **ExpiryYear** | **string** | **(Required as minimum for Tokenization)** The expiry year for the account. Only supplied in tokenization requests if panUniqueReference or tokenUniqueReferenceForPanInfo or pushAccountReceipt is not present. **Format: YY** | [optional]
11 | **SecurityCode** | **string** | **(OPTIONAL)** The security code for the account can optionally be provided for Tokenization. If provided, the validity will be checked. Optional in a Tokenize request, not present otherwise. | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/csharp/docs/CardAccountDataOutbound.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.CardAccountDataOutbound
2 | **(CONDITIONAL)** The credit or debit card information for the account that is being tokenized. Present in tokenize response if supported by the Token Requestor, if using a pushAccountReceipt and if there is a card account associated with the pushAccountReceipt in case that the issuer decision is not DECLINED.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **AccountNumber** | **string** | The account number of the credit or debit card. | [optional]
9 | **ExpiryMonth** | **string** | The expiry month for the account. Two numeric digits must be supplied. **Format: MM** | [optional]
10 | **ExpiryYear** | **string** | **(Required as minimum for Tokenization)** The expiry year for the account. **Format: YY** | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/csharp/docs/DeleteResponseSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.DeleteResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ResponseHost** | **string** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **ResponseId** | **string** | Unique identifier for the response. | [optional]
9 | **Tokens** | [**List<TokenForLCM>**](TokenForLCM.md) | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/csharp/docs/EncryptedPayload.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.EncryptedPayload
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **PublicKeyFingerprint** | **string** | The fingerprint of the public key used to encrypt the ephemeral AES key. |
8 | **EncryptedKey** | **string** | One-time use AES key encrypted by the MasterCard public key (as identified by publicKeyFingerprint) using the OAEP or PKCS#1 v1.5 scheme (depending on the value of oaepHashingAlgorithm. |
9 | **OaepHashingAlgorithm** | **string** | Hashing algorithm used with the OAEP scheme. Must be either SHA256 or SHA512. | [optional]
10 | **Iv** | **string** | The initialization vector used when encrypting data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. If not present, an IV of zero is assumed. Length - 32. | [optional]
11 | **EncryptedData** | [**NotifyTokenEncryptedPayload**](NotifyTokenEncryptedPayload.md) | |
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/csharp/docs/EncryptedPayloadTransact.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.EncryptedPayloadTransact
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **PublicKeyFingerprint** | **string** | The fingerprint of the public key used to encrypt the ephemeral AES key. | [optional]
8 | **EncryptedKey** | **string** | One-time use AES key encrypted by the MasterCard public key (as identified by publicKeyFingerprint) using the OAEP or PKCS#1 v1.5 scheme (depending on the value of oaepHashingAlgorithm. | [optional]
9 | **OaepHashingAlgorithm** | **string** | Hashing algorithm used with the OAEP scheme. Must be either SHA256 or SHA512. | [optional]
10 | **Iv** | **string** | The initialization vector used when encrypting data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. If not present, an IV of zero is assumed. | [optional]
11 | **EncryptedData** | [**TransactEncryptedData**](TransactEncryptedData.md) | | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/csharp/docs/Error.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.Error
2 | Only returned in the event of an error condition.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **Source** | **string** | An element used to indicate the source of the issue causing this error. Must be one of * 'MDES' * 'INPUT' | [optional]
9 | **ErrorCode** | **string** | An error code generated by the gateway if the error occurs before reaching the MDES application. maxLength: 100 | [optional]
10 | **Description** | **string** | Description of the reason the operation failed. See API Response Errors | [optional]
11 | **ReasonCode** | **string** | A reason code for the error that has occurred. | [optional]
12 | **Recoverable** | **bool** | Generated by the gateway to indicate if the request could presented again for processing. Either \"TRUE\" or \"FALSE\" | [optional]
13 |
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 |
16 |
--------------------------------------------------------------------------------
/csharp/docs/ErrorsResponse.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.ErrorsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ErrorCode** | **string** | **CONDITIONAL** Returned in the event of an error and contains the reason the operation failed. Only use if errors object is not present. | [optional]
8 | **ErrorDescription** | **string** | **CONDITIONAL** Returned in the event of an error and contains a description of why the operation failed. Only use if errors object is not present. | [optional]
9 | **ResponseHost** | **string** | The MasterCard host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
10 | **ResponseId** | **string** | Unique identifier for the response. | [optional]
11 | **Errors** | [**Error**](Error.md) | | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/csharp/docs/FundingAccountData.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.FundingAccountData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **CardAccountData** | [**CardAccountDataInbound**](CardAccountDataInbound.md) | | [optional]
8 | **AccountHolderData** | [**AccountHolderData**](AccountHolderData.md) | | [optional]
9 | **Source** | **string** | (**Required as minimum for Tokenization**) The source of the account. Must be one of * ACCOUNT_ON_FILE * ACCOUNT_ADDED_MANUALLY * ACCOUNT_ADDED_VIA_APPLICATION | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/csharp/docs/FundingAccountInfo.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.FundingAccountInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **PanUniqueReference** | **string** | **(CONDITIONAL)** For repeat digitizations, the unique reference allocated to the Primary Account Number. When supplied, the tokenUniqueReferenceForPanInfo, accountNumber, expiryMonth and expiryYear must be omitted from CardInfoData. Only allowed if Only allowed if tokenUniqueReference and pushAccountReceipt are not present and encrypted data does not contain the account information. | [optional]
8 | **TokenUniqueReference** | **string** | **(CONDITIONAL)** A unique reference assigned following the allocation of a token used to identify the token for the duration of its lifetime. For repeat digitizations, the unique reference allocated to the token will be used to retrieve the financial account information. When supplied, the account information is omitted from FundingAccountData. Only allowed if panUniqueReference and pushAccountReceipt are not present and encrypted data does not contain the account information. | [optional]
9 | **EncryptedPayload** | [**FundingAccountInfoEncryptedPayload**](FundingAccountInfoEncryptedPayload.md) | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/csharp/docs/FundingAccountInfoEncryptedPayload.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.FundingAccountInfoEncryptedPayload
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **PublicKeyFingerprint** | **string** | The fingerprint of the public key used to encrypt the ephemeral AES key. | [optional]
8 | **EncryptedKey** | **string** | One-time use AES key encrypted by the MasterCard public key (as identified by publicKeyFingerprint) using the OAEP or PKCS#1 v1.5 scheme (depending on the value of oaepHashingAlgorithm. | [optional]
9 | **OaepHashingAlgorithm** | **string** | Hashing algorithm used with the OAEP scheme. Must be either SHA256 or SHA512. | [optional]
10 | **Iv** | **string** | The initialization vector used when encrypting data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. If not present, an IV of zero is assumed. | [optional]
11 | **EncryptedData** | [**FundingAccountData**](FundingAccountData.md) | | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/csharp/docs/GatewayError.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.GatewayError
2 | Only returned in the event of an error condition.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **Source** | **string** | An element used to indicate the source of the issue causing this error. e.g. Gateway | [optional]
9 | **Description** | **string** | Description of the reason the operation failed. See API Response Errors | [optional]
10 | **ReasonCode** | **string** | A reason code for the error that has occurred. | [optional]
11 | **Recoverable** | **bool** | Generated by the gateway to indicate if the request could presented again for processing. Either \"TRUE\" or \"FALSE\" | [optional]
12 | **Details** | **bool** | Always NULL, present for backwards compatiility | [optional]
13 |
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 |
16 |
--------------------------------------------------------------------------------
/csharp/docs/GatewayErrorsResponse.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.GatewayErrorsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Errors** | [**GatewayErrorsSchema**](GatewayErrorsSchema.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/csharp/docs/GatewayErrorsSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.GatewayErrorsSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Error** | [**List<GatewayError>**](GatewayError.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/csharp/docs/GetTaskStatusRequestSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.GetTaskStatusRequestSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ResponseHost** | **string** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **RequestId** | **string** | Unique identifier for the request. |
9 | **TokenRequestorId** | **string** | 11-digit numeric ID provided by Mastercard that identifies the Token Requestor. |
10 | **TaskId** | **string** | Unique identifier for this task. Must be an identifier previously used when requesting a task. |
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/csharp/docs/GetTaskStatusResponseSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.GetTaskStatusResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ResponseId** | **string** | Unique identifier for the response. | [optional]
8 | **ResponseHost** | **string** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
9 | **Status** | **string** | The status of the specified task. Must be either 'PENDING' (The Task has been recieved and is pending processing), 'IN_PROGRESS' (The task is currently in progress), 'COMPLETED' (The task was completed successfully) or 'FAILED' The task was processed but failed to complete successfully. | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/csharp/docs/GetTokenRequestSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.GetTokenRequestSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ResponseHost** | **string** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **RequestId** | **string** | Unique identifier for the request. |
9 | **PaymentAppInstanceId** | **string** | Identifier for the specific Mobile Payment App instance, unique across a given Wallet Identifier. This value cannot be changed after digitization. This field is alphanumeric and additionally web-safe base64 characters per RFC 4648 (minus \"-\", underscore \"_\") up to a maximum length of 48, = should not be URL encoded. Conditional - not applicable for server-based tokens but required otherwise. | [optional]
10 | **TokenUniqueReference** | **string** | The specific Token to be queried. |
11 | **IncludeTokenDetail** | **string** | Flag to indicate if the encrypted token should be returned. | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/csharp/docs/GetTokenResponseSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.GetTokenResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ResponseId** | **string** | Unique identifier for the response. | [optional]
8 | **Token** | [**TokenForGetToken**](TokenForGetToken.md) | | [optional]
9 | **TokenDetail** | [**TokenDetailGetTokenOnly**](TokenDetailGetTokenOnly.md) | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/csharp/docs/MediaContent.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.MediaContent
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Type** | **string** | What type of media this is. Specified as a MIME type, which will be one of the following supported types * applicatoin/pdf (for images must be a vector PDF image) * image/png (includes alpha channel) * text/plain * text/html |
8 | **Data** | **string** | The data for this item of media. Base64-encoded data, given in the format as specified in ?type?. |
9 | **Height** | **string** | For image assets, the height of this image. Specified in pixels. | [optional]
10 | **Width** | **string** | For image assets, the width of this image. Specified in pixels. | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/csharp/docs/NotifyTokenEncryptedPayload.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.NotifyTokenEncryptedPayload
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Tokens** | [**List<TokenForNTU>**](TokenForNTU.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/csharp/docs/NotifyTokenUpdatedRequestSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.NotifyTokenUpdatedRequestSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ResponseHost** | **string** | The host that originated the request. Future calls in the same conversation should be routed to this host. |
8 | **RequestId** | **string** | Unique identifier for the request. |
9 | **EncryptedPayload** | [**EncryptedPayload**](EncryptedPayload.md) | |
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/csharp/docs/NotifyTokenUpdatedResponseSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.NotifyTokenUpdatedResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ResponseHost** | **string** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **ResponseId** | **string** | Unique identifier for the response. | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/csharp/docs/PhoneNumber.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.PhoneNumber
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **CountryDialInCode** | **decimal** | **(OPTIONAL)** The country code for the phone number. E.g. 1 for US or 44 for UK. | [optional]
8 | **VarPhoneNumber** | **decimal** | **(OPTIONAL)** The phone number of the account holder | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/csharp/docs/SearchTokensRequestSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.SearchTokensRequestSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **RequestId** | **string** | Unique identifier for the request. |
8 | **ResponseHost** | **string** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
9 | **FundingAccountInfo** | [**FundingAccountInfo**](FundingAccountInfo.md) | | [optional]
10 | **TokenRequestorId** | **string** | Identifies the Token Requestor. Only tokens associated with the token requestor will be returned. Length - 11. | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/csharp/docs/SearchTokensResponseSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.SearchTokensResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ResponseHost** | **string** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **ResponseId** | **string** | Unique identifier for the response. | [optional]
9 | **Tokens** | [**List<Token>**](Token.md) | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/csharp/docs/SuspendResponseSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.SuspendResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ResponseHost** | **string** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **ResponseId** | **string** | Unique identifier for the response. | [optional]
9 | **Tokens** | [**List<TokenForLCM>**](TokenForLCM.md) | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/csharp/docs/Token.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.Token
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **TokenUniqueReference** | **string** | The unique reference allocated to the Token which is always present even if an error occurs. maxLength: 64 | [optional]
8 | **Status** | **string** | The current status of Token. Must be either: * 'INACTIVE' (Token has not yet been activated) * 'ACTIVE' (Token is active and ready to transact) * 'SUSPENDED' (Token is suspended and unable to transact) * 'DEACTIVATED' (Token has been permanently deactivated). maxLength: 32 | [optional]
9 | **SuspendedBy** | **List<string>** | (CONDITIONAL only supplied if status is SUSPENDED) Who or what caused the Token to be suspended One or more values of: * ISSUER - Suspended by the Issuer. * TOKEN_REQUESTOR - Suspended by the Token Requestor * MOBILE_PIN_LOCKED - Suspended due to the Mobile PIN being locked * CARDHOLDER - Suspended by the Cardholder | [optional]
10 | **StatusTimestamp** | **string** | The date and time the token status was last updated. Expressed in ISO 8601 extended format as one of the following: * YYYY-MM-DDThh:mm:ss[.sss]Z * YYYY-MM-DDThh:mm:ss[.sss]±hh:mm * Where [.sss] is optional and can be 1 to 3 digits. | [optional]
11 | **ProductConfig** | [**ProductConfig**](ProductConfig.md) | | [optional]
12 | **TokenInfo** | [**TokenInfo**](TokenInfo.md) | | [optional]
13 |
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 |
16 |
--------------------------------------------------------------------------------
/csharp/docs/TokenDetail.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.TokenDetail
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **TokenUniqueReference** | **string** | Globally unique identifier for the Token, as assigned by MDES. | [optional]
8 | **PublicKeyFingerprint** | **string** | The certificate fingerprint identifying the public key used to encrypt the ephemeral AES key. | [optional]
9 | **EncryptedKey** | **string** | One-time use AES key encrypted by the MasterCard public key (as identified by 'publicKeyFingerprint') using the OAEP or RSA Encryption Standard PKCS #1 v1.5 scheme (depending on the value of 'oaepHashingAlgorithm'. Requirement is for a 128-bit key (with 256-bit key supported as an option). | [optional]
10 | **OaepHashingAlgorithm** | **string** | Hashing algorithm used with the OAEP scheme. If omitted, then the RSA Encryption Standard PKCS #1 v1.5 will be used. Must be either 'SHA256' (Use the SHA-256 algorithm) or 'SHA512' (Use the SHA-512 algorithm). | [optional]
11 | **Iv** | **string** | It is recommended to supply a random initialization vector when encrypting the data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. Hex-encoded data (case-insensitive). | [optional]
12 | **EncryptedData** | [**TokenDetailData**](TokenDetailData.md) | | [optional]
13 |
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 |
16 |
--------------------------------------------------------------------------------
/csharp/docs/TokenDetailData.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.TokenDetailData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **PaymentAccountReference** | **string** | \"The unique account reference assigned to the PAN. Conditionally returned if the Token Requestor has opted to receive PAR and providing PAR is assigned by Mastercard or the Issuer provides PAR in the authorization message response.\" | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/csharp/docs/TokenDetailDataGetTokenOnly.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.TokenDetailDataGetTokenOnly
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **TokenNumber** | **string** | The Token Primary Account Number of the Card. | [optional]
8 | **ExpiryMonth** | **string** | The month of the token expiration date. | [optional]
9 | **ExpiryYear** | **string** | The year of the token expiration date. | [optional]
10 | **PaymentAccountReference** | **string** | The unique account reference assigned to the PAN. Conditionally returned if the Token Requestor has opted to receive PAR and providing PAR is assigned by Mastercard or the Issuer provides PAR in the authorization message response. | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/csharp/docs/TokenDetailDataPAROnly.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.TokenDetailDataPAROnly
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **PaymentAccountReference** | **string** | The unique account reference assigned to the PAN. Conditionally returned if the Token Requestor has opted to receive PAR and providing PAR is assigned by Mastercard or the Issuer provides PAR in the authorization message response. | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/csharp/docs/TokenDetailGetTokenOnly.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.TokenDetailGetTokenOnly
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **TokenUniqueReference** | **string** | Globally unique identifier for the Token, as assigned by MDES. | [optional]
8 | **PublicKeyFingerprint** | **string** | The certificate fingerprint identifying the public key used to encrypt the ephemeral AES key. | [optional]
9 | **EncryptedKey** | **string** | One-time use AES key encrypted by the MasterCard public key (as identified by 'publicKeyFingerprint') using the OAEP or RSA Encryption Standard PKCS #1 v1.5 scheme (depending on the value of 'oaepHashingAlgorithm'. Requirement is for a 128-bit key (with 256-bit key supported as an option). | [optional]
10 | **OaepHashingAlgorithm** | **string** | Hashing algorithm used with the OAEP scheme. If omitted, then the RSA Encryption Standard PKCS #1 v1.5 will be used. Must be either 'SHA256' (Use the SHA-256 algorithm) or 'SHA512' (Use the SHA-512 algorithm). | [optional]
11 | **Iv** | **string** | It is recommended to supply a random initialization vector when encrypting the data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. Hex-encoded data (case-insensitive). | [optional]
12 | **EncryptedData** | [**TokenDetailDataGetTokenOnly**](TokenDetailDataGetTokenOnly.md) | | [optional]
13 |
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 |
16 |
--------------------------------------------------------------------------------
/csharp/docs/TokenDetailPAROnly.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.TokenDetailPAROnly
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **TokenUniqueReference** | **string** | Globally unique identifier for the Token, as assigned by MDES.<br> | [optional]
8 | **PublicKeyFingerprint** | **string** | The certificate fingerprint identifying the public key used to encrypt the ephemeral AES key. | [optional]
9 | **EncryptedKey** | **string** | One-time use AES key encrypted by the MasterCard public key (as identified by 'publicKeyFingerprint') using the OAEP or RSA Encryption Standard PKCS #1 v1.5 scheme (depending on the value of 'oaepHashingAlgorithm'. Requirement is for a 128-bit key (with 256-bit key supported as an option). | [optional]
10 | **OaepHashingAlgorithm** | **string** | Hashing algorithm used with the OAEP scheme. If omitted, then the RSA Encryption Standard PKCS #1 v1.5 will be used. Must be either 'SHA256' (Use the SHA-256 algorithm) or 'SHA512' (Use the SHA-512 algorithm). | [optional]
11 | **Iv** | **string** | It is recommended to supply a random initialization vector when encrypting the data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. Hex-encoded data (case-insensitive). | [optional]
12 | **EncryptedData** | [**TokenDetailDataPAROnly**](TokenDetailDataPAROnly.md) | | [optional]
13 |
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 |
16 |
--------------------------------------------------------------------------------
/csharp/docs/TokenForLCM.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.TokenForLCM
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **TokenUniqueReference** | **string** | The unique reference allocated to the Token which is always present even if an error occurs. maxLength: 64 | [optional]
8 | **Status** | **string** | The current status of Token. Must be either: * 'INACTIVE' (Token has not yet been activated) * 'ACTIVE' (Token is active and ready to transact) * 'SUSPENDED' (Token is suspended and unable to transact) * 'DEACTIVATED' (Token has been permanently deactivated). maxLength: 32 | [optional]
9 | **SuspendedBy** | **List<string>** | (CONDITIONAL only supplied if status is SUSPENDED) Who or what caused the Token to be suspended One or more values of: * ISSUER - Suspended by the Issuer. * TOKEN_REQUESTOR - Suspended by the Token Requestor * MOBILE_PIN_LOCKED - Suspended due to the Mobile PIN being locked * CARDHOLDER - Suspended by the Cardholder | [optional]
10 | **StatusTimestamp** | **string** | The date and time the token status was last updated. Expressed in ISO 8601 extended format as one of the following: * YYYY-MM-DDThh:mm:ss[.sss]Z * YYYY-MM-DDThh:mm:ss[.sss]±hh:mm * Where [.sss] is optional and can be 1 to 3 digits. | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/csharp/docs/TokenInfo.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.TokenInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **TokenPanSuffix** | **string** | The last few digits (typically four) of the Token PAN. |
8 | **AccountPanSuffix** | **string** | The last few digits (typically four) of the Account PAN. |
9 | **TokenExpiry** | **string** | The expiry of the Token PAN, given in MMYY format. |
10 | **AccountPanExpiry** | **string** | The expiry of the Account PAN, given in MMYY format. | [optional]
11 | **DsrpCapable** | **bool** | Whether DSRP transactions are supported by this Token. Must be either 'true' (DSRP capable) or 'false' (Not DSRP capable). |
12 | **TokenAssuranceLevel** | **int** | A value indicating the confidence level of the token to Account PAN binding. | [optional]
13 | **ProductCategory** | **string** | The product category of the Account PAN. When supplied will be one of the following values: * CREDIT * DEBIT * PREPAID * UNKNOWN | [optional]
14 |
15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
16 |
17 |
--------------------------------------------------------------------------------
/csharp/docs/TokenInfoForNTUAndGetToken.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.TokenInfoForNTUAndGetToken
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **TokenPanSuffix** | **string** | The last few digits (typically four) of the Token PAN. |
8 | **AccountPanPrefix** | **string** | The first few digits (typically six) of the Account PAN. |
9 | **AccountPanSuffix** | **string** | The last few digits (typically four) of the Account PAN. |
10 | **TokenExpiry** | **string** | The expiry of the Token PAN, given in MMYY format. |
11 | **AccountPanExpiry** | **string** | The expiry of the Account PAN, given in MMYY format. | [optional]
12 | **DsrpCapable** | **string** | Whether DSRP transactions are supported by this Token. Must be either 'true' (DSRP capable) or 'false' (Not DSRP capable). |
13 | **TokenAssuranceLevel** | **int** | A value indicating the confidence level of the token to Account PAN binding. | [optional]
14 | **ProductCategory** | **string** | The product category of the Account PAN. When supplied will be one of the following values: * CREDIT * DEBIT * PREPAID * UNKNOWN | [optional]
15 |
16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17 |
18 |
--------------------------------------------------------------------------------
/csharp/docs/TokenizeRequestSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.TokenizeRequestSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ResponseHost** | **string** | \"The host that originated the request. Future calls in the same conversation may be routed to this host. Must be provided as: host[:port][/contextRoot] Where port and contextRoot are optional. If contextRoot is not provided, the default (per the URL Scheme) is assumed and must be used.\" | [optional]
8 | **RequestId** | **string** | Unique identifier for the request. | [optional]
9 | **TokenType** | **string** | The type of Token requested. Must be CLOUD |
10 | **TokenRequestorId** | **string** | 11-digit numeric ID provided by Mastercard that identifies the Token Requestor. |
11 | **TaskId** | **string** | Identifier for this task as assigned by the Token Requestor, unique across a given Token Requestor Identifier. May be used in the Get Task Status API to query the status of this task. |
12 | **FundingAccountInfo** | [**FundingAccountInfo**](FundingAccountInfo.md) | |
13 | **ConsumerLanguage** | **string** | Language preference selected by the consumer. Formatted as an ISO- 639-1 two-letter language code. | [optional]
14 | **TokenizationAuthenticationValue** | **string** | The Tokenization Authentication Value (TAV) as cryptographically signed by the Issuer to authorize this digitization request. | [optional]
15 | **DecisioningData** | [**DecisioningData**](DecisioningData.md) | | [optional]
16 |
17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
18 |
19 |
--------------------------------------------------------------------------------
/csharp/docs/TransactEncryptedData.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.TransactEncryptedData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **AccountNumber** | **string** | The Primary Account Number for the transaction ? this is the Token PAN. | [optional]
8 | **ApplicationExpiryDate** | **string** | Application expiry date for the Token. Expressed in YYMMDD format. | [optional]
9 | **PanSequenceNumber** | **string** | Application PAN sequence number for the Token | [optional]
10 | **Track2Equivalent** | **string** | Track 2 equivalent data for the Token. Expressed according to ISO/IEC 7813, excluding start sentinel, end sentinel, and Longitudinal Redundancy Check (LRC), using hex nibble 'D' as field separator, and padded to whole bytes using one hex nibble 'F' as needed. | [optional]
11 | **De48se43Data** | **string** | Data for DE 48 Subelement 43 containing the cryptogram. DSRP cryptogram must be sent in DE104. Please refer to AN 3363 for details. | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/csharp/docs/TransactError.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.TransactError
2 | Only returned in the event of an error condition for the Transact API
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **Source** | **string** | An element used to indicate the source of the issue causing this error. Must be one of * 'MDES' * 'INPUT' | [optional]
9 | **ErrorCode** | **string** | A reason code or information pertaining to the error that has occurred. This will contain the error reported by the platform (e.g. authentication errors) or service (e.g. invalid TUR) | [optional]
10 | **Description** | **string** | Description of the reason why the operation failed. | [optional]
11 | **ReasonCode** | **string** | A reason code or information pertaining to the error that has occurred from the service (e.g. invalid TUR). See API Response Errors | [optional]
12 | **ErrorDescription** | **string** | **DEPRECATED** Use description instead. | [optional]
13 |
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 |
16 |
--------------------------------------------------------------------------------
/csharp/docs/TransactRequestSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.TransactRequestSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ResponseHost** | **string** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **RequestId** | **string** | Unique identifier for the request. |
9 | **TokenUniqueReference** | **string** | Globally unique identifier for the Token, as assigned by MDES. |
10 | **DsrpType** | **string** | What type of DSRP cryptogram to create. Must be UCAF. |
11 | **UnpredictableNumber** | **string** | HEX Encoded data (case sensitive) provided by the merchant to provide variability and uniqueness to the generation of a cryptogram. | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/csharp/docs/TransactResponseSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.TransactResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ResponseId** | **string** | Unique identifier for the response. | [optional]
8 | **ResponseHost** | **string** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
9 | **EncryptedPayload** | [**EncryptedPayloadTransact**](EncryptedPayloadTransact.md) | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/csharp/docs/UnSuspendResponseSchema.md:
--------------------------------------------------------------------------------
1 | # Acme.App.MastercardApi.Client.Model.UnSuspendResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ResponseHost** | **string** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **ResponseId** | **string** | Unique identifier for the response. | [optional]
9 | **Tokens** | [**List<TokenForLCM>**](TokenForLCM.md) | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/csharp/generate-api-client.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | # We assume OpenAPI Generator is installed using `npm i -g @openapitools/openapi-generator-cli`
4 | openapi-generator-cli generate -i MDES_Digital_Enablement.yaml -g csharp -c config.json -o . --additional-properties=library=restsharp --additional-properties=targetFramework=netstandard2.1,netcoreapp3.1
5 | # Remove some generated files we don't use in this tutorial
6 | rm -rf src
7 | rm appveyor.yml
8 | rm .gitignore
9 | rm git_push.sh
10 | rm .openapi-generator-ignore
11 | rm Acme.App.MastercardApi.Client.sln
12 | rm -fr Acme.App.MastercardApi.Client.Test
13 |
--------------------------------------------------------------------------------
/csharp/openapitools.json:
--------------------------------------------------------------------------------
1 | {
2 | "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
3 | "spaces": 2,
4 | "generator-cli": {
5 | "version": "5.1.1"
6 | }
7 | }
8 |
--------------------------------------------------------------------------------
/java/.openapi-generator/VERSION:
--------------------------------------------------------------------------------
1 | 7.5.0
2 |
--------------------------------------------------------------------------------
/java/config.json:
--------------------------------------------------------------------------------
1 | {
2 | "groupId" : "com.mastercard.developer",
3 | "artifactId" : "mdes-digital-enablement-client",
4 | "artifactVersion" : "1.0.0",
5 | "invokerPackage" : "com.mastercard.developer.mdes-digital-enablement-client",
6 | "apiPackage" : "com.mastercard.developer.mdes-digital-enablement-client.api",
7 | "modelPackage" : "com.mastercard.developer.mdes-digital-enablement-client.model"
8 | }
--------------------------------------------------------------------------------
/java/docs/AccountHolderData.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # AccountHolderData
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**accountHolderName** | **String** | **(OPTIONAL)** The name of the cardholder in the format LASTNAME/FIRSTNAME or FIRSTNAME LASTNAME | [optional] |
11 | |**accountHolderAddress** | [**BillingAddress**](BillingAddress.md) | | [optional] |
12 | |**consumerIdentifier** | **String** | **(OPTIONAL)** Customer Identifier that may be required in some regions. | [optional] |
13 | |**accountHolderEmailAddress** | **String** | **(OPTIONAL)** The e-mail address of the Account Holder | [optional] |
14 | |**accountHolderMobilePhoneNumber** | [**PhoneNumber**](PhoneNumber.md) | | [optional] |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/java/docs/AccountHolderDataOutbound.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # AccountHolderDataOutbound
4 |
5 | **(CONDITIONAL)** Present in tokenize response if supported by the Merchant, if using a pushAccountReceipt and if there is account holder data associated with the pushAccountReceipt in case that the issuer decision is APPROVED. Refer to MDES Token Connect Token Requestor Implementation Guide and Specification for more details.
6 |
7 | ## Properties
8 |
9 | | Name | Type | Description | Notes |
10 | |------------ | ------------- | ------------- | -------------|
11 | |**accountHolderName** | **String** | **(OPTIONAL)** The name of the cardholder | [optional] |
12 | |**accountHolderAddress** | [**BillingAddress**](BillingAddress.md) | | [optional] |
13 | |**accountHolderEmailAddress** | **String** | **(OPTIONAL)** The e-mail address of the Account Holder | [optional] |
14 | |**accountHolderMobilePhoneNumber** | [**PhoneNumber**](PhoneNumber.md) | | [optional] |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/java/docs/AssetResponseSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # AssetResponseSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**mediaContents** | [**List<MediaContent>**](MediaContent.md) | | [optional] |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/java/docs/AuthenticationMethods.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # AuthenticationMethods
4 |
5 | \"authenticationMethods not currently used for MDES for Merchants\"
6 |
7 | ## Properties
8 |
9 | | Name | Type | Description | Notes |
10 | |------------ | ------------- | ------------- | -------------|
11 | |**id** | **String** | Unique identifier assigned to this Authentication Method. | [optional] |
12 | |**type** | **String** | Specifies the authentication method type and provided in the tokenize response. See table here - https://developer.mastercard.com/mdes-digital-enablement/documentation/code-and-formats/#authentication-method-codes | [optional] |
13 | |**value** | **String** | Specifies the authentication method value (meaning varies depending on the authentication method type). | [optional] |
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/java/docs/BillingAddress.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # BillingAddress
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**line1** | **String** | **(OPTIONAL)** The first line of the street address for the billing address. | [optional] |
11 | |**line2** | **String** | **(OPTIONAL)** The second line of the street address for the billing address. | [optional] |
12 | |**city** | **String** | **(OPTIONAL)** The city of the billing address. | [optional] |
13 | |**countrySubdivision** | **String** | **(OPTIONAL)** The state or country subdivision of the billing address. | [optional] |
14 | |**postalCode** | **String** | **(OPTIONAL)** The postal of code of the billing address. | [optional] |
15 | |**country** | **String** | **(OPTIONAL)** The country of the billing address. | [optional] |
16 |
17 |
18 |
19 |
--------------------------------------------------------------------------------
/java/docs/CardAccountDataInbound.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # CardAccountDataInbound
4 |
5 | **(CONDITIONAL)** Required in Tokenize or Search Tokens unless a valid panUniqueReference, tokenUniqueReference or pushAccountReceipt is also given in FundingAccountInfo.
6 |
7 | ## Properties
8 |
9 | | Name | Type | Description | Notes |
10 | |------------ | ------------- | ------------- | -------------|
11 | |**accountNumber** | **String** | The account number of the credit or debit card. **(CONDITIONAL)** required in a Tokenize, or Get Digital Asset request, unless a valid panUniqueReference or tokenUniqueReference or pushAccountReceipt was given in FundingAccountInfo. **NOTE**:Only 6 digits can be supplied in SearchTokens if the TokenUniqueReference is provided in fundingAccountInfo. | [optional] |
12 | |**expiryMonth** | **String** | The expiry month for the account. Two numeric digits must be supplied. Only supplied in tokenization requests if panUniqueReference or tokenUniqueReferenceForPanInfo or pushAccountReceipt is not present. **Format: MM** | [optional] |
13 | |**expiryYear** | **String** | **(Required as minimum for Tokenization)** The expiry year for the account. Only supplied in tokenization requests if panUniqueReference or tokenUniqueReferenceForPanInfo or pushAccountReceipt is not present. **Format: YY** | [optional] |
14 | |**securityCode** | **String** | **(OPTIONAL)** The security code for the account can optionally be provided for Tokenization. If provided, the validity will be checked. Optional in a Tokenize request, not present otherwise. | [optional] |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/java/docs/CardAccountDataOutbound.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # CardAccountDataOutbound
4 |
5 | **(CONDITIONAL)** The credit or debit card information for the account that is being tokenized. Present in tokenize response if supported by the Token Requestor, if using a pushAccountReceipt and if there is a card account associated with the pushAccountReceipt in case that the issuer decision is not DECLINED.
6 |
7 | ## Properties
8 |
9 | | Name | Type | Description | Notes |
10 | |------------ | ------------- | ------------- | -------------|
11 | |**accountNumber** | **String** | The account number of the credit or debit card. | [optional] |
12 | |**expiryMonth** | **String** | The expiry month for the account. Two numeric digits must be supplied. **Format: MM** | [optional] |
13 | |**expiryYear** | **String** | **(Required as minimum for Tokenization)** The expiry year for the account. **Format: YY** | [optional] |
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/java/docs/DeleteRequestSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # DeleteRequestSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional] |
11 | |**requestId** | **String** | Unique identifier for the request. | |
12 | |**paymentAppInstanceId** | **String** | Identifier for the specific Mobile Payment App instance, unique across a given Wallet Identifier. This value cannot be changed after digitization. This field is alphanumeric and additionally web-safe base64 characters per RFC 4648 (minus \"-\", underscore \"_\") up to a maximum length of 48, = should not be URL encoded. Conditional - not applicable for server based tokens but required otherwise. | [optional] |
13 | |**tokenUniqueReferences** | **List<String>** | The specific Token to be deleted. Array of more or more valid references as assigned by MDES | |
14 | |**causedBy** | **String** | Who or what caused the Token to be deleted. Must be either the 'CARDHOLDER' (operation requested by the Cardholder) or 'TOKEN_REQUESTOR' (operation requested by the token requestor). | |
15 | |**reason** | **String** | Free form reason why the Tokens are being suspended. | [optional] |
16 | |**reasonCode** | **String** | The reason for the action to be deleted. Must be one of 'SUSPECTED_FRAUD' (suspected fraudulent token transactions), 'OTHER' (Other - default used if value not provided). | |
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/java/docs/DeleteResponseSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # DeleteResponseSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional] |
11 | |**responseId** | **String** | Unique identifier for the response. | [optional] |
12 | |**tokens** | [**List<TokenForLCM>**](TokenForLCM.md) | | [optional] |
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/java/docs/EncryptedPayload.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # EncryptedPayload
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**publicKeyFingerprint** | **String** | The fingerprint of the public key used to encrypt the ephemeral AES key. | |
11 | |**encryptedKey** | **String** | One-time use AES key encrypted by the MasterCard public key (as identified by publicKeyFingerprint) using the OAEP or PKCS#1 v1.5 scheme (depending on the value of oaepHashingAlgorithm. | |
12 | |**oaepHashingAlgorithm** | **String** | Hashing algorithm used with the OAEP scheme. Must be either SHA256 or SHA512. | [optional] |
13 | |**iv** | **String** | The initialization vector used when encrypting data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. If not present, an IV of zero is assumed. Length - 32. | [optional] |
14 | |**encryptedData** | [**NotifyTokenEncryptedPayload**](NotifyTokenEncryptedPayload.md) | | |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/java/docs/EncryptedPayloadTransact.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # EncryptedPayloadTransact
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**publicKeyFingerprint** | **String** | The fingerprint of the public key used to encrypt the ephemeral AES key. | [optional] |
11 | |**encryptedKey** | **String** | One-time use AES key encrypted by the MasterCard public key (as identified by publicKeyFingerprint) using the OAEP or PKCS#1 v1.5 scheme (depending on the value of oaepHashingAlgorithm. | [optional] |
12 | |**oaepHashingAlgorithm** | **String** | Hashing algorithm used with the OAEP scheme. Must be either SHA256 or SHA512. | [optional] |
13 | |**iv** | **String** | The initialization vector used when encrypting data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. If not present, an IV of zero is assumed. | [optional] |
14 | |**encryptedData** | [**TransactEncryptedData**](TransactEncryptedData.md) | | [optional] |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/java/docs/Error.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # Error
4 |
5 | Only returned in the event of an error condition.
6 |
7 | ## Properties
8 |
9 | | Name | Type | Description | Notes |
10 | |------------ | ------------- | ------------- | -------------|
11 | |**source** | **String** | An element used to indicate the source of the issue causing this error. Must be one of * 'MDES' * 'INPUT' | [optional] |
12 | |**errorCode** | **String** | An error code generated by the gateway if the error occurs before reaching the MDES application. maxLength: 100 | [optional] |
13 | |**description** | **String** | Description of the reason the operation failed. See API Response Errors | [optional] |
14 | |**reasonCode** | **String** | A reason code for the error that has occurred. | [optional] |
15 | |**recoverable** | **Boolean** | Generated by the gateway to indicate if the request could presented again for processing. Either \"TRUE\" or \"FALSE\" | [optional] |
16 |
17 |
18 |
19 |
--------------------------------------------------------------------------------
/java/docs/ErrorsResponse.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # ErrorsResponse
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**errorCode** | **String** | **CONDITIONAL** Returned in the event of an error and contains the reason the operation failed. Only use if errors object is not present. | [optional] |
11 | |**errorDescription** | **String** | **CONDITIONAL** Returned in the event of an error and contains a description of why the operation failed. Only use if errors object is not present. | [optional] |
12 | |**responseHost** | **String** | The MasterCard host that originated the request. Future calls in the same conversation may be routed to this host. | [optional] |
13 | |**responseId** | **String** | Unique identifier for the response. | [optional] |
14 | |**errors** | [**Error**](Error.md) | | [optional] |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/java/docs/FundingAccountData.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # FundingAccountData
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**cardAccountData** | [**CardAccountDataInbound**](CardAccountDataInbound.md) | | [optional] |
11 | |**accountHolderData** | [**AccountHolderData**](AccountHolderData.md) | | [optional] |
12 | |**source** | **String** | (**Required as minimum for Tokenization**) The source of the account. Must be one of * ACCOUNT_ON_FILE * ACCOUNT_ADDED_MANUALLY * ACCOUNT_ADDED_VIA_APPLICATION | [optional] |
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/java/docs/FundingAccountInfo.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # FundingAccountInfo
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**panUniqueReference** | **String** | **(CONDITIONAL)** For repeat digitizations, the unique reference allocated to the Primary Account Number. When supplied, the tokenUniqueReferenceForPanInfo, accountNumber, expiryMonth and expiryYear must be omitted from CardInfoData. Only allowed if Only allowed if tokenUniqueReference and pushAccountReceipt are not present and encrypted data does not contain the account information. | [optional] |
11 | |**tokenUniqueReference** | **String** | **(CONDITIONAL)** A unique reference assigned following the allocation of a token used to identify the token for the duration of its lifetime. For repeat digitizations, the unique reference allocated to the token will be used to retrieve the financial account information. When supplied, the account information is omitted from FundingAccountData. Only allowed if panUniqueReference and pushAccountReceipt are not present and encrypted data does not contain the account information. | [optional] |
12 | |**encryptedPayload** | [**FundingAccountInfoEncryptedPayload**](FundingAccountInfoEncryptedPayload.md) | | [optional] |
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/java/docs/FundingAccountInfoEncryptedPayload.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # FundingAccountInfoEncryptedPayload
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**publicKeyFingerprint** | **String** | The fingerprint of the public key used to encrypt the ephemeral AES key. | [optional] |
11 | |**encryptedKey** | **String** | One-time use AES key encrypted by the MasterCard public key (as identified by publicKeyFingerprint) using the OAEP or PKCS#1 v1.5 scheme (depending on the value of oaepHashingAlgorithm. | [optional] |
12 | |**oaepHashingAlgorithm** | **String** | Hashing algorithm used with the OAEP scheme. Must be either SHA256 or SHA512. | [optional] |
13 | |**iv** | **String** | The initialization vector used when encrypting data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. If not present, an IV of zero is assumed. | [optional] |
14 | |**encryptedData** | [**FundingAccountData**](FundingAccountData.md) | | [optional] |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/java/docs/GatewayError.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # GatewayError
4 |
5 | Only returned in the event of an error condition.
6 |
7 | ## Properties
8 |
9 | | Name | Type | Description | Notes |
10 | |------------ | ------------- | ------------- | -------------|
11 | |**source** | **String** | An element used to indicate the source of the issue causing this error. e.g. Gateway | [optional] |
12 | |**description** | **String** | Description of the reason the operation failed. See API Response Errors | [optional] |
13 | |**reasonCode** | **String** | A reason code for the error that has occurred. | [optional] |
14 | |**recoverable** | **Boolean** | Generated by the gateway to indicate if the request could presented again for processing. Either \"TRUE\" or \"FALSE\" | [optional] |
15 | |**details** | **Boolean** | Always NULL, present for backwards compatiility | [optional] |
16 |
17 |
18 |
19 |
--------------------------------------------------------------------------------
/java/docs/GatewayErrorsResponse.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # GatewayErrorsResponse
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**errors** | [**GatewayErrorsSchema**](GatewayErrorsSchema.md) | | [optional] |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/java/docs/GatewayErrorsSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # GatewayErrorsSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**error** | [**List<GatewayError>**](GatewayError.md) | | [optional] |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/java/docs/GetTaskStatusRequestSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # GetTaskStatusRequestSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional] |
11 | |**requestId** | **String** | Unique identifier for the request. | |
12 | |**tokenRequestorId** | **String** | 11-digit numeric ID provided by Mastercard that identifies the Token Requestor. | |
13 | |**taskId** | **String** | Unique identifier for this task. Must be an identifier previously used when requesting a task. | |
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/java/docs/GetTaskStatusResponseSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # GetTaskStatusResponseSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseId** | **String** | Unique identifier for the response. | [optional] |
11 | |**responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional] |
12 | |**status** | **String** | The status of the specified task. Must be either 'PENDING' (The Task has been recieved and is pending processing), 'IN_PROGRESS' (The task is currently in progress), 'COMPLETED' (The task was completed successfully) or 'FAILED' The task was processed but failed to complete successfully. | [optional] |
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/java/docs/GetTokenRequestSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # GetTokenRequestSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional] |
11 | |**requestId** | **String** | Unique identifier for the request. | |
12 | |**paymentAppInstanceId** | **String** | Identifier for the specific Mobile Payment App instance, unique across a given Wallet Identifier. This value cannot be changed after digitization. This field is alphanumeric and additionally web-safe base64 characters per RFC 4648 (minus \"-\", underscore \"_\") up to a maximum length of 48, = should not be URL encoded. Conditional - not applicable for server-based tokens but required otherwise. | [optional] |
13 | |**tokenUniqueReference** | **String** | The specific Token to be queried. | |
14 | |**includeTokenDetail** | **String** | Flag to indicate if the encrypted token should be returned. | [optional] |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/java/docs/GetTokenResponseSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # GetTokenResponseSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseId** | **String** | Unique identifier for the response. | [optional] |
11 | |**token** | [**TokenForGetToken**](TokenForGetToken.md) | | [optional] |
12 | |**tokenDetail** | [**TokenDetailGetTokenOnly**](TokenDetailGetTokenOnly.md) | | [optional] |
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/java/docs/MediaContent.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # MediaContent
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**type** | **String** | What type of media this is. Specified as a MIME type, which will be one of the following supported types * applicatoin/pdf (for images must be a vector PDF image) * image/png (includes alpha channel) * text/plain * text/html | |
11 | |**data** | **String** | The data for this item of media. Base64-encoded data, given in the format as specified in ?type?. | |
12 | |**height** | **String** | For image assets, the height of this image. Specified in pixels. | [optional] |
13 | |**width** | **String** | For image assets, the width of this image. Specified in pixels. | [optional] |
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/java/docs/NotifyTokenEncryptedPayload.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # NotifyTokenEncryptedPayload
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**tokens** | [**List<TokenForNTU>**](TokenForNTU.md) | | [optional] |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/java/docs/NotifyTokenUpdatedRequestSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # NotifyTokenUpdatedRequestSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseHost** | **String** | The host that originated the request. Future calls in the same conversation should be routed to this host. | |
11 | |**requestId** | **String** | Unique identifier for the request. | |
12 | |**encryptedPayload** | [**EncryptedPayload**](EncryptedPayload.md) | | |
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/java/docs/NotifyTokenUpdatedResponseSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # NotifyTokenUpdatedResponseSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional] |
11 | |**responseId** | **String** | Unique identifier for the response. | [optional] |
12 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/java/docs/PhoneNumber.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # PhoneNumber
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**countryDialInCode** | **BigDecimal** | **(OPTIONAL)** The country code for the phone number. E.g. 1 for US or 44 for UK. | [optional] |
11 | |**phoneNumber** | **BigDecimal** | **(OPTIONAL)** The phone number of the account holder | [optional] |
12 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/java/docs/SearchTokensRequestSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # SearchTokensRequestSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**requestId** | **String** | Unique identifier for the request. | |
11 | |**responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional] |
12 | |**fundingAccountInfo** | [**FundingAccountInfo**](FundingAccountInfo.md) | | [optional] |
13 | |**tokenRequestorId** | **String** | Identifies the Token Requestor. Only tokens associated with the token requestor will be returned. Length - 11. | [optional] |
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/java/docs/SearchTokensResponseSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # SearchTokensResponseSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional] |
11 | |**responseId** | **String** | Unique identifier for the response. | [optional] |
12 | |**tokens** | [**List<Token>**](Token.md) | | [optional] |
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/java/docs/SuspendRequestSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # SuspendRequestSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional] |
11 | |**requestId** | **String** | Unique identifier for the request. | |
12 | |**paymentAppInstanceId** | **String** | Identifier for the specific Mobile Payment App instance, unique across a given Wallet Identifier. This value cannot be changed after digitization. This field is alphanumeric and additionally web-safe base64 characters per RFC 4648 (minus \"-\", underscore \"_\") up to a maximum length of 48, = should not be URL encoded. Conditional - not applicable for server based tokens but required otherwise. | [optional] |
13 | |**tokenUniqueReferences** | **List<String>** | The specific Token to be suspended. Array of more or more valid references as assigned by MDES | |
14 | |**causedBy** | **String** | Who or what caused the Token to be suspended. Must be either the 'CARDHOLDER' (operation requested by the Cardholder) or 'TOKEN_REQUESTOR' (operation requested by the token requestor). | |
15 | |**reason** | **String** | Free form reason why the Tokens are being suspended. | [optional] |
16 | |**reasonCode** | **String** | The reason for the action to be suspended. Must be one of 'SUSPECTED_FRAUD' (suspected fraudulent token transactions), 'OTHER' (Other - default used if value not provided). | |
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/java/docs/SuspendResponseSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # SuspendResponseSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional] |
11 | |**responseId** | **String** | Unique identifier for the response. | [optional] |
12 | |**tokens** | [**List<TokenForLCM>**](TokenForLCM.md) | | [optional] |
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/java/docs/Token.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # Token
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**tokenUniqueReference** | **String** | The unique reference allocated to the Token which is always present even if an error occurs. maxLength: 64 | [optional] |
11 | |**status** | **String** | The current status of Token. Must be either: * 'INACTIVE' (Token has not yet been activated) * 'ACTIVE' (Token is active and ready to transact) * 'SUSPENDED' (Token is suspended and unable to transact) * 'DEACTIVATED' (Token has been permanently deactivated). maxLength: 32 | [optional] |
12 | |**suspendedBy** | **List<String>** | (CONDITIONAL only supplied if status is SUSPENDED) Who or what caused the Token to be suspended One or more values of: * ISSUER - Suspended by the Issuer. * TOKEN_REQUESTOR - Suspended by the Token Requestor * MOBILE_PIN_LOCKED - Suspended due to the Mobile PIN being locked * CARDHOLDER - Suspended by the Cardholder | [optional] |
13 | |**statusTimestamp** | **String** | The date and time the token status was last updated. Expressed in ISO 8601 extended format as one of the following: * YYYY-MM-DDThh:mm:ss[.sss]Z * YYYY-MM-DDThh:mm:ss[.sss]±hh:mm * Where [.sss] is optional and can be 1 to 3 digits. | [optional] |
14 | |**productConfig** | [**ProductConfig**](ProductConfig.md) | | [optional] |
15 | |**tokenInfo** | [**TokenInfo**](TokenInfo.md) | | [optional] |
16 |
17 |
18 |
19 |
--------------------------------------------------------------------------------
/java/docs/TokenDetail.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # TokenDetail
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**tokenUniqueReference** | **String** | Globally unique identifier for the Token, as assigned by MDES. | [optional] |
11 | |**publicKeyFingerprint** | **String** | The certificate fingerprint identifying the public key used to encrypt the ephemeral AES key. | [optional] |
12 | |**encryptedKey** | **String** | One-time use AES key encrypted by the MasterCard public key (as identified by 'publicKeyFingerprint') using the OAEP or RSA Encryption Standard PKCS #1 v1.5 scheme (depending on the value of 'oaepHashingAlgorithm'. Requirement is for a 128-bit key (with 256-bit key supported as an option). | [optional] |
13 | |**oaepHashingAlgorithm** | **String** | Hashing algorithm used with the OAEP scheme. If omitted, then the RSA Encryption Standard PKCS #1 v1.5 will be used. Must be either 'SHA256' (Use the SHA-256 algorithm) or 'SHA512' (Use the SHA-512 algorithm). | [optional] |
14 | |**iv** | **String** | It is recommended to supply a random initialization vector when encrypting the data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. Hex-encoded data (case-insensitive). | [optional] |
15 | |**encryptedData** | [**TokenDetailData**](TokenDetailData.md) | | [optional] |
16 |
17 |
18 |
19 |
--------------------------------------------------------------------------------
/java/docs/TokenDetailData.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # TokenDetailData
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**paymentAccountReference** | **String** | \"The unique account reference assigned to the PAN. Conditionally returned if the Token Requestor has opted to receive PAR and providing PAR is assigned by Mastercard or the Issuer provides PAR in the authorization message response.\" | [optional] |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/java/docs/TokenDetailDataGetTokenOnly.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # TokenDetailDataGetTokenOnly
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**tokenNumber** | **String** | The Token Primary Account Number of the Card. | [optional] |
11 | |**expiryMonth** | **String** | The month of the token expiration date. | [optional] |
12 | |**expiryYear** | **String** | The year of the token expiration date. | [optional] |
13 | |**paymentAccountReference** | **String** | The unique account reference assigned to the PAN. Conditionally returned if the Token Requestor has opted to receive PAR and providing PAR is assigned by Mastercard or the Issuer provides PAR in the authorization message response. | [optional] |
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/java/docs/TokenDetailDataPAROnly.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # TokenDetailDataPAROnly
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**paymentAccountReference** | **String** | The unique account reference assigned to the PAN. Conditionally returned if the Token Requestor has opted to receive PAR and providing PAR is assigned by Mastercard or the Issuer provides PAR in the authorization message response. | [optional] |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/java/docs/TokenDetailGetTokenOnly.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # TokenDetailGetTokenOnly
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**tokenUniqueReference** | **String** | Globally unique identifier for the Token, as assigned by MDES. | [optional] |
11 | |**publicKeyFingerprint** | **String** | The certificate fingerprint identifying the public key used to encrypt the ephemeral AES key. | [optional] |
12 | |**encryptedKey** | **String** | One-time use AES key encrypted by the MasterCard public key (as identified by 'publicKeyFingerprint') using the OAEP or RSA Encryption Standard PKCS #1 v1.5 scheme (depending on the value of 'oaepHashingAlgorithm'. Requirement is for a 128-bit key (with 256-bit key supported as an option). | [optional] |
13 | |**oaepHashingAlgorithm** | **String** | Hashing algorithm used with the OAEP scheme. If omitted, then the RSA Encryption Standard PKCS #1 v1.5 will be used. Must be either 'SHA256' (Use the SHA-256 algorithm) or 'SHA512' (Use the SHA-512 algorithm). | [optional] |
14 | |**iv** | **String** | It is recommended to supply a random initialization vector when encrypting the data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. Hex-encoded data (case-insensitive). | [optional] |
15 | |**encryptedData** | [**TokenDetailDataGetTokenOnly**](TokenDetailDataGetTokenOnly.md) | | [optional] |
16 |
17 |
18 |
19 |
--------------------------------------------------------------------------------
/java/docs/TokenDetailPAROnly.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # TokenDetailPAROnly
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**tokenUniqueReference** | **String** | Globally unique identifier for the Token, as assigned by MDES.<br> | [optional] |
11 | |**publicKeyFingerprint** | **String** | The certificate fingerprint identifying the public key used to encrypt the ephemeral AES key. | [optional] |
12 | |**encryptedKey** | **String** | One-time use AES key encrypted by the MasterCard public key (as identified by 'publicKeyFingerprint') using the OAEP or RSA Encryption Standard PKCS #1 v1.5 scheme (depending on the value of 'oaepHashingAlgorithm'. Requirement is for a 128-bit key (with 256-bit key supported as an option). | [optional] |
13 | |**oaepHashingAlgorithm** | **String** | Hashing algorithm used with the OAEP scheme. If omitted, then the RSA Encryption Standard PKCS #1 v1.5 will be used. Must be either 'SHA256' (Use the SHA-256 algorithm) or 'SHA512' (Use the SHA-512 algorithm). | [optional] |
14 | |**iv** | **String** | It is recommended to supply a random initialization vector when encrypting the data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. Hex-encoded data (case-insensitive). | [optional] |
15 | |**encryptedData** | [**TokenDetailDataPAROnly**](TokenDetailDataPAROnly.md) | | [optional] |
16 |
17 |
18 |
19 |
--------------------------------------------------------------------------------
/java/docs/TokenForGetToken.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # TokenForGetToken
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**tokenUniqueReference** | **String** | The unique reference allocated to the Token which is always present even if an error occurs. maxLength: 64 | [optional] |
11 | |**tokenRequestorId** | **String** | Identifies the Token Requestor. <br> minLength: 11 maxLength: 11 | [optional] |
12 | |**status** | **String** | The current status of Token. Must be either: * 'INACTIVE' (Token has not yet been activated) * 'ACTIVE' (Token is active and ready to transact) * 'SUSPENDED' (Token is suspended and unable to transact) * 'DEACTIVATED' (Token has been permanently deactivated). maxLength: 32 | [optional] |
13 | |**suspendedBy** | **List<String>** | (CONDITIONAL only supplied if status is SUSPENDED) Who or what caused the Token to be suspended One or more values of: * ISSUER - Suspended by the Issuer. * TOKEN_REQUESTOR - Suspended by the Token Requestor * MOBILE_PIN_LOCKED - Suspended due to the Mobile PIN being locked * CARDHOLDER - Suspended by the Cardholder | [optional] |
14 | |**statusTimestamp** | **String** | The date and time the token status was last updated. Expressed in ISO 8601 extended format as one of the following: * YYYY-MM-DDThh:mm:ss[.sss]Z * YYYY-MM-DDThh:mm:ss[.sss]±hh:mm * Where [.sss] is optional and can be 1 to 3 digits. | [optional] |
15 | |**productConfig** | [**ProductConfig**](ProductConfig.md) | | [optional] |
16 | |**tokenInfo** | [**TokenInfoForNTUAndGetToken**](TokenInfoForNTUAndGetToken.md) | | [optional] |
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/java/docs/TokenForLCM.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # TokenForLCM
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**tokenUniqueReference** | **String** | The unique reference allocated to the Token which is always present even if an error occurs. maxLength: 64 | [optional] |
11 | |**status** | **String** | The current status of Token. Must be either: * 'INACTIVE' (Token has not yet been activated) * 'ACTIVE' (Token is active and ready to transact) * 'SUSPENDED' (Token is suspended and unable to transact) * 'DEACTIVATED' (Token has been permanently deactivated). maxLength: 32 | [optional] |
12 | |**suspendedBy** | **List<String>** | (CONDITIONAL only supplied if status is SUSPENDED) Who or what caused the Token to be suspended One or more values of: * ISSUER - Suspended by the Issuer. * TOKEN_REQUESTOR - Suspended by the Token Requestor * MOBILE_PIN_LOCKED - Suspended due to the Mobile PIN being locked * CARDHOLDER - Suspended by the Cardholder | [optional] |
13 | |**statusTimestamp** | **String** | The date and time the token status was last updated. Expressed in ISO 8601 extended format as one of the following: * YYYY-MM-DDThh:mm:ss[.sss]Z * YYYY-MM-DDThh:mm:ss[.sss]±hh:mm * Where [.sss] is optional and can be 1 to 3 digits. | [optional] |
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/java/docs/TokenInfo.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # TokenInfo
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**tokenPanSuffix** | **String** | The last few digits (typically four) of the Token PAN. | |
11 | |**accountPanSuffix** | **String** | The last few digits (typically four) of the Account PAN. | |
12 | |**tokenExpiry** | **String** | The expiry of the Token PAN, given in MMYY format. | |
13 | |**accountPanExpiry** | **String** | The expiry of the Account PAN, given in MMYY format. | [optional] |
14 | |**dsrpCapable** | **String** | Whether DSRP transactions are supported by this Token. Must be either 'true' (DSRP capable) or 'false' (Not DSRP capable). | |
15 | |**tokenAssuranceLevel** | **Integer** | A value indicating the confidence level of the token to Account PAN binding. | [optional] |
16 | |**productCategory** | **String** | The product category of the Account PAN. When supplied will be one of the following values: * CREDIT * DEBIT * PREPAID * UNKNOWN | [optional] |
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/java/docs/TokenInfoForNTUAndGetToken.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # TokenInfoForNTUAndGetToken
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**tokenPanSuffix** | **String** | The last few digits (typically four) of the Token PAN. | |
11 | |**accountPanPrefix** | **String** | The first few digits (typically six) of the Account PAN. | |
12 | |**accountPanSuffix** | **String** | The last few digits (typically four) of the Account PAN. | |
13 | |**tokenExpiry** | **String** | The expiry of the Token PAN, given in MMYY format. | |
14 | |**accountPanExpiry** | **String** | The expiry of the Account PAN, given in MMYY format. | [optional] |
15 | |**dsrpCapable** | **String** | Whether DSRP transactions are supported by this Token. Must be either 'true' (DSRP capable) or 'false' (Not DSRP capable). | |
16 | |**tokenAssuranceLevel** | **Integer** | A value indicating the confidence level of the token to Account PAN binding. | [optional] |
17 | |**productCategory** | **String** | The product category of the Account PAN. When supplied will be one of the following values: * CREDIT * DEBIT * PREPAID * UNKNOWN | [optional] |
18 |
19 |
20 |
21 |
--------------------------------------------------------------------------------
/java/docs/TokenizeRequestSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # TokenizeRequestSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseHost** | **String** | \"The host that originated the request. Future calls in the same conversation may be routed to this host. Must be provided as: host[:port][/contextRoot] Where port and contextRoot are optional. If contextRoot is not provided, the default (per the URL Scheme) is assumed and must be used.\" | [optional] |
11 | |**requestId** | **String** | Unique identifier for the request. | [optional] |
12 | |**tokenType** | **String** | The type of Token requested. Must be CLOUD | |
13 | |**tokenRequestorId** | **String** | 11-digit numeric ID provided by Mastercard that identifies the Token Requestor. | |
14 | |**taskId** | **String** | Identifier for this task as assigned by the Token Requestor, unique across a given Token Requestor Identifier. May be used in the Get Task Status API to query the status of this task. | |
15 | |**fundingAccountInfo** | [**FundingAccountInfo**](FundingAccountInfo.md) | | |
16 | |**consumerLanguage** | **String** | Language preference selected by the consumer. Formatted as an ISO- 639-1 two-letter language code. | [optional] |
17 | |**tokenizationAuthenticationValue** | **String** | The Tokenization Authentication Value (TAV) as cryptographically signed by the Issuer to authorize this digitization request. | [optional] |
18 | |**decisioningData** | [**DecisioningData**](DecisioningData.md) | | [optional] |
19 |
20 |
21 |
22 |
--------------------------------------------------------------------------------
/java/docs/TransactEncryptedData.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # TransactEncryptedData
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**accountNumber** | **String** | The Primary Account Number for the transaction ? this is the Token PAN. | [optional] |
11 | |**applicationExpiryDate** | **String** | Application expiry date for the Token. Expressed in YYMMDD format. | [optional] |
12 | |**panSequenceNumber** | **String** | Application PAN sequence number for the Token | [optional] |
13 | |**track2Equivalent** | **String** | Track 2 equivalent data for the Token. Expressed according to ISO/IEC 7813, excluding start sentinel, end sentinel, and Longitudinal Redundancy Check (LRC), using hex nibble 'D' as field separator, and padded to whole bytes using one hex nibble 'F' as needed. | [optional] |
14 | |**de48se43Data** | **String** | Data for DE 48 Subelement 43 containing the cryptogram. DSRP cryptogram must be sent in DE104. Please refer to AN 3363 for details. | [optional] |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/java/docs/TransactError.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # TransactError
4 |
5 | Only returned in the event of an error condition for the Transact API
6 |
7 | ## Properties
8 |
9 | | Name | Type | Description | Notes |
10 | |------------ | ------------- | ------------- | -------------|
11 | |**source** | **String** | An element used to indicate the source of the issue causing this error. Must be one of * 'MDES' * 'INPUT' | [optional] |
12 | |**errorCode** | **String** | A reason code or information pertaining to the error that has occurred. This will contain the error reported by the platform (e.g. authentication errors) or service (e.g. invalid TUR) | [optional] |
13 | |**description** | **String** | Description of the reason why the operation failed. | [optional] |
14 | |**reasonCode** | **String** | A reason code or information pertaining to the error that has occurred from the service (e.g. invalid TUR). See API Response Errors | [optional] |
15 | |**errorDescription** | **String** | **DEPRECATED** Use description instead. | [optional] |
16 |
17 |
18 |
19 |
--------------------------------------------------------------------------------
/java/docs/TransactRequestSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # TransactRequestSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional] |
11 | |**requestId** | **String** | Unique identifier for the request. | |
12 | |**tokenUniqueReference** | **String** | Globally unique identifier for the Token, as assigned by MDES. | |
13 | |**dsrpType** | **String** | What type of DSRP cryptogram to create. Must be UCAF. | |
14 | |**unpredictableNumber** | **String** | HEX Encoded data (case sensitive) provided by the merchant to provide variability and uniqueness to the generation of a cryptogram. | [optional] |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/java/docs/TransactResponseSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # TransactResponseSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseId** | **String** | Unique identifier for the response. | [optional] |
11 | |**responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional] |
12 | |**encryptedPayload** | [**EncryptedPayloadTransact**](EncryptedPayloadTransact.md) | | [optional] |
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/java/docs/UnSuspendRequestSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # UnSuspendRequestSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional] |
11 | |**requestId** | **String** | Unique identifier for the request. | |
12 | |**paymentAppInstanceId** | **String** | Identifier for the specific Mobile Payment App instance, unique across a given Wallet Identifier. This value cannot be changed after digitization. This field is alphanumeric and additionally web-safe base64 characters per RFC 4648 (minus \"-\", underscore \"_\") up to a maximum length of 48, = should not be URL encoded. Conditional - not applicable for server based tokens but required otherwise. | [optional] |
13 | |**tokenUniqueReferences** | **List<String>** | The specific Token to be unsuspended. Array of more or more valid references as assigned by MDES | |
14 | |**causedBy** | **String** | Who or what caused the Token to be unsuspended. Must be either the 'CARDHOLDER' (operation requested by the Cardholder) or 'TOKEN_REQUESTOR' (operation requested by the token requestor). | |
15 | |**reason** | **String** | Free form reason why the Tokens are being suspended. | [optional] |
16 | |**reasonCode** | **String** | The reason for the action to be unsuspended. Must be one of 'SUSPECTED_FRAUD' (suspected fraudulent token transactions), 'OTHER' (Other - default used if value not provided). | |
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/java/docs/UnSuspendResponseSchema.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # UnSuspendResponseSchema
4 |
5 |
6 | ## Properties
7 |
8 | | Name | Type | Description | Notes |
9 | |------------ | ------------- | ------------- | -------------|
10 | |**responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional] |
11 | |**responseId** | **String** | Unique identifier for the response. | [optional] |
12 | |**tokens** | [**List<TokenForLCM>**](TokenForLCM.md) | | [optional] |
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/java/generate-api-client.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | # We assume OpenAPI Generator is installed using `npm i -g @openapitools/openapi-generator-cli`
4 | openapi-generator-cli -g java --library okhttp-gson -c config.json -i MDES_Digital_Enablement.yaml -o .
5 |
6 | # Remove some generated files we don't use in this tutorial
7 | rm .openapi-generator-ignore
8 | rm .gitignore
9 | rm .travis.yml
10 | rm build.sbt
11 | rm git_push.sh
12 | rm -rf gradle
13 | rm -rf api
14 | rm gradle*
15 | rm *gradle
16 | rm src/main/AndroidManifest.xml
17 | shopt -s extglob
18 | pushd src/test/java/com/mastercard/developer/mdes_digital_enablement_client/
19 | rm -rf model
20 | cd api
21 | rm -fv !(TokenizeApiTest.java)
22 | popd
23 |
--------------------------------------------------------------------------------
/java/openapitools.json:
--------------------------------------------------------------------------------
1 | {
2 | "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
3 | "spaces": 2,
4 | "generator-cli": {
5 | "version": "7.5.0"
6 | }
7 | }
8 |
--------------------------------------------------------------------------------
/java/src/main/java/com/mastercard/developer/mdes_digital_enablement_client/ServerVariable.java:
--------------------------------------------------------------------------------
1 | package com.mastercard.developer.mdes_digital_enablement_client;
2 |
3 | import java.util.HashSet;
4 |
5 | /**
6 | * Representing a Server Variable for server URL template substitution.
7 | */
8 | @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-09-24T13:37:45.612619+01:00[Europe/Dublin]", comments = "Generator version: 7.5.0")
9 | public class ServerVariable {
10 | public String description;
11 | public String defaultValue;
12 | public HashSet enumValues = null;
13 |
14 | /**
15 | * @param description A description for the server variable.
16 | * @param defaultValue The default value to use for substitution.
17 | * @param enumValues An enumeration of string values to be used if the substitution options are from a limited set.
18 | */
19 | public ServerVariable(String description, String defaultValue, HashSet enumValues) {
20 | this.description = description;
21 | this.defaultValue = defaultValue;
22 | this.enumValues = enumValues;
23 | }
24 | }
25 |
--------------------------------------------------------------------------------
/java/src/test/resources/digital-enablement-sandbox-decryption-key.key:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Mastercard/mastercard-api-client-tutorial/5f884c764152164271d4ce8efdaf89060e2975b7/java/src/test/resources/digital-enablement-sandbox-decryption-key.key
--------------------------------------------------------------------------------
/java/src/test/resources/digital-enablement-sandbox-encryption-key.crt:
--------------------------------------------------------------------------------
1 | -----BEGIN CERTIFICATE-----
2 | MIIEZDCCA0ygAwIBAgIQQUmirRSB0Og8AbLmOXxo/DANBgkqhkiG9w0BAQUFADCB
3 | rjETMBEGCgmSJomT8ixkARkWA2NvbTEaMBgGCgmSJomT8ixkARkWCm1hc3RlcmNh
4 | cmQxHTAbBgNVBAoTFE1hc3RlckNhcmQgV29ybGRXaWRlMSQwIgYDVQQLExtHbG9i
5 | YWwgSW5mb3JtYXRpb24gU2VjdXJpdHkxNjA0BgNVBAMTLVBSRCBNQyBQcm9kdWN0
6 | aW9uIE5ldHdvcmsgQXBwbGljYXRpb25zIHN1YiBDQTAeFw0xNjAxMDUwODEwMzJa
7 | Fw0yMDAxMDMyMzA2MjBaMIHKMUcwRQYDVQQDEz5XcmFwcGluZyBLZXkgLSBUb2tl
8 | bml6YXRpb24gQVBJIFNhbmRib3ggRW5jcnlwdCAtIE1ERVMgRGVjcnlwdDETMBEG
9 | A1UECxMKTURFUyAtIE1URjE0MDIGA1UEChMrTWFzdGVyQ2FyZCBXb3JsZFdpZGUg
10 | LSBDb21tb24gUHJvZEluZnJhIFNTTDEUMBIGA1UEBxMLU2FpbnQgTG91aXMxETAP
11 | BgNVBAgTCE1pc3NvdXJpMQswCQYDVQQGEwJVUzCCASIwDQYJKoZIhvcNAQEBBQAD
12 | ggEPADCCAQoCggEBALMQmc1tg4Olwn15Zu20Ojxn10U5p/IwhM7oXZTC+p1LnCYl
13 | A0So+R1BOXaCRqCJvVxprJW2l1nBJ/mBcPP1B0V8OoQErYDFQoBzxnbf6aRdoJ7Y
14 | L/OBb1GYOvFoDtE4+iGvW9sCHD0uYHiOhYFm5JsJ24Tq9qj0xEo/2qcqcpibBnzE
15 | EqxUaaIyurbzGSTctohq2fnuj8jLt87r9JBXlV5Jb1oKMK3sR7zRz6l6oip6bgfy
16 | tHyonQAqbuxuhKj7IqFjE+UyEos5anhP+gKB+PUm59BDI9KKik9xiLhzOL8JSNYG
17 | 1Vew0QFFr5dpjc4ZAEDgcp8g/fpgkbKHUzwIdhECAwEAAaNgMF4wHwYDVR0jBBgw
18 | FoAUPeXQ5iyKbL1ne56Kq3GEPOrclQUwDAYDVR0TBAUwAwIBADAOBgNVHQ8BAf8E
19 | BAMCBaAwHQYDVR0OBBYEFOqIblm9zwz+xo1K9WzEZ0MI8asSMA0GCSqGSIb3DQEB
20 | BQUAA4IBAQCMcAHSlE8N4r0yvtNU4R2qhlmDltBjv63XADjNSRxYzdtkgq/4Cbjg
21 | iLqNGKbkkba9hDsUcjRzTe86lnRL7HG1M5j0lV5b6i0nHaQEjDcdOfTwfOkCyP9a
22 | RD08POGA8tday45pBvegMLwNudDNZ5Rhc4LVbyHNxF0NNCIsXCzqpQoQ3FV6A3/8
23 | /fV7Fwj1vKxZVtvh7cjZwlArfE9BncDD2X5FBKdIUxYmhq8AeFHUZiLwBK0DLRpo
24 | E7nKUQ6KkgSG4YF3r7XuF+WTJAF4wdb2Opt7BY7kj/WHuxU+gps3qO1JwkvYcKrF
25 | 2r2MYyNJqNB/esCUspOtA8vMNS/WmhB4
26 | -----END CERTIFICATE-----
--------------------------------------------------------------------------------
/java/src/test/resources/fake-signing-key.p12:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Mastercard/mastercard-api-client-tutorial/5f884c764152164271d4ce8efdaf89060e2975b7/java/src/test/resources/fake-signing-key.p12
--------------------------------------------------------------------------------
/nodejs/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 | "presets": ["env", "stage-0"]
3 | }
4 |
--------------------------------------------------------------------------------
/nodejs/.openapi-generator/VERSION:
--------------------------------------------------------------------------------
1 | 7.5.0
2 |
--------------------------------------------------------------------------------
/nodejs/config.json:
--------------------------------------------------------------------------------
1 | {
2 | "useES6" : false
3 | }
4 |
--------------------------------------------------------------------------------
/nodejs/docs/AccountHolderData.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.AccountHolderData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **accountHolderName** | **String** | **(OPTIONAL)** The name of the cardholder in the format LASTNAME/FIRSTNAME or FIRSTNAME LASTNAME | [optional]
8 | **accountHolderAddress** | [**BillingAddress**](BillingAddress.md) | | [optional]
9 | **consumerIdentifier** | **String** | **(OPTIONAL)** Customer Identifier that may be required in some regions. | [optional]
10 | **accountHolderEmailAddress** | **String** | **(OPTIONAL)** The e-mail address of the Account Holder | [optional]
11 | **accountHolderMobilePhoneNumber** | [**PhoneNumber**](PhoneNumber.md) | | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/nodejs/docs/AccountHolderDataOutbound.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.AccountHolderDataOutbound
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **accountHolderName** | **String** | **(OPTIONAL)** The name of the cardholder | [optional]
8 | **accountHolderAddress** | [**BillingAddress**](BillingAddress.md) | | [optional]
9 | **accountHolderEmailAddress** | **String** | **(OPTIONAL)** The e-mail address of the Account Holder | [optional]
10 | **accountHolderMobilePhoneNumber** | [**PhoneNumber**](PhoneNumber.md) | | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/nodejs/docs/AssetResponseSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.AssetResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **mediaContents** | [**[MediaContent]**](MediaContent.md) | | [optional]
8 |
9 |
10 |
--------------------------------------------------------------------------------
/nodejs/docs/AuthenticationMethods.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.AuthenticationMethods
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **id** | **String** | Unique identifier assigned to this Authentication Method. | [optional]
8 | **type** | **String** | Specifies the authentication method type and provided in the tokenize response. See table here - https://developer.mastercard.com/mdes-digital-enablement/documentation/code-and-formats/#authentication-method-codes | [optional]
9 | **value** | **String** | Specifies the authentication method value (meaning varies depending on the authentication method type). | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/nodejs/docs/BillingAddress.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.BillingAddress
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **line1** | **String** | **(OPTIONAL)** The first line of the street address for the billing address. | [optional]
8 | **line2** | **String** | **(OPTIONAL)** The second line of the street address for the billing address. | [optional]
9 | **city** | **String** | **(OPTIONAL)** The city of the billing address. | [optional]
10 | **countrySubdivision** | **String** | **(OPTIONAL)** The state or country subdivision of the billing address. | [optional]
11 | **postalCode** | **String** | **(OPTIONAL)** The postal of code of the billing address. | [optional]
12 | **country** | **String** | **(OPTIONAL)** The country of the billing address. | [optional]
13 |
14 |
15 |
--------------------------------------------------------------------------------
/nodejs/docs/CardAccountDataInbound.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.CardAccountDataInbound
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **accountNumber** | **String** | The account number of the credit or debit card. **(CONDITIONAL)** required in a Tokenize, or Get Digital Asset request, unless a valid panUniqueReference or tokenUniqueReference or pushAccountReceipt was given in FundingAccountInfo. **NOTE**:Only 6 digits can be supplied in SearchTokens if the TokenUniqueReference is provided in fundingAccountInfo. | [optional]
8 | **expiryMonth** | **String** | The expiry month for the account. Two numeric digits must be supplied. Only supplied in tokenization requests if panUniqueReference or tokenUniqueReferenceForPanInfo or pushAccountReceipt is not present. **Format: MM** | [optional]
9 | **expiryYear** | **String** | **(Required as minimum for Tokenization)** The expiry year for the account. Only supplied in tokenization requests if panUniqueReference or tokenUniqueReferenceForPanInfo or pushAccountReceipt is not present. **Format: YY** | [optional]
10 | **securityCode** | **String** | **(OPTIONAL)** The security code for the account can optionally be provided for Tokenization. If provided, the validity will be checked. Optional in a Tokenize request, not present otherwise. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/nodejs/docs/CardAccountDataOutbound.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.CardAccountDataOutbound
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **accountNumber** | **String** | The account number of the credit or debit card. | [optional]
8 | **expiryMonth** | **String** | The expiry month for the account. Two numeric digits must be supplied. **Format: MM** | [optional]
9 | **expiryYear** | **String** | **(Required as minimum for Tokenization)** The expiry year for the account. **Format: YY** | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/nodejs/docs/DeleteRequestSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.DeleteRequestSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **requestId** | **String** | Unique identifier for the request. |
9 | **paymentAppInstanceId** | **String** | Identifier for the specific Mobile Payment App instance, unique across a given Wallet Identifier. This value cannot be changed after digitization. This field is alphanumeric and additionally web-safe base64 characters per RFC 4648 (minus \"-\", underscore \"_\") up to a maximum length of 48, = should not be URL encoded. Conditional - not applicable for server based tokens but required otherwise. | [optional]
10 | **tokenUniqueReferences** | **[String]** | The specific Token to be deleted. Array of more or more valid references as assigned by MDES |
11 | **causedBy** | **String** | Who or what caused the Token to be deleted. Must be either the 'CARDHOLDER' (operation requested by the Cardholder) or 'TOKEN_REQUESTOR' (operation requested by the token requestor). |
12 | **reason** | **String** | Free form reason why the Tokens are being suspended. | [optional]
13 | **reasonCode** | **String** | The reason for the action to be deleted. Must be one of 'SUSPECTED_FRAUD' (suspected fraudulent token transactions), 'OTHER' (Other - default used if value not provided). |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/nodejs/docs/DeleteResponseSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.DeleteResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **responseId** | **String** | Unique identifier for the response. | [optional]
9 | **tokens** | [**[TokenForLCM]**](TokenForLCM.md) | | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/nodejs/docs/EncryptedPayload.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.EncryptedPayload
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **publicKeyFingerprint** | **String** | The fingerprint of the public key used to encrypt the ephemeral AES key. |
8 | **encryptedKey** | **String** | One-time use AES key encrypted by the MasterCard public key (as identified by publicKeyFingerprint) using the OAEP or PKCS#1 v1.5 scheme (depending on the value of oaepHashingAlgorithm. |
9 | **oaepHashingAlgorithm** | **String** | Hashing algorithm used with the OAEP scheme. Must be either SHA256 or SHA512. | [optional]
10 | **iv** | **String** | The initialization vector used when encrypting data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. If not present, an IV of zero is assumed. Length - 32. | [optional]
11 | **encryptedData** | [**NotifyTokenEncryptedPayload**](NotifyTokenEncryptedPayload.md) | |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/nodejs/docs/EncryptedPayloadTransact.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.EncryptedPayloadTransact
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **publicKeyFingerprint** | **String** | The fingerprint of the public key used to encrypt the ephemeral AES key. | [optional]
8 | **encryptedKey** | **String** | One-time use AES key encrypted by the MasterCard public key (as identified by publicKeyFingerprint) using the OAEP or PKCS#1 v1.5 scheme (depending on the value of oaepHashingAlgorithm. | [optional]
9 | **oaepHashingAlgorithm** | **String** | Hashing algorithm used with the OAEP scheme. Must be either SHA256 or SHA512. | [optional]
10 | **iv** | **String** | The initialization vector used when encrypting data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. If not present, an IV of zero is assumed. | [optional]
11 | **encryptedData** | [**TransactEncryptedData**](TransactEncryptedData.md) | | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/nodejs/docs/Error.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.Error
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **source** | **String** | An element used to indicate the source of the issue causing this error. Must be one of * 'MDES' * 'INPUT' | [optional]
8 | **errorCode** | **String** | An error code generated by the gateway if the error occurs before reaching the MDES application. maxLength: 100 | [optional]
9 | **description** | **String** | Description of the reason the operation failed. See API Response Errors | [optional]
10 | **reasonCode** | **String** | A reason code for the error that has occurred. | [optional]
11 | **recoverable** | **Boolean** | Generated by the gateway to indicate if the request could presented again for processing. Either \"TRUE\" or \"FALSE\" | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/nodejs/docs/ErrorsResponse.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.ErrorsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **errorCode** | **String** | **CONDITIONAL** Returned in the event of an error and contains the reason the operation failed. Only use if errors object is not present. | [optional]
8 | **errorDescription** | **String** | **CONDITIONAL** Returned in the event of an error and contains a description of why the operation failed. Only use if errors object is not present. | [optional]
9 | **responseHost** | **String** | The MasterCard host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
10 | **responseId** | **String** | Unique identifier for the response. | [optional]
11 | **errors** | [**Error**](Error.md) | | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/nodejs/docs/FundingAccountData.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.FundingAccountData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **cardAccountData** | [**CardAccountDataInbound**](CardAccountDataInbound.md) | | [optional]
8 | **accountHolderData** | [**AccountHolderData**](AccountHolderData.md) | | [optional]
9 | **source** | **String** | (**Required as minimum for Tokenization**) The source of the account. Must be one of * ACCOUNT_ON_FILE * ACCOUNT_ADDED_MANUALLY * ACCOUNT_ADDED_VIA_APPLICATION | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/nodejs/docs/FundingAccountInfo.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.FundingAccountInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **panUniqueReference** | **String** | **(CONDITIONAL)** For repeat digitizations, the unique reference allocated to the Primary Account Number. When supplied, the tokenUniqueReferenceForPanInfo, accountNumber, expiryMonth and expiryYear must be omitted from CardInfoData. Only allowed if Only allowed if tokenUniqueReference and pushAccountReceipt are not present and encrypted data does not contain the account information. | [optional]
8 | **tokenUniqueReference** | **String** | **(CONDITIONAL)** A unique reference assigned following the allocation of a token used to identify the token for the duration of its lifetime. For repeat digitizations, the unique reference allocated to the token will be used to retrieve the financial account information. When supplied, the account information is omitted from FundingAccountData. Only allowed if panUniqueReference and pushAccountReceipt are not present and encrypted data does not contain the account information. | [optional]
9 | **encryptedPayload** | [**FundingAccountInfoEncryptedPayload**](FundingAccountInfoEncryptedPayload.md) | | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/nodejs/docs/FundingAccountInfoEncryptedPayload.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.FundingAccountInfoEncryptedPayload
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **publicKeyFingerprint** | **String** | The fingerprint of the public key used to encrypt the ephemeral AES key. | [optional]
8 | **encryptedKey** | **String** | One-time use AES key encrypted by the MasterCard public key (as identified by publicKeyFingerprint) using the OAEP or PKCS#1 v1.5 scheme (depending on the value of oaepHashingAlgorithm. | [optional]
9 | **oaepHashingAlgorithm** | **String** | Hashing algorithm used with the OAEP scheme. Must be either SHA256 or SHA512. | [optional]
10 | **iv** | **String** | The initialization vector used when encrypting data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. If not present, an IV of zero is assumed. | [optional]
11 | **encryptedData** | [**FundingAccountData**](FundingAccountData.md) | | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/nodejs/docs/GatewayError.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.GatewayError
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **source** | **String** | An element used to indicate the source of the issue causing this error. e.g. Gateway | [optional]
8 | **description** | **String** | Description of the reason the operation failed. See API Response Errors | [optional]
9 | **reasonCode** | **String** | A reason code for the error that has occurred. | [optional]
10 | **recoverable** | **Boolean** | Generated by the gateway to indicate if the request could presented again for processing. Either \"TRUE\" or \"FALSE\" | [optional]
11 | **details** | **Boolean** | Always NULL, present for backwards compatiility | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/nodejs/docs/GatewayErrorsResponse.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.GatewayErrorsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **errors** | [**GatewayErrorsSchema**](GatewayErrorsSchema.md) | | [optional]
8 |
9 |
10 |
--------------------------------------------------------------------------------
/nodejs/docs/GatewayErrorsSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.GatewayErrorsSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **error** | [**[GatewayError]**](GatewayError.md) | | [optional]
8 |
9 |
10 |
--------------------------------------------------------------------------------
/nodejs/docs/GetTaskStatusRequestSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.GetTaskStatusRequestSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **requestId** | **String** | Unique identifier for the request. |
9 | **tokenRequestorId** | **String** | 11-digit numeric ID provided by Mastercard that identifies the Token Requestor. |
10 | **taskId** | **String** | Unique identifier for this task. Must be an identifier previously used when requesting a task. |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/nodejs/docs/GetTaskStatusResponseSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.GetTaskStatusResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseId** | **String** | Unique identifier for the response. | [optional]
8 | **responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
9 | **status** | **String** | The status of the specified task. Must be either 'PENDING' (The Task has been recieved and is pending processing), 'IN_PROGRESS' (The task is currently in progress), 'COMPLETED' (The task was completed successfully) or 'FAILED' The task was processed but failed to complete successfully. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/nodejs/docs/GetTokenRequestSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.GetTokenRequestSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **requestId** | **String** | Unique identifier for the request. |
9 | **paymentAppInstanceId** | **String** | Identifier for the specific Mobile Payment App instance, unique across a given Wallet Identifier. This value cannot be changed after digitization. This field is alphanumeric and additionally web-safe base64 characters per RFC 4648 (minus \"-\", underscore \"_\") up to a maximum length of 48, = should not be URL encoded. Conditional - not applicable for server-based tokens but required otherwise. | [optional]
10 | **tokenUniqueReference** | **String** | The specific Token to be queried. |
11 | **includeTokenDetail** | **String** | Flag to indicate if the encrypted token should be returned. | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/nodejs/docs/GetTokenResponseSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.GetTokenResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseId** | **String** | Unique identifier for the response. | [optional]
8 | **token** | [**TokenForGetToken**](TokenForGetToken.md) | | [optional]
9 | **tokenDetail** | [**TokenDetailGetTokenOnly**](TokenDetailGetTokenOnly.md) | | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/nodejs/docs/MediaContent.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.MediaContent
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **type** | **String** | What type of media this is. Specified as a MIME type, which will be one of the following supported types * applicatoin/pdf (for images must be a vector PDF image) * image/png (includes alpha channel) * text/plain * text/html |
8 | **data** | **String** | The data for this item of media. Base64-encoded data, given in the format as specified in ?type?. |
9 | **height** | **String** | For image assets, the height of this image. Specified in pixels. | [optional]
10 | **width** | **String** | For image assets, the width of this image. Specified in pixels. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/nodejs/docs/NotifyTokenEncryptedPayload.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.NotifyTokenEncryptedPayload
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **tokens** | [**[TokenForNTU]**](TokenForNTU.md) | | [optional]
8 |
9 |
10 |
--------------------------------------------------------------------------------
/nodejs/docs/NotifyTokenUpdatedRequestSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.NotifyTokenUpdatedRequestSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseHost** | **String** | The host that originated the request. Future calls in the same conversation should be routed to this host. |
8 | **requestId** | **String** | Unique identifier for the request. |
9 | **encryptedPayload** | [**EncryptedPayload**](EncryptedPayload.md) | |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/nodejs/docs/NotifyTokenUpdatedResponseSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.NotifyTokenUpdatedResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **responseId** | **String** | Unique identifier for the response. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/nodejs/docs/PhoneNumber.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.PhoneNumber
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **countryDialInCode** | **Number** | **(OPTIONAL)** The country code for the phone number. E.g. 1 for US or 44 for UK. | [optional]
8 | **phoneNumber** | **Number** | **(OPTIONAL)** The phone number of the account holder | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/nodejs/docs/SearchTokensRequestSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.SearchTokensRequestSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **requestId** | **String** | Unique identifier for the request. |
8 | **responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
9 | **fundingAccountInfo** | [**FundingAccountInfo**](FundingAccountInfo.md) | | [optional]
10 | **tokenRequestorId** | **String** | Identifies the Token Requestor. Only tokens associated with the token requestor will be returned. Length - 11. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/nodejs/docs/SearchTokensResponseSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.SearchTokensResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **responseId** | **String** | Unique identifier for the response. | [optional]
9 | **tokens** | [**[Token]**](Token.md) | | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/nodejs/docs/SuspendRequestSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.SuspendRequestSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **requestId** | **String** | Unique identifier for the request. |
9 | **paymentAppInstanceId** | **String** | Identifier for the specific Mobile Payment App instance, unique across a given Wallet Identifier. This value cannot be changed after digitization. This field is alphanumeric and additionally web-safe base64 characters per RFC 4648 (minus \"-\", underscore \"_\") up to a maximum length of 48, = should not be URL encoded. Conditional - not applicable for server based tokens but required otherwise. | [optional]
10 | **tokenUniqueReferences** | **[String]** | The specific Token to be suspended. Array of more or more valid references as assigned by MDES |
11 | **causedBy** | **String** | Who or what caused the Token to be suspended. Must be either the 'CARDHOLDER' (operation requested by the Cardholder) or 'TOKEN_REQUESTOR' (operation requested by the token requestor). |
12 | **reason** | **String** | Free form reason why the Tokens are being suspended. | [optional]
13 | **reasonCode** | **String** | The reason for the action to be suspended. Must be one of 'SUSPECTED_FRAUD' (suspected fraudulent token transactions), 'OTHER' (Other - default used if value not provided). |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/nodejs/docs/SuspendResponseSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.SuspendResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **responseId** | **String** | Unique identifier for the response. | [optional]
9 | **tokens** | [**[TokenForLCM]**](TokenForLCM.md) | | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/nodejs/docs/Token.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.Token
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **tokenUniqueReference** | **String** | The unique reference allocated to the Token which is always present even if an error occurs. maxLength: 64 | [optional]
8 | **status** | **String** | The current status of Token. Must be either: * 'INACTIVE' (Token has not yet been activated) * 'ACTIVE' (Token is active and ready to transact) * 'SUSPENDED' (Token is suspended and unable to transact) * 'DEACTIVATED' (Token has been permanently deactivated). maxLength: 32 | [optional]
9 | **suspendedBy** | **[String]** | (CONDITIONAL only supplied if status is SUSPENDED) Who or what caused the Token to be suspended One or more values of: * ISSUER - Suspended by the Issuer. * TOKEN_REQUESTOR - Suspended by the Token Requestor * MOBILE_PIN_LOCKED - Suspended due to the Mobile PIN being locked * CARDHOLDER - Suspended by the Cardholder | [optional]
10 | **statusTimestamp** | **String** | The date and time the token status was last updated. Expressed in ISO 8601 extended format as one of the following: * YYYY-MM-DDThh:mm:ss[.sss]Z * YYYY-MM-DDThh:mm:ss[.sss]±hh:mm * Where [.sss] is optional and can be 1 to 3 digits. | [optional]
11 | **productConfig** | [**ProductConfig**](ProductConfig.md) | | [optional]
12 | **tokenInfo** | [**TokenInfo**](TokenInfo.md) | | [optional]
13 |
14 |
15 |
--------------------------------------------------------------------------------
/nodejs/docs/TokenDetail.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.TokenDetail
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **tokenUniqueReference** | **String** | Globally unique identifier for the Token, as assigned by MDES. | [optional]
8 | **publicKeyFingerprint** | **String** | The certificate fingerprint identifying the public key used to encrypt the ephemeral AES key. | [optional]
9 | **encryptedKey** | **String** | One-time use AES key encrypted by the MasterCard public key (as identified by 'publicKeyFingerprint') using the OAEP or RSA Encryption Standard PKCS #1 v1.5 scheme (depending on the value of 'oaepHashingAlgorithm'. Requirement is for a 128-bit key (with 256-bit key supported as an option). | [optional]
10 | **oaepHashingAlgorithm** | **String** | Hashing algorithm used with the OAEP scheme. If omitted, then the RSA Encryption Standard PKCS #1 v1.5 will be used. Must be either 'SHA256' (Use the SHA-256 algorithm) or 'SHA512' (Use the SHA-512 algorithm). | [optional]
11 | **iv** | **String** | It is recommended to supply a random initialization vector when encrypting the data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. Hex-encoded data (case-insensitive). | [optional]
12 | **encryptedData** | [**TokenDetailData**](TokenDetailData.md) | | [optional]
13 |
14 |
15 |
--------------------------------------------------------------------------------
/nodejs/docs/TokenDetailData.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.TokenDetailData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **paymentAccountReference** | **String** | \"The unique account reference assigned to the PAN. Conditionally returned if the Token Requestor has opted to receive PAR and providing PAR is assigned by Mastercard or the Issuer provides PAR in the authorization message response.\" | [optional]
8 |
9 |
10 |
--------------------------------------------------------------------------------
/nodejs/docs/TokenDetailDataGetTokenOnly.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.TokenDetailDataGetTokenOnly
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **tokenNumber** | **String** | The Token Primary Account Number of the Card. | [optional]
8 | **expiryMonth** | **String** | The month of the token expiration date. | [optional]
9 | **expiryYear** | **String** | The year of the token expiration date. | [optional]
10 | **paymentAccountReference** | **String** | The unique account reference assigned to the PAN. Conditionally returned if the Token Requestor has opted to receive PAR and providing PAR is assigned by Mastercard or the Issuer provides PAR in the authorization message response. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/nodejs/docs/TokenDetailDataPAROnly.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.TokenDetailDataPAROnly
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **paymentAccountReference** | **String** | The unique account reference assigned to the PAN. Conditionally returned if the Token Requestor has opted to receive PAR and providing PAR is assigned by Mastercard or the Issuer provides PAR in the authorization message response. | [optional]
8 |
9 |
10 |
--------------------------------------------------------------------------------
/nodejs/docs/TokenDetailGetTokenOnly.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.TokenDetailGetTokenOnly
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **tokenUniqueReference** | **String** | Globally unique identifier for the Token, as assigned by MDES. | [optional]
8 | **publicKeyFingerprint** | **String** | The certificate fingerprint identifying the public key used to encrypt the ephemeral AES key. | [optional]
9 | **encryptedKey** | **String** | One-time use AES key encrypted by the MasterCard public key (as identified by 'publicKeyFingerprint') using the OAEP or RSA Encryption Standard PKCS #1 v1.5 scheme (depending on the value of 'oaepHashingAlgorithm'. Requirement is for a 128-bit key (with 256-bit key supported as an option). | [optional]
10 | **oaepHashingAlgorithm** | **String** | Hashing algorithm used with the OAEP scheme. If omitted, then the RSA Encryption Standard PKCS #1 v1.5 will be used. Must be either 'SHA256' (Use the SHA-256 algorithm) or 'SHA512' (Use the SHA-512 algorithm). | [optional]
11 | **iv** | **String** | It is recommended to supply a random initialization vector when encrypting the data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. Hex-encoded data (case-insensitive). | [optional]
12 | **encryptedData** | [**TokenDetailDataGetTokenOnly**](TokenDetailDataGetTokenOnly.md) | | [optional]
13 |
14 |
15 |
--------------------------------------------------------------------------------
/nodejs/docs/TokenDetailPAROnly.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.TokenDetailPAROnly
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **tokenUniqueReference** | **String** | Globally unique identifier for the Token, as assigned by MDES.<br> | [optional]
8 | **publicKeyFingerprint** | **String** | The certificate fingerprint identifying the public key used to encrypt the ephemeral AES key. | [optional]
9 | **encryptedKey** | **String** | One-time use AES key encrypted by the MasterCard public key (as identified by 'publicKeyFingerprint') using the OAEP or RSA Encryption Standard PKCS #1 v1.5 scheme (depending on the value of 'oaepHashingAlgorithm'. Requirement is for a 128-bit key (with 256-bit key supported as an option). | [optional]
10 | **oaepHashingAlgorithm** | **String** | Hashing algorithm used with the OAEP scheme. If omitted, then the RSA Encryption Standard PKCS #1 v1.5 will be used. Must be either 'SHA256' (Use the SHA-256 algorithm) or 'SHA512' (Use the SHA-512 algorithm). | [optional]
11 | **iv** | **String** | It is recommended to supply a random initialization vector when encrypting the data using the one-time use AES key. Must be exactly 16 bytes (32 character hex string) to match the block size. Hex-encoded data (case-insensitive). | [optional]
12 | **encryptedData** | [**TokenDetailDataPAROnly**](TokenDetailDataPAROnly.md) | | [optional]
13 |
14 |
15 |
--------------------------------------------------------------------------------
/nodejs/docs/TokenForGetToken.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.TokenForGetToken
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **tokenUniqueReference** | **String** | The unique reference allocated to the Token which is always present even if an error occurs. maxLength: 64 | [optional]
8 | **tokenRequestorId** | **String** | Identifies the Token Requestor. <br> minLength: 11 maxLength: 11 | [optional]
9 | **status** | **String** | The current status of Token. Must be either: * 'INACTIVE' (Token has not yet been activated) * 'ACTIVE' (Token is active and ready to transact) * 'SUSPENDED' (Token is suspended and unable to transact) * 'DEACTIVATED' (Token has been permanently deactivated). maxLength: 32 | [optional]
10 | **suspendedBy** | **[String]** | (CONDITIONAL only supplied if status is SUSPENDED) Who or what caused the Token to be suspended One or more values of: * ISSUER - Suspended by the Issuer. * TOKEN_REQUESTOR - Suspended by the Token Requestor * MOBILE_PIN_LOCKED - Suspended due to the Mobile PIN being locked * CARDHOLDER - Suspended by the Cardholder | [optional]
11 | **statusTimestamp** | **String** | The date and time the token status was last updated. Expressed in ISO 8601 extended format as one of the following: * YYYY-MM-DDThh:mm:ss[.sss]Z * YYYY-MM-DDThh:mm:ss[.sss]±hh:mm * Where [.sss] is optional and can be 1 to 3 digits. | [optional]
12 | **productConfig** | [**ProductConfig**](ProductConfig.md) | | [optional]
13 | **tokenInfo** | [**TokenInfoForNTUAndGetToken**](TokenInfoForNTUAndGetToken.md) | | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/nodejs/docs/TokenForLCM.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.TokenForLCM
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **tokenUniqueReference** | **String** | The unique reference allocated to the Token which is always present even if an error occurs. maxLength: 64 | [optional]
8 | **status** | **String** | The current status of Token. Must be either: * 'INACTIVE' (Token has not yet been activated) * 'ACTIVE' (Token is active and ready to transact) * 'SUSPENDED' (Token is suspended and unable to transact) * 'DEACTIVATED' (Token has been permanently deactivated). maxLength: 32 | [optional]
9 | **suspendedBy** | **[String]** | (CONDITIONAL only supplied if status is SUSPENDED) Who or what caused the Token to be suspended One or more values of: * ISSUER - Suspended by the Issuer. * TOKEN_REQUESTOR - Suspended by the Token Requestor * MOBILE_PIN_LOCKED - Suspended due to the Mobile PIN being locked * CARDHOLDER - Suspended by the Cardholder | [optional]
10 | **statusTimestamp** | **String** | The date and time the token status was last updated. Expressed in ISO 8601 extended format as one of the following: * YYYY-MM-DDThh:mm:ss[.sss]Z * YYYY-MM-DDThh:mm:ss[.sss]±hh:mm * Where [.sss] is optional and can be 1 to 3 digits. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/nodejs/docs/TokenInfo.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.TokenInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **tokenPanSuffix** | **String** | The last few digits (typically four) of the Token PAN. |
8 | **accountPanSuffix** | **String** | The last few digits (typically four) of the Account PAN. |
9 | **tokenExpiry** | **String** | The expiry of the Token PAN, given in MMYY format. |
10 | **accountPanExpiry** | **String** | The expiry of the Account PAN, given in MMYY format. | [optional]
11 | **dsrpCapable** | **String** | Whether DSRP transactions are supported by this Token. Must be either 'true' (DSRP capable) or 'false' (Not DSRP capable). |
12 | **tokenAssuranceLevel** | **Number** | A value indicating the confidence level of the token to Account PAN binding. | [optional]
13 | **productCategory** | **String** | The product category of the Account PAN. When supplied will be one of the following values: * CREDIT * DEBIT * PREPAID * UNKNOWN | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/nodejs/docs/TokenInfoForNTUAndGetToken.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.TokenInfoForNTUAndGetToken
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **tokenPanSuffix** | **String** | The last few digits (typically four) of the Token PAN. |
8 | **accountPanPrefix** | **String** | The first few digits (typically six) of the Account PAN. |
9 | **accountPanSuffix** | **String** | The last few digits (typically four) of the Account PAN. |
10 | **tokenExpiry** | **String** | The expiry of the Token PAN, given in MMYY format. |
11 | **accountPanExpiry** | **String** | The expiry of the Account PAN, given in MMYY format. | [optional]
12 | **dsrpCapable** | **String** | Whether DSRP transactions are supported by this Token. Must be either 'true' (DSRP capable) or 'false' (Not DSRP capable). |
13 | **tokenAssuranceLevel** | **Number** | A value indicating the confidence level of the token to Account PAN binding. | [optional]
14 | **productCategory** | **String** | The product category of the Account PAN. When supplied will be one of the following values: * CREDIT * DEBIT * PREPAID * UNKNOWN | [optional]
15 |
16 |
17 |
--------------------------------------------------------------------------------
/nodejs/docs/TokenizeRequestSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.TokenizeRequestSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseHost** | **String** | \"The host that originated the request. Future calls in the same conversation may be routed to this host. Must be provided as: host[:port][/contextRoot] Where port and contextRoot are optional. If contextRoot is not provided, the default (per the URL Scheme) is assumed and must be used.\" | [optional]
8 | **requestId** | **String** | Unique identifier for the request. | [optional]
9 | **tokenType** | **String** | The type of Token requested. Must be CLOUD |
10 | **tokenRequestorId** | **String** | 11-digit numeric ID provided by Mastercard that identifies the Token Requestor. |
11 | **taskId** | **String** | Identifier for this task as assigned by the Token Requestor, unique across a given Token Requestor Identifier. May be used in the Get Task Status API to query the status of this task. |
12 | **fundingAccountInfo** | [**FundingAccountInfo**](FundingAccountInfo.md) | |
13 | **consumerLanguage** | **String** | Language preference selected by the consumer. Formatted as an ISO- 639-1 two-letter language code. | [optional]
14 | **tokenizationAuthenticationValue** | **String** | The Tokenization Authentication Value (TAV) as cryptographically signed by the Issuer to authorize this digitization request. | [optional]
15 | **decisioningData** | [**DecisioningData**](DecisioningData.md) | | [optional]
16 |
17 |
18 |
--------------------------------------------------------------------------------
/nodejs/docs/TransactEncryptedData.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.TransactEncryptedData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **accountNumber** | **String** | The Primary Account Number for the transaction ? this is the Token PAN. | [optional]
8 | **applicationExpiryDate** | **String** | Application expiry date for the Token. Expressed in YYMMDD format. | [optional]
9 | **panSequenceNumber** | **String** | Application PAN sequence number for the Token | [optional]
10 | **track2Equivalent** | **String** | Track 2 equivalent data for the Token. Expressed according to ISO/IEC 7813, excluding start sentinel, end sentinel, and Longitudinal Redundancy Check (LRC), using hex nibble 'D' as field separator, and padded to whole bytes using one hex nibble 'F' as needed. | [optional]
11 | **de48se43Data** | **String** | Data for DE 48 Subelement 43 containing the cryptogram. DSRP cryptogram must be sent in DE104. Please refer to AN 3363 for details. | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/nodejs/docs/TransactError.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.TransactError
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **source** | **String** | An element used to indicate the source of the issue causing this error. Must be one of * 'MDES' * 'INPUT' | [optional]
8 | **errorCode** | **String** | A reason code or information pertaining to the error that has occurred. This will contain the error reported by the platform (e.g. authentication errors) or service (e.g. invalid TUR) | [optional]
9 | **description** | **String** | Description of the reason why the operation failed. | [optional]
10 | **reasonCode** | **String** | A reason code or information pertaining to the error that has occurred from the service (e.g. invalid TUR). See API Response Errors | [optional]
11 | **errorDescription** | **String** | **DEPRECATED** Use description instead. | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/nodejs/docs/TransactRequestSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.TransactRequestSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **requestId** | **String** | Unique identifier for the request. |
9 | **tokenUniqueReference** | **String** | Globally unique identifier for the Token, as assigned by MDES. |
10 | **dsrpType** | **String** | What type of DSRP cryptogram to create. Must be UCAF. |
11 | **unpredictableNumber** | **String** | HEX Encoded data (case sensitive) provided by the merchant to provide variability and uniqueness to the generation of a cryptogram. | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/nodejs/docs/TransactResponseSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.TransactResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseId** | **String** | Unique identifier for the response. | [optional]
8 | **responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
9 | **encryptedPayload** | [**EncryptedPayloadTransact**](EncryptedPayloadTransact.md) | | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/nodejs/docs/UnSuspendRequestSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.UnSuspendRequestSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **requestId** | **String** | Unique identifier for the request. |
9 | **paymentAppInstanceId** | **String** | Identifier for the specific Mobile Payment App instance, unique across a given Wallet Identifier. This value cannot be changed after digitization. This field is alphanumeric and additionally web-safe base64 characters per RFC 4648 (minus \"-\", underscore \"_\") up to a maximum length of 48, = should not be URL encoded. Conditional - not applicable for server based tokens but required otherwise. | [optional]
10 | **tokenUniqueReferences** | **[String]** | The specific Token to be unsuspended. Array of more or more valid references as assigned by MDES |
11 | **causedBy** | **String** | Who or what caused the Token to be unsuspended. Must be either the 'CARDHOLDER' (operation requested by the Cardholder) or 'TOKEN_REQUESTOR' (operation requested by the token requestor). |
12 | **reason** | **String** | Free form reason why the Tokens are being suspended. | [optional]
13 | **reasonCode** | **String** | The reason for the action to be unsuspended. Must be one of 'SUSPECTED_FRAUD' (suspected fraudulent token transactions), 'OTHER' (Other - default used if value not provided). |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/nodejs/docs/UnSuspendResponseSchema.md:
--------------------------------------------------------------------------------
1 | # MdesDigitalEnablementApi.UnSuspendResponseSchema
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **responseHost** | **String** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
8 | **responseId** | **String** | Unique identifier for the response. | [optional]
9 | **tokens** | [**[TokenForLCM]**](TokenForLCM.md) | | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/nodejs/generate-api-client.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | mv package.json package.json.bak
4 |
5 | # We assume OpenAPI Generator is installed using `npm i -g @openapitools/openapi-generator-cli`
6 | java -jar ~/bin/openapi-generator-cli-7.5.0.jar generate -i MDES_Digital_Enablement.yaml -g javascript -o . -c config.json --additional-properties=useES6=false
7 |
8 | #Remove some generated files we don't use in this tutorial
9 | rm git_push.sh
10 | rm .openapi-generator-ignore
11 | rm .travis.yml
12 |
13 | shopt -s extglob
14 | cd test
15 | rm -rf model
16 | cd api
17 | rm -fv !(TokenizeApi.spec.js)
18 | cd ../..
19 |
20 | mv package.json.bak package.json
21 |
--------------------------------------------------------------------------------
/nodejs/mocha.opts:
--------------------------------------------------------------------------------
1 | --timeout 10000
2 |
--------------------------------------------------------------------------------
/nodejs/test/resources/digital-enablement-sandbox-decryption-key.key:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Mastercard/mastercard-api-client-tutorial/5f884c764152164271d4ce8efdaf89060e2975b7/nodejs/test/resources/digital-enablement-sandbox-decryption-key.key
--------------------------------------------------------------------------------
/nodejs/test/resources/digital-enablement-sandbox-encryption-key.crt:
--------------------------------------------------------------------------------
1 | -----BEGIN CERTIFICATE-----
2 | MIIEZDCCA0ygAwIBAgIQQUmirRSB0Og8AbLmOXxo/DANBgkqhkiG9w0BAQUFADCB
3 | rjETMBEGCgmSJomT8ixkARkWA2NvbTEaMBgGCgmSJomT8ixkARkWCm1hc3RlcmNh
4 | cmQxHTAbBgNVBAoTFE1hc3RlckNhcmQgV29ybGRXaWRlMSQwIgYDVQQLExtHbG9i
5 | YWwgSW5mb3JtYXRpb24gU2VjdXJpdHkxNjA0BgNVBAMTLVBSRCBNQyBQcm9kdWN0
6 | aW9uIE5ldHdvcmsgQXBwbGljYXRpb25zIHN1YiBDQTAeFw0xNjAxMDUwODEwMzJa
7 | Fw0yMDAxMDMyMzA2MjBaMIHKMUcwRQYDVQQDEz5XcmFwcGluZyBLZXkgLSBUb2tl
8 | bml6YXRpb24gQVBJIFNhbmRib3ggRW5jcnlwdCAtIE1ERVMgRGVjcnlwdDETMBEG
9 | A1UECxMKTURFUyAtIE1URjE0MDIGA1UEChMrTWFzdGVyQ2FyZCBXb3JsZFdpZGUg
10 | LSBDb21tb24gUHJvZEluZnJhIFNTTDEUMBIGA1UEBxMLU2FpbnQgTG91aXMxETAP
11 | BgNVBAgTCE1pc3NvdXJpMQswCQYDVQQGEwJVUzCCASIwDQYJKoZIhvcNAQEBBQAD
12 | ggEPADCCAQoCggEBALMQmc1tg4Olwn15Zu20Ojxn10U5p/IwhM7oXZTC+p1LnCYl
13 | A0So+R1BOXaCRqCJvVxprJW2l1nBJ/mBcPP1B0V8OoQErYDFQoBzxnbf6aRdoJ7Y
14 | L/OBb1GYOvFoDtE4+iGvW9sCHD0uYHiOhYFm5JsJ24Tq9qj0xEo/2qcqcpibBnzE
15 | EqxUaaIyurbzGSTctohq2fnuj8jLt87r9JBXlV5Jb1oKMK3sR7zRz6l6oip6bgfy
16 | tHyonQAqbuxuhKj7IqFjE+UyEos5anhP+gKB+PUm59BDI9KKik9xiLhzOL8JSNYG
17 | 1Vew0QFFr5dpjc4ZAEDgcp8g/fpgkbKHUzwIdhECAwEAAaNgMF4wHwYDVR0jBBgw
18 | FoAUPeXQ5iyKbL1ne56Kq3GEPOrclQUwDAYDVR0TBAUwAwIBADAOBgNVHQ8BAf8E
19 | BAMCBaAwHQYDVR0OBBYEFOqIblm9zwz+xo1K9WzEZ0MI8asSMA0GCSqGSIb3DQEB
20 | BQUAA4IBAQCMcAHSlE8N4r0yvtNU4R2qhlmDltBjv63XADjNSRxYzdtkgq/4Cbjg
21 | iLqNGKbkkba9hDsUcjRzTe86lnRL7HG1M5j0lV5b6i0nHaQEjDcdOfTwfOkCyP9a
22 | RD08POGA8tday45pBvegMLwNudDNZ5Rhc4LVbyHNxF0NNCIsXCzqpQoQ3FV6A3/8
23 | /fV7Fwj1vKxZVtvh7cjZwlArfE9BncDD2X5FBKdIUxYmhq8AeFHUZiLwBK0DLRpo
24 | E7nKUQ6KkgSG4YF3r7XuF+WTJAF4wdb2Opt7BY7kj/WHuxU+gps3qO1JwkvYcKrF
25 | 2r2MYyNJqNB/esCUspOtA8vMNS/WmhB4
26 | -----END CERTIFICATE-----
--------------------------------------------------------------------------------
/nodejs/test/resources/fake-signing-key.p12:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Mastercard/mastercard-api-client-tutorial/5f884c764152164271d4ce8efdaf89060e2975b7/nodejs/test/resources/fake-signing-key.p12
--------------------------------------------------------------------------------
/python/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | env/
12 | build/
13 | develop-eggs/
14 | dist/
15 | downloads/
16 | eggs/
17 | .eggs/
18 | lib/
19 | lib64/
20 | parts/
21 | sdist/
22 | var/
23 | *.egg-info/
24 | .installed.cfg
25 | *.egg
26 |
27 | # PyInstaller
28 | # Usually these files are written by a python script from a template
29 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
30 | *.manifest
31 | *.spec
32 |
33 | # Installer logs
34 | pip-log.txt
35 | pip-delete-this-directory.txt
36 |
37 | # Unit test / coverage reports
38 | htmlcov/
39 | .tox/
40 | .coverage
41 | .coverage.*
42 | .cache
43 | nosetests.xml
44 | coverage.xml
45 | *,cover
46 | .hypothesis/
47 | venv/
48 | .venv/
49 | .python-version
50 | .pytest_cache
51 |
52 | # Translations
53 | *.mo
54 | *.pot
55 |
56 | # Django stuff:
57 | *.log
58 |
59 | # Sphinx documentation
60 | docs/_build/
61 |
62 | # PyBuilder
63 | target/
64 |
65 | #Ipython Notebook
66 | .ipynb_checkpoints
67 |
--------------------------------------------------------------------------------
/python/.openapi-generator/VERSION:
--------------------------------------------------------------------------------
1 | 7.5.0
2 |
--------------------------------------------------------------------------------
/python/docs/AccountHolderData.md:
--------------------------------------------------------------------------------
1 | # AccountHolderData
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **account_holder_name** | **str** | **(OPTIONAL)** The name of the cardholder in the format LASTNAME/FIRSTNAME or FIRSTNAME LASTNAME | [optional]
9 | **account_holder_address** | [**BillingAddress**](BillingAddress.md) | | [optional]
10 | **consumer_identifier** | **str** | **(OPTIONAL)** Customer Identifier that may be required in some regions. | [optional]
11 | **account_holder_email_address** | **str** | **(OPTIONAL)** The e-mail address of the Account Holder | [optional]
12 | **account_holder_mobile_phone_number** | [**PhoneNumber**](PhoneNumber.md) | | [optional]
13 |
14 | ## Example
15 |
16 | ```python
17 | from openapi_client.models.account_holder_data import AccountHolderData
18 |
19 | # TODO update the JSON string below
20 | json = "{}"
21 | # create an instance of AccountHolderData from a JSON string
22 | account_holder_data_instance = AccountHolderData.from_json(json)
23 | # print the JSON string representation of the object
24 | print(AccountHolderData.to_json())
25 |
26 | # convert the object into a dict
27 | account_holder_data_dict = account_holder_data_instance.to_dict()
28 | # create an instance of AccountHolderData from a dict
29 | account_holder_data_from_dict = AccountHolderData.from_dict(account_holder_data_dict)
30 | ```
31 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/python/docs/AssetResponseSchema.md:
--------------------------------------------------------------------------------
1 | # AssetResponseSchema
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **media_contents** | [**List[MediaContent]**](MediaContent.md) | | [optional]
9 |
10 | ## Example
11 |
12 | ```python
13 | from openapi_client.models.asset_response_schema import AssetResponseSchema
14 |
15 | # TODO update the JSON string below
16 | json = "{}"
17 | # create an instance of AssetResponseSchema from a JSON string
18 | asset_response_schema_instance = AssetResponseSchema.from_json(json)
19 | # print the JSON string representation of the object
20 | print(AssetResponseSchema.to_json())
21 |
22 | # convert the object into a dict
23 | asset_response_schema_dict = asset_response_schema_instance.to_dict()
24 | # create an instance of AssetResponseSchema from a dict
25 | asset_response_schema_from_dict = AssetResponseSchema.from_dict(asset_response_schema_dict)
26 | ```
27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28 |
29 |
30 |
--------------------------------------------------------------------------------
/python/docs/AuthenticationMethods.md:
--------------------------------------------------------------------------------
1 | # AuthenticationMethods
2 |
3 | \"authenticationMethods not currently used for MDES for Merchants\"
4 |
5 | ## Properties
6 |
7 | Name | Type | Description | Notes
8 | ------------ | ------------- | ------------- | -------------
9 | **id** | **float** | Unique identifier assigned to this Authentication Method. | [optional]
10 | **type** | **str** | Specifies the authentication method type and provided in the tokenize response. See table here - https://developer.mastercard.com/mdes-digital-enablement/documentation/code-and-formats/#authentication-method-codes | [optional]
11 | **value** | **str** | Specifies the authentication method value (meaning varies depending on the authentication method type). | [optional]
12 |
13 | ## Example
14 |
15 | ```python
16 | from openapi_client.models.authentication_methods import AuthenticationMethods
17 |
18 | # TODO update the JSON string below
19 | json = "{}"
20 | # create an instance of AuthenticationMethods from a JSON string
21 | authentication_methods_instance = AuthenticationMethods.from_json(json)
22 | # print the JSON string representation of the object
23 | print(AuthenticationMethods.to_json())
24 |
25 | # convert the object into a dict
26 | authentication_methods_dict = authentication_methods_instance.to_dict()
27 | # create an instance of AuthenticationMethods from a dict
28 | authentication_methods_from_dict = AuthenticationMethods.from_dict(authentication_methods_dict)
29 | ```
30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
31 |
32 |
33 |
--------------------------------------------------------------------------------
/python/docs/BillingAddress.md:
--------------------------------------------------------------------------------
1 | # BillingAddress
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **line1** | **str** | **(OPTIONAL)** The first line of the street address for the billing address. | [optional]
9 | **line2** | **str** | **(OPTIONAL)** The second line of the street address for the billing address. | [optional]
10 | **city** | **str** | **(OPTIONAL)** The city of the billing address. | [optional]
11 | **country_subdivision** | **str** | **(OPTIONAL)** The state or country subdivision of the billing address. | [optional]
12 | **postal_code** | **str** | **(OPTIONAL)** The postal of code of the billing address. | [optional]
13 | **country** | **str** | **(OPTIONAL)** The country of the billing address. | [optional]
14 |
15 | ## Example
16 |
17 | ```python
18 | from openapi_client.models.billing_address import BillingAddress
19 |
20 | # TODO update the JSON string below
21 | json = "{}"
22 | # create an instance of BillingAddress from a JSON string
23 | billing_address_instance = BillingAddress.from_json(json)
24 | # print the JSON string representation of the object
25 | print(BillingAddress.to_json())
26 |
27 | # convert the object into a dict
28 | billing_address_dict = billing_address_instance.to_dict()
29 | # create an instance of BillingAddress from a dict
30 | billing_address_from_dict = BillingAddress.from_dict(billing_address_dict)
31 | ```
32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/python/docs/DeleteResponseSchema.md:
--------------------------------------------------------------------------------
1 | # DeleteResponseSchema
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **response_host** | **str** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
9 | **response_id** | **str** | Unique identifier for the response. | [optional]
10 | **tokens** | [**List[TokenForLCM]**](TokenForLCM.md) | | [optional]
11 |
12 | ## Example
13 |
14 | ```python
15 | from openapi_client.models.delete_response_schema import DeleteResponseSchema
16 |
17 | # TODO update the JSON string below
18 | json = "{}"
19 | # create an instance of DeleteResponseSchema from a JSON string
20 | delete_response_schema_instance = DeleteResponseSchema.from_json(json)
21 | # print the JSON string representation of the object
22 | print(DeleteResponseSchema.to_json())
23 |
24 | # convert the object into a dict
25 | delete_response_schema_dict = delete_response_schema_instance.to_dict()
26 | # create an instance of DeleteResponseSchema from a dict
27 | delete_response_schema_from_dict = DeleteResponseSchema.from_dict(delete_response_schema_dict)
28 | ```
29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/python/docs/Error.md:
--------------------------------------------------------------------------------
1 | # Error
2 |
3 | Only returned in the event of an error condition.
4 |
5 | ## Properties
6 |
7 | Name | Type | Description | Notes
8 | ------------ | ------------- | ------------- | -------------
9 | **source** | **str** | An element used to indicate the source of the issue causing this error. Must be one of * 'MDES' * 'INPUT' | [optional]
10 | **error_code** | **str** | An error code generated by the gateway if the error occurs before reaching the MDES application. maxLength: 100 | [optional]
11 | **description** | **str** | Description of the reason the operation failed. See API Response Errors | [optional]
12 | **reason_code** | **str** | A reason code for the error that has occurred. | [optional]
13 | **recoverable** | **bool** | Generated by the gateway to indicate if the request could presented again for processing. Either \"TRUE\" or \"FALSE\" | [optional]
14 |
15 | ## Example
16 |
17 | ```python
18 | from openapi_client.models.error import Error
19 |
20 | # TODO update the JSON string below
21 | json = "{}"
22 | # create an instance of Error from a JSON string
23 | error_instance = Error.from_json(json)
24 | # print the JSON string representation of the object
25 | print(Error.to_json())
26 |
27 | # convert the object into a dict
28 | error_dict = error_instance.to_dict()
29 | # create an instance of Error from a dict
30 | error_from_dict = Error.from_dict(error_dict)
31 | ```
32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/python/docs/ErrorsResponse.md:
--------------------------------------------------------------------------------
1 | # ErrorsResponse
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **error_code** | **str** | **CONDITIONAL** Returned in the event of an error and contains the reason the operation failed. Only use if errors object is not present. | [optional]
9 | **error_description** | **str** | **CONDITIONAL** Returned in the event of an error and contains a description of why the operation failed. Only use if errors object is not present. | [optional]
10 | **response_host** | **str** | The MasterCard host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
11 | **response_id** | **str** | Unique identifier for the response. | [optional]
12 | **errors** | [**Error**](Error.md) | | [optional]
13 |
14 | ## Example
15 |
16 | ```python
17 | from openapi_client.models.errors_response import ErrorsResponse
18 |
19 | # TODO update the JSON string below
20 | json = "{}"
21 | # create an instance of ErrorsResponse from a JSON string
22 | errors_response_instance = ErrorsResponse.from_json(json)
23 | # print the JSON string representation of the object
24 | print(ErrorsResponse.to_json())
25 |
26 | # convert the object into a dict
27 | errors_response_dict = errors_response_instance.to_dict()
28 | # create an instance of ErrorsResponse from a dict
29 | errors_response_from_dict = ErrorsResponse.from_dict(errors_response_dict)
30 | ```
31 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/python/docs/FundingAccountData.md:
--------------------------------------------------------------------------------
1 | # FundingAccountData
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **card_account_data** | [**CardAccountDataInbound**](CardAccountDataInbound.md) | | [optional]
9 | **account_holder_data** | [**AccountHolderData**](AccountHolderData.md) | | [optional]
10 | **source** | **str** | (**Required as minimum for Tokenization**) The source of the account. Must be one of * ACCOUNT_ON_FILE * ACCOUNT_ADDED_MANUALLY * ACCOUNT_ADDED_VIA_APPLICATION | [optional]
11 |
12 | ## Example
13 |
14 | ```python
15 | from openapi_client.models.funding_account_data import FundingAccountData
16 |
17 | # TODO update the JSON string below
18 | json = "{}"
19 | # create an instance of FundingAccountData from a JSON string
20 | funding_account_data_instance = FundingAccountData.from_json(json)
21 | # print the JSON string representation of the object
22 | print(FundingAccountData.to_json())
23 |
24 | # convert the object into a dict
25 | funding_account_data_dict = funding_account_data_instance.to_dict()
26 | # create an instance of FundingAccountData from a dict
27 | funding_account_data_from_dict = FundingAccountData.from_dict(funding_account_data_dict)
28 | ```
29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/python/docs/GatewayError.md:
--------------------------------------------------------------------------------
1 | # GatewayError
2 |
3 | Only returned in the event of an error condition.
4 |
5 | ## Properties
6 |
7 | Name | Type | Description | Notes
8 | ------------ | ------------- | ------------- | -------------
9 | **source** | **str** | An element used to indicate the source of the issue causing this error. e.g. Gateway | [optional]
10 | **description** | **str** | Description of the reason the operation failed. See API Response Errors | [optional]
11 | **reason_code** | **str** | A reason code for the error that has occurred. | [optional]
12 | **recoverable** | **bool** | Generated by the gateway to indicate if the request could presented again for processing. Either \"TRUE\" or \"FALSE\" | [optional]
13 | **details** | **bool** | Always NULL, present for backwards compatiility | [optional]
14 |
15 | ## Example
16 |
17 | ```python
18 | from openapi_client.models.gateway_error import GatewayError
19 |
20 | # TODO update the JSON string below
21 | json = "{}"
22 | # create an instance of GatewayError from a JSON string
23 | gateway_error_instance = GatewayError.from_json(json)
24 | # print the JSON string representation of the object
25 | print(GatewayError.to_json())
26 |
27 | # convert the object into a dict
28 | gateway_error_dict = gateway_error_instance.to_dict()
29 | # create an instance of GatewayError from a dict
30 | gateway_error_from_dict = GatewayError.from_dict(gateway_error_dict)
31 | ```
32 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/python/docs/GatewayErrorsResponse.md:
--------------------------------------------------------------------------------
1 | # GatewayErrorsResponse
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **errors** | [**GatewayErrorsSchema**](GatewayErrorsSchema.md) | | [optional]
9 |
10 | ## Example
11 |
12 | ```python
13 | from openapi_client.models.gateway_errors_response import GatewayErrorsResponse
14 |
15 | # TODO update the JSON string below
16 | json = "{}"
17 | # create an instance of GatewayErrorsResponse from a JSON string
18 | gateway_errors_response_instance = GatewayErrorsResponse.from_json(json)
19 | # print the JSON string representation of the object
20 | print(GatewayErrorsResponse.to_json())
21 |
22 | # convert the object into a dict
23 | gateway_errors_response_dict = gateway_errors_response_instance.to_dict()
24 | # create an instance of GatewayErrorsResponse from a dict
25 | gateway_errors_response_from_dict = GatewayErrorsResponse.from_dict(gateway_errors_response_dict)
26 | ```
27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28 |
29 |
30 |
--------------------------------------------------------------------------------
/python/docs/GatewayErrorsSchema.md:
--------------------------------------------------------------------------------
1 | # GatewayErrorsSchema
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **error** | [**List[GatewayError]**](GatewayError.md) | | [optional]
9 |
10 | ## Example
11 |
12 | ```python
13 | from openapi_client.models.gateway_errors_schema import GatewayErrorsSchema
14 |
15 | # TODO update the JSON string below
16 | json = "{}"
17 | # create an instance of GatewayErrorsSchema from a JSON string
18 | gateway_errors_schema_instance = GatewayErrorsSchema.from_json(json)
19 | # print the JSON string representation of the object
20 | print(GatewayErrorsSchema.to_json())
21 |
22 | # convert the object into a dict
23 | gateway_errors_schema_dict = gateway_errors_schema_instance.to_dict()
24 | # create an instance of GatewayErrorsSchema from a dict
25 | gateway_errors_schema_from_dict = GatewayErrorsSchema.from_dict(gateway_errors_schema_dict)
26 | ```
27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28 |
29 |
30 |
--------------------------------------------------------------------------------
/python/docs/GetTaskStatusRequestSchema.md:
--------------------------------------------------------------------------------
1 | # GetTaskStatusRequestSchema
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **response_host** | **str** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
9 | **request_id** | **str** | Unique identifier for the request. |
10 | **token_requestor_id** | **str** | 11-digit numeric ID provided by Mastercard that identifies the Token Requestor. |
11 | **task_id** | **str** | Unique identifier for this task. Must be an identifier previously used when requesting a task. |
12 |
13 | ## Example
14 |
15 | ```python
16 | from openapi_client.models.get_task_status_request_schema import GetTaskStatusRequestSchema
17 |
18 | # TODO update the JSON string below
19 | json = "{}"
20 | # create an instance of GetTaskStatusRequestSchema from a JSON string
21 | get_task_status_request_schema_instance = GetTaskStatusRequestSchema.from_json(json)
22 | # print the JSON string representation of the object
23 | print(GetTaskStatusRequestSchema.to_json())
24 |
25 | # convert the object into a dict
26 | get_task_status_request_schema_dict = get_task_status_request_schema_instance.to_dict()
27 | # create an instance of GetTaskStatusRequestSchema from a dict
28 | get_task_status_request_schema_from_dict = GetTaskStatusRequestSchema.from_dict(get_task_status_request_schema_dict)
29 | ```
30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
31 |
32 |
33 |
--------------------------------------------------------------------------------
/python/docs/GetTaskStatusResponseSchema.md:
--------------------------------------------------------------------------------
1 | # GetTaskStatusResponseSchema
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **response_id** | **str** | Unique identifier for the response. | [optional]
9 | **response_host** | **str** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
10 | **status** | **str** | The status of the specified task. Must be either 'PENDING' (The Task has been recieved and is pending processing), 'IN_PROGRESS' (The task is currently in progress), 'COMPLETED' (The task was completed successfully) or 'FAILED' The task was processed but failed to complete successfully. | [optional]
11 |
12 | ## Example
13 |
14 | ```python
15 | from openapi_client.models.get_task_status_response_schema import GetTaskStatusResponseSchema
16 |
17 | # TODO update the JSON string below
18 | json = "{}"
19 | # create an instance of GetTaskStatusResponseSchema from a JSON string
20 | get_task_status_response_schema_instance = GetTaskStatusResponseSchema.from_json(json)
21 | # print the JSON string representation of the object
22 | print(GetTaskStatusResponseSchema.to_json())
23 |
24 | # convert the object into a dict
25 | get_task_status_response_schema_dict = get_task_status_response_schema_instance.to_dict()
26 | # create an instance of GetTaskStatusResponseSchema from a dict
27 | get_task_status_response_schema_from_dict = GetTaskStatusResponseSchema.from_dict(get_task_status_response_schema_dict)
28 | ```
29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/python/docs/GetTokenResponseSchema.md:
--------------------------------------------------------------------------------
1 | # GetTokenResponseSchema
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **response_id** | **str** | Unique identifier for the response. | [optional]
9 | **token** | [**TokenForGetToken**](TokenForGetToken.md) | | [optional]
10 | **token_detail** | [**TokenDetailGetTokenOnly**](TokenDetailGetTokenOnly.md) | | [optional]
11 |
12 | ## Example
13 |
14 | ```python
15 | from openapi_client.models.get_token_response_schema import GetTokenResponseSchema
16 |
17 | # TODO update the JSON string below
18 | json = "{}"
19 | # create an instance of GetTokenResponseSchema from a JSON string
20 | get_token_response_schema_instance = GetTokenResponseSchema.from_json(json)
21 | # print the JSON string representation of the object
22 | print(GetTokenResponseSchema.to_json())
23 |
24 | # convert the object into a dict
25 | get_token_response_schema_dict = get_token_response_schema_instance.to_dict()
26 | # create an instance of GetTokenResponseSchema from a dict
27 | get_token_response_schema_from_dict = GetTokenResponseSchema.from_dict(get_token_response_schema_dict)
28 | ```
29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/python/docs/MediaContent.md:
--------------------------------------------------------------------------------
1 | # MediaContent
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **type** | **str** | What type of media this is. Specified as a MIME type, which will be one of the following supported types * applicatoin/pdf (for images must be a vector PDF image) * image/png (includes alpha channel) * text/plain * text/html |
9 | **data** | **str** | The data for this item of media. Base64-encoded data, given in the format as specified in ?type?. |
10 | **height** | **str** | For image assets, the height of this image. Specified in pixels. | [optional]
11 | **width** | **str** | For image assets, the width of this image. Specified in pixels. | [optional]
12 |
13 | ## Example
14 |
15 | ```python
16 | from openapi_client.models.media_content import MediaContent
17 |
18 | # TODO update the JSON string below
19 | json = "{}"
20 | # create an instance of MediaContent from a JSON string
21 | media_content_instance = MediaContent.from_json(json)
22 | # print the JSON string representation of the object
23 | print(MediaContent.to_json())
24 |
25 | # convert the object into a dict
26 | media_content_dict = media_content_instance.to_dict()
27 | # create an instance of MediaContent from a dict
28 | media_content_from_dict = MediaContent.from_dict(media_content_dict)
29 | ```
30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
31 |
32 |
33 |
--------------------------------------------------------------------------------
/python/docs/NotifyTokenEncryptedPayload.md:
--------------------------------------------------------------------------------
1 | # NotifyTokenEncryptedPayload
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **tokens** | [**List[TokenForNTU]**](TokenForNTU.md) | | [optional]
9 |
10 | ## Example
11 |
12 | ```python
13 | from openapi_client.models.notify_token_encrypted_payload import NotifyTokenEncryptedPayload
14 |
15 | # TODO update the JSON string below
16 | json = "{}"
17 | # create an instance of NotifyTokenEncryptedPayload from a JSON string
18 | notify_token_encrypted_payload_instance = NotifyTokenEncryptedPayload.from_json(json)
19 | # print the JSON string representation of the object
20 | print(NotifyTokenEncryptedPayload.to_json())
21 |
22 | # convert the object into a dict
23 | notify_token_encrypted_payload_dict = notify_token_encrypted_payload_instance.to_dict()
24 | # create an instance of NotifyTokenEncryptedPayload from a dict
25 | notify_token_encrypted_payload_from_dict = NotifyTokenEncryptedPayload.from_dict(notify_token_encrypted_payload_dict)
26 | ```
27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28 |
29 |
30 |
--------------------------------------------------------------------------------
/python/docs/NotifyTokenUpdatedRequestSchema.md:
--------------------------------------------------------------------------------
1 | # NotifyTokenUpdatedRequestSchema
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **response_host** | **str** | The host that originated the request. Future calls in the same conversation should be routed to this host. |
9 | **request_id** | **str** | Unique identifier for the request. |
10 | **encrypted_payload** | [**EncryptedPayload**](EncryptedPayload.md) | |
11 |
12 | ## Example
13 |
14 | ```python
15 | from openapi_client.models.notify_token_updated_request_schema import NotifyTokenUpdatedRequestSchema
16 |
17 | # TODO update the JSON string below
18 | json = "{}"
19 | # create an instance of NotifyTokenUpdatedRequestSchema from a JSON string
20 | notify_token_updated_request_schema_instance = NotifyTokenUpdatedRequestSchema.from_json(json)
21 | # print the JSON string representation of the object
22 | print(NotifyTokenUpdatedRequestSchema.to_json())
23 |
24 | # convert the object into a dict
25 | notify_token_updated_request_schema_dict = notify_token_updated_request_schema_instance.to_dict()
26 | # create an instance of NotifyTokenUpdatedRequestSchema from a dict
27 | notify_token_updated_request_schema_from_dict = NotifyTokenUpdatedRequestSchema.from_dict(notify_token_updated_request_schema_dict)
28 | ```
29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/python/docs/NotifyTokenUpdatedResponseSchema.md:
--------------------------------------------------------------------------------
1 | # NotifyTokenUpdatedResponseSchema
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **response_host** | **str** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
9 | **response_id** | **str** | Unique identifier for the response. | [optional]
10 |
11 | ## Example
12 |
13 | ```python
14 | from openapi_client.models.notify_token_updated_response_schema import NotifyTokenUpdatedResponseSchema
15 |
16 | # TODO update the JSON string below
17 | json = "{}"
18 | # create an instance of NotifyTokenUpdatedResponseSchema from a JSON string
19 | notify_token_updated_response_schema_instance = NotifyTokenUpdatedResponseSchema.from_json(json)
20 | # print the JSON string representation of the object
21 | print(NotifyTokenUpdatedResponseSchema.to_json())
22 |
23 | # convert the object into a dict
24 | notify_token_updated_response_schema_dict = notify_token_updated_response_schema_instance.to_dict()
25 | # create an instance of NotifyTokenUpdatedResponseSchema from a dict
26 | notify_token_updated_response_schema_from_dict = NotifyTokenUpdatedResponseSchema.from_dict(notify_token_updated_response_schema_dict)
27 | ```
28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
29 |
30 |
31 |
--------------------------------------------------------------------------------
/python/docs/PhoneNumber.md:
--------------------------------------------------------------------------------
1 | # PhoneNumber
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **country_dial_in_code** | **float** | **(OPTIONAL)** The country code for the phone number. E.g. 1 for US or 44 for UK. | [optional]
9 | **phone_number** | **float** | **(OPTIONAL)** The phone number of the account holder | [optional]
10 |
11 | ## Example
12 |
13 | ```python
14 | from openapi_client.models.phone_number import PhoneNumber
15 |
16 | # TODO update the JSON string below
17 | json = "{}"
18 | # create an instance of PhoneNumber from a JSON string
19 | phone_number_instance = PhoneNumber.from_json(json)
20 | # print the JSON string representation of the object
21 | print(PhoneNumber.to_json())
22 |
23 | # convert the object into a dict
24 | phone_number_dict = phone_number_instance.to_dict()
25 | # create an instance of PhoneNumber from a dict
26 | phone_number_from_dict = PhoneNumber.from_dict(phone_number_dict)
27 | ```
28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
29 |
30 |
31 |
--------------------------------------------------------------------------------
/python/docs/SearchTokensRequestSchema.md:
--------------------------------------------------------------------------------
1 | # SearchTokensRequestSchema
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **request_id** | **str** | Unique identifier for the request. |
9 | **response_host** | **str** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
10 | **funding_account_info** | [**FundingAccountInfo**](FundingAccountInfo.md) | | [optional]
11 | **token_requestor_id** | **str** | Identifies the Token Requestor. Only tokens associated with the token requestor will be returned. Length - 11. | [optional]
12 |
13 | ## Example
14 |
15 | ```python
16 | from openapi_client.models.search_tokens_request_schema import SearchTokensRequestSchema
17 |
18 | # TODO update the JSON string below
19 | json = "{}"
20 | # create an instance of SearchTokensRequestSchema from a JSON string
21 | search_tokens_request_schema_instance = SearchTokensRequestSchema.from_json(json)
22 | # print the JSON string representation of the object
23 | print(SearchTokensRequestSchema.to_json())
24 |
25 | # convert the object into a dict
26 | search_tokens_request_schema_dict = search_tokens_request_schema_instance.to_dict()
27 | # create an instance of SearchTokensRequestSchema from a dict
28 | search_tokens_request_schema_from_dict = SearchTokensRequestSchema.from_dict(search_tokens_request_schema_dict)
29 | ```
30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
31 |
32 |
33 |
--------------------------------------------------------------------------------
/python/docs/SearchTokensResponseSchema.md:
--------------------------------------------------------------------------------
1 | # SearchTokensResponseSchema
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **response_host** | **str** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
9 | **response_id** | **str** | Unique identifier for the response. | [optional]
10 | **tokens** | [**List[Token]**](Token.md) | | [optional]
11 |
12 | ## Example
13 |
14 | ```python
15 | from openapi_client.models.search_tokens_response_schema import SearchTokensResponseSchema
16 |
17 | # TODO update the JSON string below
18 | json = "{}"
19 | # create an instance of SearchTokensResponseSchema from a JSON string
20 | search_tokens_response_schema_instance = SearchTokensResponseSchema.from_json(json)
21 | # print the JSON string representation of the object
22 | print(SearchTokensResponseSchema.to_json())
23 |
24 | # convert the object into a dict
25 | search_tokens_response_schema_dict = search_tokens_response_schema_instance.to_dict()
26 | # create an instance of SearchTokensResponseSchema from a dict
27 | search_tokens_response_schema_from_dict = SearchTokensResponseSchema.from_dict(search_tokens_response_schema_dict)
28 | ```
29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/python/docs/SuspendResponseSchema.md:
--------------------------------------------------------------------------------
1 | # SuspendResponseSchema
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **response_host** | **str** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
9 | **response_id** | **str** | Unique identifier for the response. | [optional]
10 | **tokens** | [**List[TokenForLCM]**](TokenForLCM.md) | | [optional]
11 |
12 | ## Example
13 |
14 | ```python
15 | from openapi_client.models.suspend_response_schema import SuspendResponseSchema
16 |
17 | # TODO update the JSON string below
18 | json = "{}"
19 | # create an instance of SuspendResponseSchema from a JSON string
20 | suspend_response_schema_instance = SuspendResponseSchema.from_json(json)
21 | # print the JSON string representation of the object
22 | print(SuspendResponseSchema.to_json())
23 |
24 | # convert the object into a dict
25 | suspend_response_schema_dict = suspend_response_schema_instance.to_dict()
26 | # create an instance of SuspendResponseSchema from a dict
27 | suspend_response_schema_from_dict = SuspendResponseSchema.from_dict(suspend_response_schema_dict)
28 | ```
29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/python/docs/TokenDetailData.md:
--------------------------------------------------------------------------------
1 | # TokenDetailData
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **payment_account_reference** | **str** | \"The unique account reference assigned to the PAN. Conditionally returned if the Token Requestor has opted to receive PAR and providing PAR is assigned by Mastercard or the Issuer provides PAR in the authorization message response.\" | [optional]
9 |
10 | ## Example
11 |
12 | ```python
13 | from openapi_client.models.token_detail_data import TokenDetailData
14 |
15 | # TODO update the JSON string below
16 | json = "{}"
17 | # create an instance of TokenDetailData from a JSON string
18 | token_detail_data_instance = TokenDetailData.from_json(json)
19 | # print the JSON string representation of the object
20 | print(TokenDetailData.to_json())
21 |
22 | # convert the object into a dict
23 | token_detail_data_dict = token_detail_data_instance.to_dict()
24 | # create an instance of TokenDetailData from a dict
25 | token_detail_data_from_dict = TokenDetailData.from_dict(token_detail_data_dict)
26 | ```
27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28 |
29 |
30 |
--------------------------------------------------------------------------------
/python/docs/TokenDetailDataGetTokenOnly.md:
--------------------------------------------------------------------------------
1 | # TokenDetailDataGetTokenOnly
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **token_number** | **str** | The Token Primary Account Number of the Card. | [optional]
9 | **expiry_month** | **str** | The month of the token expiration date. | [optional]
10 | **expiry_year** | **str** | The year of the token expiration date. | [optional]
11 | **payment_account_reference** | **str** | The unique account reference assigned to the PAN. Conditionally returned if the Token Requestor has opted to receive PAR and providing PAR is assigned by Mastercard or the Issuer provides PAR in the authorization message response. | [optional]
12 |
13 | ## Example
14 |
15 | ```python
16 | from openapi_client.models.token_detail_data_get_token_only import TokenDetailDataGetTokenOnly
17 |
18 | # TODO update the JSON string below
19 | json = "{}"
20 | # create an instance of TokenDetailDataGetTokenOnly from a JSON string
21 | token_detail_data_get_token_only_instance = TokenDetailDataGetTokenOnly.from_json(json)
22 | # print the JSON string representation of the object
23 | print(TokenDetailDataGetTokenOnly.to_json())
24 |
25 | # convert the object into a dict
26 | token_detail_data_get_token_only_dict = token_detail_data_get_token_only_instance.to_dict()
27 | # create an instance of TokenDetailDataGetTokenOnly from a dict
28 | token_detail_data_get_token_only_from_dict = TokenDetailDataGetTokenOnly.from_dict(token_detail_data_get_token_only_dict)
29 | ```
30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
31 |
32 |
33 |
--------------------------------------------------------------------------------
/python/docs/TokenDetailDataPAROnly.md:
--------------------------------------------------------------------------------
1 | # TokenDetailDataPAROnly
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **payment_account_reference** | **str** | The unique account reference assigned to the PAN. Conditionally returned if the Token Requestor has opted to receive PAR and providing PAR is assigned by Mastercard or the Issuer provides PAR in the authorization message response. | [optional]
9 |
10 | ## Example
11 |
12 | ```python
13 | from openapi_client.models.token_detail_data_par_only import TokenDetailDataPAROnly
14 |
15 | # TODO update the JSON string below
16 | json = "{}"
17 | # create an instance of TokenDetailDataPAROnly from a JSON string
18 | token_detail_data_par_only_instance = TokenDetailDataPAROnly.from_json(json)
19 | # print the JSON string representation of the object
20 | print(TokenDetailDataPAROnly.to_json())
21 |
22 | # convert the object into a dict
23 | token_detail_data_par_only_dict = token_detail_data_par_only_instance.to_dict()
24 | # create an instance of TokenDetailDataPAROnly from a dict
25 | token_detail_data_par_only_from_dict = TokenDetailDataPAROnly.from_dict(token_detail_data_par_only_dict)
26 | ```
27 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28 |
29 |
30 |
--------------------------------------------------------------------------------
/python/docs/TransactRequestSchema.md:
--------------------------------------------------------------------------------
1 | # TransactRequestSchema
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **response_host** | **str** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
9 | **request_id** | **str** | Unique identifier for the request. |
10 | **token_unique_reference** | **str** | Globally unique identifier for the Token, as assigned by MDES. |
11 | **dsrp_type** | **str** | What type of DSRP cryptogram to create. Must be UCAF. |
12 | **unpredictable_number** | **str** | HEX Encoded data (case sensitive) provided by the merchant to provide variability and uniqueness to the generation of a cryptogram. | [optional]
13 |
14 | ## Example
15 |
16 | ```python
17 | from openapi_client.models.transact_request_schema import TransactRequestSchema
18 |
19 | # TODO update the JSON string below
20 | json = "{}"
21 | # create an instance of TransactRequestSchema from a JSON string
22 | transact_request_schema_instance = TransactRequestSchema.from_json(json)
23 | # print the JSON string representation of the object
24 | print(TransactRequestSchema.to_json())
25 |
26 | # convert the object into a dict
27 | transact_request_schema_dict = transact_request_schema_instance.to_dict()
28 | # create an instance of TransactRequestSchema from a dict
29 | transact_request_schema_from_dict = TransactRequestSchema.from_dict(transact_request_schema_dict)
30 | ```
31 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/python/docs/TransactResponseSchema.md:
--------------------------------------------------------------------------------
1 | # TransactResponseSchema
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **response_id** | **str** | Unique identifier for the response. | [optional]
9 | **response_host** | **str** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
10 | **encrypted_payload** | [**EncryptedPayloadTransact**](EncryptedPayloadTransact.md) | | [optional]
11 |
12 | ## Example
13 |
14 | ```python
15 | from openapi_client.models.transact_response_schema import TransactResponseSchema
16 |
17 | # TODO update the JSON string below
18 | json = "{}"
19 | # create an instance of TransactResponseSchema from a JSON string
20 | transact_response_schema_instance = TransactResponseSchema.from_json(json)
21 | # print the JSON string representation of the object
22 | print(TransactResponseSchema.to_json())
23 |
24 | # convert the object into a dict
25 | transact_response_schema_dict = transact_response_schema_instance.to_dict()
26 | # create an instance of TransactResponseSchema from a dict
27 | transact_response_schema_from_dict = TransactResponseSchema.from_dict(transact_response_schema_dict)
28 | ```
29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/python/docs/UnSuspendResponseSchema.md:
--------------------------------------------------------------------------------
1 | # UnSuspendResponseSchema
2 |
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **response_host** | **str** | The host that originated the request. Future calls in the same conversation may be routed to this host. | [optional]
9 | **response_id** | **str** | Unique identifier for the response. | [optional]
10 | **tokens** | [**List[TokenForLCM]**](TokenForLCM.md) | | [optional]
11 |
12 | ## Example
13 |
14 | ```python
15 | from openapi_client.models.un_suspend_response_schema import UnSuspendResponseSchema
16 |
17 | # TODO update the JSON string below
18 | json = "{}"
19 | # create an instance of UnSuspendResponseSchema from a JSON string
20 | un_suspend_response_schema_instance = UnSuspendResponseSchema.from_json(json)
21 | # print the JSON string representation of the object
22 | print(UnSuspendResponseSchema.to_json())
23 |
24 | # convert the object into a dict
25 | un_suspend_response_schema_dict = un_suspend_response_schema_instance.to_dict()
26 | # create an instance of UnSuspendResponseSchema from a dict
27 | un_suspend_response_schema_from_dict = UnSuspendResponseSchema.from_dict(un_suspend_response_schema_dict)
28 | ```
29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/python/generate-api-client.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | mv test-requirements.txt test-requirements.txt.bak
4 |
5 | # We assume OpenAPI Generator is installed using `npm i -g @openapitools/openapi-generator-cli`
6 | # Current openapi generator version used is 5.2.1
7 | openapi-generator generate -i MDES_Digital_Enablement.yaml -g python -o .
8 |
9 | # Remove some generated files we don't use in this tutorial
10 | rm .gitlab-ci.yml
11 | rm git_push.sh
12 | rm .openapi-generator-ignore
13 | rm .travis.yml
14 |
15 | shopt -s extglob
16 | cd test
17 | rm -fv !(test_tokenize_api.py|__init__.py)
18 | cd ..
19 |
20 | mv test-requirements.txt.bak test-requirements.txt
21 |
--------------------------------------------------------------------------------
/python/openapi_client/api/__init__.py:
--------------------------------------------------------------------------------
1 | # flake8: noqa
2 |
3 | # import apis into api package
4 | from openapi_client.api.delete_api import DeleteApi
5 | from openapi_client.api.get_asset_api import GetAssetApi
6 | from openapi_client.api.get_task_status_api import GetTaskStatusApi
7 | from openapi_client.api.get_token_api import GetTokenApi
8 | from openapi_client.api.search_tokens_api import SearchTokensApi
9 | from openapi_client.api.suspend_api import SuspendApi
10 | from openapi_client.api.tokenize_api import TokenizeApi
11 | from openapi_client.api.transact_api import TransactApi
12 | from openapi_client.api.unsuspend_api import UnsuspendApi
13 | from openapi_client.api.notify_token_updated_api import NotifyTokenUpdatedApi
14 |
15 |
--------------------------------------------------------------------------------
/python/openapi_client/apis/__init__.py:
--------------------------------------------------------------------------------
1 |
2 | # flake8: noqa
3 |
4 | # Import all APIs into this package.
5 | # If you have many APIs here with many many models used in each API this may
6 | # raise a `RecursionError`.
7 | # In order to avoid this, import only the API that you directly need like:
8 | #
9 | # from .api.delete_api import DeleteApi
10 | #
11 | # or import this package, but before doing it, use:
12 | #
13 | # import sys
14 | # sys.setrecursionlimit(n)
15 |
16 | # Import APIs into API package:
17 | from openapi_client.api.delete_api import DeleteApi
18 | from openapi_client.api.get_asset_api import GetAssetApi
19 | from openapi_client.api.get_task_status_api import GetTaskStatusApi
20 | from openapi_client.api.get_token_api import GetTokenApi
21 | from openapi_client.api.search_tokens_api import SearchTokensApi
22 | from openapi_client.api.suspend_api import SuspendApi
23 | from openapi_client.api.tokenize_api import TokenizeApi
24 | from openapi_client.api.transact_api import TransactApi
25 | from openapi_client.api.unsuspend_api import UnsuspendApi
26 | from openapi_client.api.notify_token_updated_api import NotifyTokenUpdatedApi
27 |
--------------------------------------------------------------------------------
/python/openapi_client/model/__init__.py:
--------------------------------------------------------------------------------
1 | # we can not import model classes here because that would create a circular
2 | # reference which would not work in python2
3 | # do not import all models into this module because that uses a lot of memory and stack frames
4 | # if you need the ability to import all models from one package, import them with
5 | # from {{packageName}.models import ModelA, ModelB
6 |
--------------------------------------------------------------------------------
/python/requirements.txt:
--------------------------------------------------------------------------------
1 | python_dateutil >= 2.5.3
2 | setuptools >= 21.0.0
3 | urllib3 >= 1.25.3, < 2.1.0
4 | pydantic >= 2
5 | typing-extensions >= 4.7.1
6 |
--------------------------------------------------------------------------------
/python/setup.cfg:
--------------------------------------------------------------------------------
1 | [flake8]
2 | max-line-length=99
3 |
--------------------------------------------------------------------------------
/python/test-requirements.txt:
--------------------------------------------------------------------------------
1 | pytest~=4.6.7 # needed for python 2.7+3.4
2 | pytest-cov>=2.8.1
3 | pytest-randomly==1.2.3 # needed for python 2.7+3.4
4 | mastercard-oauth1-signer >= 1.4.0
5 | mastercard-client-encryption >= 1.1.2
6 |
--------------------------------------------------------------------------------
/python/test/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Mastercard/mastercard-api-client-tutorial/5f884c764152164271d4ce8efdaf89060e2975b7/python/test/__init__.py
--------------------------------------------------------------------------------
/python/test/resources/fle_config.json:
--------------------------------------------------------------------------------
1 | {
2 | "paths": {
3 | "$": {
4 | "toEncrypt": {
5 | "cardInfo.encryptedData": "cardInfo",
6 | "encryptedPayload.encryptedData": "encryptedPayload",
7 | "fundingAccountInfo.encryptedPayload.encryptedData": "fundingAccountInfo.encryptedPayload"
8 | },
9 | "toDecrypt": {
10 | "tokenDetail": "tokenDetail.encryptedData",
11 | "encryptedPayload": "encryptedPayload.encryptedData"
12 | }
13 | }
14 | },
15 | "ivFieldName": "iv",
16 | "encryptedKeyFieldName": "encryptedKey",
17 | "encryptedValueFieldName": "encryptedData",
18 | "dataEncoding": "hex",
19 | "encryptionCertificate": "",
20 | "decryptionKey": "",
21 | "oaepPaddingDigestAlgorithm": "SHA-256",
22 | "encryptionCertificateFingerprintFieldName": "publicKeyFingerprint",
23 | "oaepPaddingDigestAlgorithmFieldName": "oaepHashingAlgorithm"
24 | }
25 |
--------------------------------------------------------------------------------
/python/tox.ini:
--------------------------------------------------------------------------------
1 | [tox]
2 | envlist = py3
3 |
4 | [testenv]
5 | deps=-r{toxinidir}/requirements.txt
6 | -r{toxinidir}/test-requirements.txt
7 |
8 | commands=
9 | pytest --cov=openapi_client
10 |
--------------------------------------------------------------------------------