[Components] fiserv - new components

components/fiserv/actions/create-checkout/create-checkout.mjs

@@ -0,0 +1,126 @@
+import app from "../../fiserv.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "fiserv-create-checkout",
+  name: "Create Checkout",
+  description: "Initiate a payment request by passing all the required parameters. It creates a new payment transaction and returns the redirect URL that includes transaction ID. [See the documentation](https://docs.fiserv.dev/public/reference/postcheckouts).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    storeId: {
+      type: "string",
+      label: "Store ID",
+      description: "Store id to be used for processing this payment. It also acts as an identifier for your store to load the checkout pages linked to it. If no checkout pages are found, default payment page will be rendered for that transaction.",
+    },
+    merchantTransactionId: {
+      type: "string",
+      label: "Merchant Transaction ID",
+      description: "You can use this parameter to tag a unique identifier to this transaction for future reference.",
+      optional: true,
+    },
+    transactionOrigin: {
+      type: "string",
+      label: "Transaction Origin",
+      description: "This parameter is used to flag the transaction source correctly. The possible values are `ECOM` (if the order was recieved from online shop), `MAIL` & `PHONE`.",
+      options: [
+        "ECOM",
+        "MAIL",
+        "PHONE",
+      ],
+    },
+    transactionType: {
+      type: "string",
+      label: "Transaction Type",
+      description: "You can use this parameter to specify the type of transaction you want to perform. Allowed values are: `SALE`, `PRE-AUTH`, `ZERO-AUTH`",
+      options: [
+        "SALE",
+        "PRE-AUTH",
+        "ZERO-AUTH",
+      ],
+    },
+    transactionAmount: {
+      type: "object",
+      label: "Transaction Amount",
+      description: "Object contains `total` transaction amount, `currency`, tax and discount details. Example: `{\"total\":123,\"currency\":\"EUR\",\"components\":{\"subtotal\":115,\"vat\":3,\"shipping\":2.5}}`",
+      optional: true,
+    },
+    order: {
+      type: "string",
+      label: "Order",
+      description: "Object contains order related details. [See the documentation](https://docs.fiserv.dev/public/reference/postcheckouts).",
+      optional: true,
+    },
+    checkoutSettings: {
+      type: "string",
+      label: "Checkout Settings",
+      description: "Object contains checkout related settings. [See the documentation](https://docs.fiserv.dev/public/reference/postcheckouts).",
+      default: JSON.stringify({
+        locale: "en_US",
+      }),
+    },
+    paymentMethodDetails: {
+      type: "string",
+      label: "Payment Method Details",
+      description: "Object contains payment method related details. [See the documentation](https://docs.fiserv.dev/public/reference/postcheckouts).",
+      default: JSON.stringify({
+        cards: {
+          authenticationPreferences: {
+            challengeIndicator: "01",
+            skipTra: false,
+          },
+          createToken: {
+            declineDuplicateToken: false,
+            reusable: true,
+            toBeUsedFor: "UNSCHEDULED",
+          },
+          tokenBasedTransaction: {
+            transactionSequence: "FIRST",
+          },
+        },
+        sepaDirectDebit: {
+          transactionSequenceType: "SINGLE",
+        },
+      }),
+    },
+  },
+  methods: {
+    createCheckout(args = {}) {
+      return this.app.post({
+        path: "/checkouts",
+        ...args,
+      });
+    },
+  },
+  async run({ $ }) {
+    const {
+      createCheckout,
+      storeId,
+      merchantTransactionId,
+      transactionOrigin,
+      transactionType,
+      transactionAmount,
+      order,
+      checkoutSettings,
+      paymentMethodDetails,
+    } = this;
+
+    const response = await createCheckout({
+      $,
+      data: {
+        storeId,
+        merchantTransactionId,
+        transactionOrigin,
+        transactionType,
+        transactionAmount: utils.parseJson(transactionAmount),
+        order: utils.parseJson(order),
+        checkoutSettings: utils.parseJson(checkoutSettings),
+        paymentMethodDetails: utils.parseJson(paymentMethodDetails),
+      },
+    });
+
+    $.export("$summary", `Successfully created checkout. Redirect URL: ${response.redirectionUrl}`);
+    return response;
+  },
+};

components/fiserv/actions/retrieve-checkout-details/retrieve-checkout-details.mjs

