Service Configurations for Client Encryption Ruby

Table of Contents

• Overview
• Configurations
  • MDES Token Connect
  • MDES Digital Enablement API
  • Installment APIs
  • Payment Account Management
  • Payment Account Reference Inquiry
  • Mastercard QR for Merchant Aggregators
  • Mastercard Directory Services
  • Buyer Payment Agent
  • Supplier Payment Agent

Overview

Predefined service configurations for the Ruby client encryption library.

Configurations

MDES Token Connect

{
  paths: [
    {
      path: "/pushAccount",
      toEncrypt: [
        {
          element: "pushFundingAccount.encryptedPayload.encryptedData",
          obj: "pushFundingAccount.encryptedPayload"
        }],
      toDecrypt: []
    }
  ],    
  oaepPaddingDigestAlgorithm: 'SHA-512',
  ivFieldName: 'iv',
  encryptedKeyFieldName: 'encryptedKey',
  encryptedValueFieldName: 'encryptedData',
  oaepHashingAlgorithmFieldName: 'oaepHashingAlgorithm',
  publicKeyFingerprintFieldName: 'publicKeyFingerprint',
  publicKeyFingerprintType: "certificate",    
  dataEncoding: 'hex',    
  encryptionCertificate: "./path/to/your/encryption.crt"
}

MDES Digital Enablement API

{
  paths: [
    {
      path: "/tokenize",
      toEncrypt: [
        {
          element: "cardInfo.encryptedData",
          obj: "cardInfo"
        },
        {
          element: "fundingAccountInfo.encryptedPayload.encryptedData",
          obj: "fundingAccountInfo.encryptedPayload"
        }],
      toDecrypt: [
        {
          element: "tokenDetail",
          obj: "tokenDetail.encryptedData"
        }
      ]
    },
    {
      path: "/searchTokens",
      toEncrypt: [
        {
          element: "cardInfo.encryptedData",
          obj: "cardInfo"
        },
        {
          element: "fundingAccountInfo.encryptedPayload.encryptedData",
          obj: "fundingAccountInfo.encryptedPayload"
        }],
      toDecrypt: []
    },
    {
      path: "/getToken",
      toEncrypt: [],
      toDecrypt: [
        {
          element: "tokenDetail",
          obj: "tokenDetail.encryptedData"
        }]
    },
    {
      path: "/transact",
      toEncrypt: [],
      toDecrypt: [
        {
          element: "encryptedPayload",
          obj: "encryptedPayload.encryptedData"
        }]
    },
    {
      path: "/notifyTokenUpdated",
      toEncrypt: [
        {
          element: "encryptedPayload.encryptedData",
          obj: "encryptedPayload"
        }],
      toDecrypt: []
    }
  ],
  oaepPaddingDigestAlgorithm: 'SHA-512',
  ivFieldName: 'iv',
  encryptedKeyFieldName: 'encryptedKey',
  encryptedValueFieldName: 'encryptedData',
  oaepHashingAlgorithmFieldName: 'oaepHashingAlgorithm',
  publicKeyFingerprintFieldName: 'publicKeyFingerprint',
  publicKeyFingerprintType: "certificate",
  dataEncoding: 'hex',
  encryptionCertificate: "./path/to/your/encryption.crt",
  privateKey: "./path/to/your/private.key"
}

Installment APIs

{
  paths: [
    {
      path: "/installmentConfigData",
      toEncrypt: [
        {
          element: "configReqData.primaryAccountNumber",
          obj: "configReqData"
        }],
      toDecrypt: []
    },
    {
      path: "/receiveApproval",
      toEncrypt: [
        {
          element: "receiveIssuerApprReqData.primaryAccountNumber",
          obj: "receiveIssuerApprReqData"
        }],
      toDecrypt: []
    }
  ],
  oaepPaddingDigestAlgorithm: 'SHA-256',
  ivFieldName: 'iv',
  encryptedKeyFieldName: 'wrappedKey',
  encryptedValueFieldName: 'primaryAccountNumber',
  dataEncoding: 'base64',
  encryptionCertificate: "./path/to/your/encryption.crt"
}

Payment Account Management

{
  paths: [
    {
      path: "/addAccount",
      toEncrypt: [
        {
          element: "encryptedPayload.encryptedData",
          obj: "encryptedPayload"
        }
      ],
      toDecrypt: []
    },
    {
      path: "/closeAccount",
      toEncrypt: [
        {
          element: "encryptedPayload.encryptedData",
          obj: "encryptedPayload"
        }
      ],
      toDecrypt: []
    },
    {
      path: "/getPaymentAccountReference",
      toEncrypt: [
        {
          element: "encryptedPayload.encryptedData",
          obj: "encryptedPayload"
        }
      ],
      toDecrypt: [
        {
          element: "encryptedPayload",
          obj: "encryptedPayload.encryptedData"
        }
      ]
    },
    {
      path: "/updateAccount",
      toEncrypt: [
        {
          element: "encryptedPayload.encryptedData",
          obj: "encryptedPayload"
        }
      ],
      toDecrypt: []
    },
    {
      path: "/overrideForDeleteAccount",
      toEncrypt: [
        {
          element: "encryptedPayload.encryptedData",
          obj: "encryptedPayload"
        }
      ],
      toDecrypt: []
    }
  ],
  oaepPaddingDigestAlgorithm: 'SHA-512',
  ivFieldName: 'iv',
  encryptedKeyFieldName: 'encryptedKey',
  encryptedValueFieldName: 'encryptedData',
  oaepHashingAlgorithmFieldName: 'oaepHashingAlgorithm',
  publicKeyFingerprintFieldName: 'publicKeyFingerprint',
  publicKeyFingerprintType: "publicKey",
  dataEncoding: 'hex',
  encryptionCertificate: "./path/to/your/encryption.crt",
  privateKey: "./path/to/private.key"
}