@@ -0,0 +1,42 @@
+import app from "../../fiserv.app.mjs";
+
+export default {
+  key: "fiserv-retrieve-checkout-details",
+  name: "Retrieve Checkout Details",
+  description: "Retrieve details about a specific checkout using the identifier returned when it was created. [See the documentation](https://docs.fiserv.dev/public/reference/get-checkouts-id).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    checkoutId: {
+      type: "string",
+      label: "Checkout ID",
+      description: "The unique identifier for the checkout.",
+      optional: false,
+    },
+  },
+  methods: {
+    getCheckoutDetails({
+      checkoutId, ...args
+    } = {}) {
+      return this.app._makeRequest({
+        path: `/checkouts/${checkoutId}`,
+        ...args,
+      });
+    },
+  },
+  async run({ $ }) {
+    const {
+      getCheckoutDetails,
+      checkoutId,
+    } = this;
+
+    const response = await getCheckoutDetails({
+      $,
+      checkoutId,
+    });
+
+    $.export("$summary", `Successfully retrieved details for checkout ID ${this.checkoutId}`);
+    return response;
+  },
+};

components/fiserv/common/constants.mjs

@@ -0,0 +1,18 @@
+const ENVIRONMENT = {
+  SANDBOX: "sandbox",
+  PRODUCTION: "production",
+};
+
+const SANDBOX_PATH = "/sandbox";
+
+const API_PATH = {
+  DEFAULT: "/exp/v1",
+  PAYMENTS: "/ipp/payments-gateway/v2",
+  FRAUD: "/ipp/fraud/v1",
+};
+
+export default {
+  ENVIRONMENT,
+  SANDBOX_PATH,
+  API_PATH,
+};

components/fiserv/common/utils.mjs

@@ -0,0 +1,26 @@
+const parseJson = (input) => {
+  const parse = (value) => {
+    if (typeof(value) === "string") {
+      try {
+        return parseJson(JSON.parse(value));
+      } catch (e) {
+        return value;
+      }
+    } else if (typeof(value) === "object" && value !== null) {
+      return Object.entries(value)
+        .reduce((acc, [
+          key,
+          val,
+        ]) => Object.assign(acc, {
+          [key]: parse(val),
+        }), {});
+    }
+    return value;
+  };
+
+  return parse(input);
+};
+
+export default {
+  parseJson,
+};

components/fiserv/fiserv.app.mjs

@@ -1,11 +1,93 @@
+import { v4 as uuid } from "uuid";
+import crypto from "crypto";
+import { axios } from "@pipedream/platform";
+import constants from "./common/constants.mjs";
+
 export default {
   type: "app",
   app: "fiserv",
-  propDefinitions: {},
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    getAuth() {
+      const {
+        url,
+        api_key: apiKey,
+        secret_key: secretKey,
+        environment = constants.ENVIRONMENT.SANDBOX,
+      } = this.$auth;
+      return {
+        url,
+        apiKey,
+        secretKey,
+        environment,
+      };
+    },
+    getUrl(path, apiPath = constants.API_PATH.DEFAULT) {
+      const {
+        url,
+        environment,
+      } = this.getAuth();
+      const baseUrl = environment === constants.ENVIRONMENT.SANDBOX
+        ? `${url}${constants.SANDBOX_PATH}${apiPath}`
+        : `${url}${apiPath}`;
+      return `${baseUrl}${path}`;
+    },
+    /**
+     * Example at https://docs.fiserv.dev/public/docs/message-signature#example-of-code
+     */
+    getSignatureHeaders(data) {
+      const {
+        apiKey,
+        secretKey,
+        environment,
+      } = this.getAuth();
+
+      if (environment === constants.ENVIRONMENT.SANDBOX) {
+        return;
+      }
+
+      const clientRequestId = uuid();
+      const timestamp = Date.now().toString();
+      const requestBody = JSON.stringify(data) || "";
+      const rawSignature = apiKey + clientRequestId + timestamp + requestBody;
+
+      const computedHmac =
+        crypto.createHmac("sha256", secretKey)
+          .update(rawSignature)
+          .digest("base64");
+
+      return {
+        "Client-Request-Id": clientRequestId,
+        "Message-Signature": computedHmac,
+        "Timestamp": timestamp,
+      };
+    },
+    getHeaders(headers) {
+      return {
+        ...headers,
+        "Content-Type": "application/json",
+        "Accept": "application/json",
+        "API-Key": this.$auth.api_key,
+      };
+    },
+    _makeRequest({
+      $ = this, path, headers, data, apiPath, ...args
+    } = {}) {
+      return axios($, {
+        ...args,
+        debug: true,
+        url: this.getUrl(path, apiPath),
+        data,
+        headers: {
+          ...this.getHeaders(headers),
+          ...this.getSignatureHeaders(data),
+        },
+      });
+    },
+    post(args = {}) {
+      return this._makeRequest({
+        method: "POST",
+        ...args,
+      });
     },
   },
-};
+};

components/fiserv/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/fiserv",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Fiserv Components",
   "main": "fiserv.app.mjs",
   "keywords": [
@@ -11,5 +11,10 @@
   "author": "Pipedream <[email protected]> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "3.0.3",
+    "crypto": "^1.0.1",
+    "uuid": "^11.0.3"
   }
-}
+}