Payment Account Reference Inquiry

{
  paths: [
    {
      path: "/getPaymentAccountReference",
      toEncrypt: [
        {
          element: "encryptedPayload.encryptedData",
          obj: "encryptedPayload"
        }],
      toDecrypt: [
        {
          element: "encryptedPayload",
          obj: "encryptedPayload.encryptedData"
        }
      ]
    }
  ],
  oaepPaddingDigestAlgorithm: 'SHA-512',
  ivFieldName: 'iv',
  encryptedKeyFieldName: 'encryptedKey',
  encryptedValueFieldName: 'encryptedData',
  oaepHashingAlgorithmFieldName: 'oaepHashingAlgorithm',
  publicKeyFingerprintFieldName: 'publicKeyFingerprint',
  publicKeyFingerprintType: "certificate",
  dataEncoding: 'hex',
  encryptionCertificate: "./path/to/your/encryption.crt",
  privateKey: "./path/to/private.key"
}

Mastercard QR for Merchant Aggregators

{
  paths: [
    {
      path: "/transactions",
      toEncrypt: [],
      toDecrypt: [
        {
          element: "",
          obj: "items"
        }
      ]
    },
    {
      path: "/serviceProvider",
      toEncrypt: [],
      toDecrypt: [
        {
          element: "",
          obj: "items"
        }
      ]
    }
  ],
  oaepPaddingDigestAlgorithm: 'SHA-512',
  ivFieldName: 'iv',
  encryptedKeyFieldName: 'encryptedKey',
  encryptedValueFieldName: 'items',
  oaepHashingAlgorithmFieldName: 'oaepHashingAlgorithm',
  publicKeyFingerprintFieldName: 'publicKeyFingerprint',
  publicKeyFingerprintType: "certificate",
  dataEncoding: 'base64',
  encryptionCertificate: "./path/to/your/encryption.crt",
  privateKey: "./path/to/private.key"
}

Mastercard Directory Services

{
  paths: [
    {
      path: "/mappings/*",
      toEncrypt: [
        {
          element: "",
          obj: "encrypted_payload"
        }],
      toDecrypt: [
        {
          element: "encrypted_payload",
          obj: ""
        }
      ]
    }
  ],
  oaepPaddingDigestAlgorithm: 'SHA-256',
  ivHeaderName: 'x-iv',
  encryptedKeyHeaderName: 'x-encrypted-key',
  oaepHashingAlgorithmHeaderName: 'x-oaep-hashing-algorithm',
  publicKeyFingerprintHeaderName: 'x-public-key-fingerprint',
  encryptedValueFieldName: 'data',
  dataEncoding: 'base64',
  publicKeyFingerprintType: "publicKey",
  encryptionCertificate: "./path/to/your/encryption.crt.pem",
  keyStore: "./path/to/your/keystore.p12",
  keyStoreAlias: "<yourkeyalias>",
  keyStorePassword: "<yourkeypassword>"
}

Buyer Payment Agent

{
  paths: [
    {
      path: '/buyer-agents/*',
      toEncrypt: [{
        element: "card",
        obj: "encryptedCard"
      }],
      toDecrypt: [{
        element: "encryptedCard",
        obj: "card"
      }]
    }
  ],
  oaepPaddingDigestAlgorithm: 'SHA-256',
  oaepHashingAlgorithmFieldName: 'oaepPaddingDigestAlgorithm',
  ivFieldName: 'iv',
  encryptedKeyFieldName: 'encryptedKey',
  encryptedValueFieldName: 'encryptedValue',
  dataEncoding: 'base64',
  encryptionCertificate: './path/to/your/encryption.crt',
  publicKeyFingerprintFieldName: 'publicKeyFingerprint',
  publicKeyFingerprintType: 'publicKey',
  privateKey: './path/to/private.key'
}

Supplier Payment Agent

{
  paths: [
    {
      path: '/supplier-agents/*',
      toEncrypt: [],
      toDecrypt: [{
        element: "encryptedCard",
        obj: "card"
      }]
    }
  ],
  oaepPaddingDigestAlgorithm: 'SHA-256',
  oaepHashingAlgorithmFieldName: 'oaepPaddingDigestAlgorithm',
  ivFieldName: 'iv',
  encryptedKeyFieldName: 'encryptedKey',
  encryptedValueFieldName: 'encryptedValue',
  dataEncoding: 'base64',
  publicKeyFingerprintFieldName: 'publicKeyFingerprint',
  publicKeyFingerprintType: 'publicKey',
  privateKey: './path/to/private.key'
}