cloudcommerce 0.2.1 → 0.2.3

package/packages/apps/paghiper/lib/paghiper-list-payments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paghiper-list-payments.js","sourceRoot":"","sources":["../src/paghiper-list-payments.ts"],"names":[],"mappings":"AAMA,kDAAkD;AAElD,MAAM,aAAa,GAAG,CAAC,MAAqB,EAAE,KAAa,EAAE,OAAe,EAAE,EAAE;IAC9E,OAAO;QACL,MAAM,EAAE,MAAM,IAAI,GAAG;QACrB,KAAK;QACL,OAAO;KACR,CAAC;AACJ,CAAC,CAAC;AAKF,eAAe,KAAK,EAAE,IAAmB,EAAE,EAAE;IAC3C,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,MAA4B,CAAC;IACjD,4EAA4E;IAC5E,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;IAC1E,2CAA2C;IAE3C,MAAM,SAAS,GAAG;QAChB,GAAG,WAAW,CAAC,IAAI;QACnB,GAAG,WAAW,CAAC,WAAW;KACZ,CAAC;IAEjB,uCAAuC;IACvC,MAAM,QAAQ,GAAyB;QACrC,gBAAgB,EAAE,EAAE;KACrB,CAAC;IAEF,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE;QAC/B,kDAAkD;QAClD,OAAO,aAAa,CAClB,GAAG,EACH,mBAAmB,EACnB,gFAAgF,CACjF,CAAC;KACH;IAED,MAAM,aAAa,GAAG;QACpB,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,2BAA2B;QACjC,IAAI,EAAE,UAAU;KACjB,CAAC;IAEF,MAAM,kBAAkB,GAAG,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;IAEjE,kBAAkB,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;QAC3C,MAAM,KAAK,GAAG,aAAa,KAAK,iBAAiB,CAAC;QAClD,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACxD,MAAM,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;QAEvD,MAAM,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,EAAE,cAAc,CAAC;QAErF,0BAA0B;QAC1B,MAAM,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAEzE,IAAI,YAAY,IAAI,cAAc,EAAE;YAClC,IAAI,KAAK,GAAG,YAAY,EAAE,KAAK,CAAC;YAChC,IAAI,CAAC,KAAK,EAAE;gBACV,IAAI,KAAK,EAAE;oBACT,KAAK,GAAG,eAAe,CAAC;iBACzB;qBAAM;oBACL,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,gBAAgB,CAAC;iBAC1F;aACF;YAED,MAAM,OAAO,GAAY;gBACvB,KAAK;gBACL,IAAI,EAAE,YAAY,EAAE,IAAI;gBACxB,IAAI,EAAE,YAAY,EAAE,IAAI;gBACxB,cAAc,EAAE;oBACd,IAAI,EAAE,aAAkC;oBACxC,IAAI,EAAE,GAAG,KAAK,MAAM,aAAa,CAAC,IAAI,EAAE;iBACzC;gBACD,aAAa;aACd,CAAC;YAEF,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,KAAK,EAAE;gBAC1B,OAAO,CAAC,IAAI,GAAG,6DAA6D,CAAC;aAC9E;YAED,MAAM,QAAQ,GAAG,YAAY,EAAE,QAAQ,CAAC;YACxC,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;YAE5B,IAAI,QAAQ,EAAE;gBACZ,IAAI,QAAQ,CAAC,KAAK,GAAG,CAAC,EAAE;oBACtB,IAAI,MAAM,CAAC,QAAQ,IAAI,CAAC,SAAS,CAAC,mBAAmB,KAAK,KAAK,CAAC,EAAE;wBAChE,kCAAkC;wBAClC,OAAO,OAAO,CAAC,QAAQ,CAAC;wBACxB,OAAO;qBACR;oBAED,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE;wBACnC,QAAQ,CAAC,eAAe,GAAG;4BACzB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;4BAC3B,IAAI,EAAE,QAAQ,CAAC,IAAI;4BACnB,KAAK,EAAE,QAAQ,CAAC,KAAK;4BACrB,KAAK,EAAE,GAAG,KAAK,EAAE;yBAClB,CAAC;qBACH;oBAED,IAAI,QAAQ,CAAC,UAAU,EAAE;wBACvB,uCAAuC;wBACvC,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,GAAG,QAAQ,CAAC,UAAU,EAAE;4BACtD,OAAO,OAAO,CAAC,QAAQ,CAAC;yBACzB;6BAAM;4BACL,OAAO,QAAQ,CAAC,UAAU,CAAC;yBAC5B;qBACF;iBACF;qBAAM,IAAI,OAAO,QAAQ,CAAC,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;oBAC7E,OAAO,OAAO,CAAC,QAAQ,CAAC;iBACzB;aACF;YAED,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACzC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC"}

package/packages/apps/paghiper/lib/paghiper-webhook.d.ts

@@ -0,0 +1,5 @@
+import '@cloudcommerce/firebase/lib/init';
+import * as functions from 'firebase-functions/v1';
+export declare const paghiper: {
+    webhook: functions.HttpsFunction;
+};

package/packages/apps/paghiper/lib/paghiper-webhook.js

@@ -0,0 +1,18 @@
+/* eslint-disable import/prefer-default-export */
+import '@cloudcommerce/firebase/lib/init';
+import * as functions from 'firebase-functions/v1';
+import config from '@cloudcommerce/firebase/lib/config';
+import handleWebhook from './functions-lib/handle-webhook.js';
+
+export const paghiper = {
+  webhook: functions
+    .region(config.get().httpsFunctionOptions.region)
+    .https.onRequest((req, res) => {
+      if (req.method !== 'POST') {
+        res.sendStatus(405);
+      } else {
+        handleWebhook(req, res);
+      }
+    }),
+};
+// # sourceMappingURL=paghiper-webhook.js.map

package/packages/apps/paghiper/lib/paghiper-webhook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paghiper-webhook.js","sourceRoot":"","sources":["../src/paghiper-webhook.ts"],"names":[],"mappings":"AAAA,iDAAiD;AACjD,OAAO,kCAAkC,CAAC;AAC1C,OAAO,KAAK,SAAS,MAAM,uBAAuB,CAAC;AACnD,OAAO,MAAM,MAAM,oCAAoC,CAAC;AACxD,OAAO,aAAa,MAAM,gCAAgC,CAAC;AAE3D,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,OAAO,EAAE,SAAS;SACf,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,oBAAoB,CAAC,MAAM,CAAC;SAChD,KAAK,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAC5B,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,EAAE;YACzB,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SACrB;aAAM;YACL,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;SACzB;IACH,CAAC,CAAC;CACL,CAAC"}

package/packages/apps/paghiper/lib/paghiper.d.ts

@@ -0,0 +1,76 @@
+import type { AppModuleBody } from '@cloudcommerce/types';
+import '@cloudcommerce/firebase/lib/init';
+export declare const listPayments: (modBody: AppModuleBody) => Promise<import("@cloudcommerce/types").ListPaymentsResponse | {
+    status: number;
+    error: string;
+    message: string;
+}>;
+export declare const createTransaction: (modBody: AppModuleBody) => Promise<{
+    status: number;
+    error: string;
+    message: string;
+} | {
+    redirect_to_payment: boolean;
+    transaction: {
+        payment_link?: string | undefined;
+        payment_instructions?: string | undefined;
+        intermediator?: {
+            transaction_id?: string | undefined;
+            transaction_code?: string | undefined;
+            transaction_reference?: string | undefined;
+            payment_method?: {
+                code: string;
+                name?: string | undefined;
+            } | undefined;
+            buyer_id?: string | undefined;
+        } | undefined;
+        credit_card?: {
+            holder_name?: string | undefined;
+            avs_result_code?: string | null | undefined;
+            cvv_result_code?: string | null | undefined;
+            bin?: number | undefined;
+            company?: string | undefined;
+            last_digits?: string | undefined;
+            token?: string | undefined;
+            error_code?: "incorrect_number" | "invalid_number" | "invalid_expiry_date" | "invalid_cvc" | "expired_card" | "incorrect_cvc" | "incorrect_zip" | "incorrect_address" | "card_declined" | "processing_error" | "call_issuer" | "pick_up_card" | undefined;
+        } | undefined;
+        banking_billet?: {
+            code?: string | undefined;
+            valid_thru?: string | undefined;
+            text_lines?: string[] | undefined;
+            link?: string | undefined;
+        } | undefined;
+        loyalty_points?: {
+            name?: string | undefined;
+            program_id: string;
+            points_value: number;
+            ratio?: number | undefined;
+        } | undefined;
+        currency_id?: string | undefined;
+        currency_symbol?: string | undefined;
+        discount?: number | undefined;
+        amount: number;
+        installments?: {
+            number: number;
+            value?: number | undefined;
+            tax?: boolean | undefined;
+            total?: number | undefined;
+        } | undefined;
+        creditor_fees?: {
+            installment?: number | undefined;
+            operational?: number | undefined;
+            intermediation?: number | undefined;
+            other?: number | undefined;
+        } | undefined;
+        status?: {
+            updated_at?: string | undefined;
+            current: "paid" | "pending" | "refunded" | "voided" | "under_analysis" | "authorized" | "unauthorized" | "in_dispute" | "unknown";
+        } | undefined;
+        flags?: string[] | undefined;
+        custom_fields?: {
+            field: string;
+            value: string;
+        }[] | undefined;
+        notes?: string | undefined;
+    };
+}>;

package/packages/apps/paghiper/lib/paghiper.js

@@ -0,0 +1,12 @@
+import '@cloudcommerce/firebase/lib/init';
+import handleListPayments from './paghiper-list-payments.js';
+import handleCreateTransaction from './paghiper-create-transaction.js';
+
+export const listPayments = async (modBody) => {
+  return handleListPayments(modBody);
+};
+
+export const createTransaction = async (modBody) => {
+  return handleCreateTransaction(modBody);
+};
+// # sourceMappingURL=paghiper.js.map

package/packages/apps/paghiper/lib/paghiper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paghiper.js","sourceRoot":"","sources":["../src/paghiper.ts"],"names":[],"mappings":"AACA,OAAO,kCAAkC,CAAC;AAC1C,OAAO,kBAAkB,MAAM,0BAA0B,CAAC;AAC1D,OAAO,uBAAuB,MAAM,+BAA+B,CAAC;AAEpE,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAAE,OAAsB,EAAE,EAAE;IAC3D,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,EAAE,OAAsB,EAAE,EAAE;IAChE,OAAO,uBAAuB,CAAC,OAAO,CAAC,CAAC;AAC1C,CAAC,CAAC"}

package/packages/apps/paghiper/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@cloudcommerce/app-paghiper",
+  "type": "module",
+  "version": "0.2.3",
+  "description": "E-Com Plus Cloud Commerce app to integrate PagHiper",
+  "main": "lib/paghiper.js",
+  "exports": {
+    ".": "./lib/paghiper.js",
+    "./webhook": "./lib/paghiper-webhook.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ecomplus/cloud-commerce.git",
+    "directory": "packages/apps/paghiper"
+  },
+  "author": "E-Com Club Softwares para E-commerce <ti@e-com.club>",
+  "license": "Apache 2.0 with Commons Clause",
+  "bugs": {
+    "url": "https://github.com/ecomplus/cloud-commerce/issues"
+  },
+  "homepage": "https://github.com/ecomplus/cloud-commerce/tree/main/packages/apps/paghiper#readme",
+  "scripts": {
+    "build": "sh ../../../scripts/build-lib.sh"
+  },
+  "dependencies": {
+    "@cloudcommerce/api": "workspace:*",
+    "@cloudcommerce/firebase": "workspace:*",
+    "axios": "^1.2.2",
+    "firebase-admin": "^11.4.1",
+    "firebase-functions": "^4.2.0"
+  },
+  "devDependencies": {
+    "@cloudcommerce/types": "workspace:*",
+    "@firebase/app-types": "^0.9.0"
+  }
+}

package/packages/apps/paghiper/src/functions-lib/create-axios.ts

@@ -0,0 +1,21 @@
+// Axios HTTP client
+import axios from 'axios';
+
+// returns a reusable axios instance for PagHiper API
+export default (isPix?: boolean) => axios.create({
+  // https://github.com/axios/axios#creating-an-instance
+  baseURL: isPix ? 'https://pix.paghiper.com/'
+    : 'https://api.paghiper.com/',
+  headers: {
+    'Content-Type': 'application/json;charset=UTF-8',
+    Accept: 'application/json',
+    'Accept-Charset': 'UTF-8',
+    'Accept-Encoding': 'application/json',
+  },
+  // wait up to 30s
+  timeout: 30000,
+  validateStatus(status) {
+    // success only when received 201
+    return status === 201;
+  },
+});

package/packages/apps/paghiper/src/functions-lib/handle-webhook.ts

@@ -0,0 +1,176 @@
+import type { Orders } from '@cloudcommerce/types';
+import type { Request, Response } from 'firebase-functions';
+import api from '@cloudcommerce/api';
+import logger from 'firebase-functions/logger';
+import { Endpoint } from '@cloudcommerce/api/lib/types';
+import config from '@cloudcommerce/firebase/lib/config';
+import Axios from './create-axios';
+
+const { apps } = config.get();
+
+const CLIENT_ERR = 'invalidClient';
+
+const listOrdersByTransaction = async (transactionCode: string) => {
+  let filters = `?transactions.intermediator.transaction_id=${transactionCode}`;
+  filters += '&fields=_id,transactions._id,';
+  filters += 'transactions.app,transactions.intermediator,transactions.status';
+
+  // send and return authenticated Store API request
+  const { result } = (await api.get(`/orders${filters}` as Endpoint)).data;
+  return result as Orders[];
+};
+
+const readNotification = async (readNotificationBody: { [x: string]: any }, isPix?: boolean) => {
+  // read full notification body from PagHiper API
+  // https://dev.paghiper.com/reference#qq
+  // returns request promise
+  const endpoint = `/${(isPix ? 'invoice' : 'transaction')}/notification/`;
+  const { data } = await Axios(isPix).post(endpoint, readNotificationBody);
+  return data;
+};
+
+export default async (req: Request, res: Response) => {
+  const { body } = req;
+  const isPix = Boolean(req.params.pix);
+  // handle PagHiper notification request
+  // https://dev.paghiper.com/reference#qq
+  const transactionCode = (body && body.transaction_id);
+  if (!transactionCode) {
+    return res.sendStatus(400);
+  }
+
+  logger.log(`> Paghiper notification for ${transactionCode}`);
+  // const docRef = (await collectionSubscription.doc(transactionCode).get()).data();
+  const Apps = (await api.get(
+    `applications?app_id=${apps.pagHiper.appId}&fields=hidden_data`,
+  )).data.result;
+  const configApp = Apps[0].hidden_data?.paghiper_api_key;
+  try {
+    if (configApp.paghiper_token && configApp.paghiper_api_key === body.apiKey) {
+      // list order IDs for respective transaction code
+      const orders = await listOrdersByTransaction(transactionCode);
+      const paghiperResponse = await readNotification(
+        { ...body, token: configApp.paghiper_token },
+        isPix,
+      );
+
+      const handleNotification = async (isRetry?: boolean) => {
+        let { status } = paghiperResponse.status_request;
+        logger.log(`PagHiper ${transactionCode} -> '${status}'`);
+        switch (status) {
+          case 'pending':
+          case 'paid':
+          case 'refunded':
+            // is the same
+            break;
+          case 'canceled':
+            status = 'voided';
+            break;
+          case 'processing':
+            status = 'under_analysis';
+            break;
+          case 'reserved':
+            // https://atendimento.paghiper.com/hc/pt-br/articles/360016177713
+            status = 'authorized';
+            break;
+          default:
+            // ignore unknow status
+            return true;
+        }
+
+        try {
+          // change transaction status on E-Com Plus API
+          const notificationCode = body.notification_id;
+          orders.forEach(async ({ _id, transactions }) => {
+            let transactionId: string | undefined;
+            if (transactions) {
+              transactions.forEach((transaction) => {
+                const { app, intermediator } = transaction;
+                if (intermediator && intermediator.transaction_id === String(transactionCode)) {
+                  if (transaction.status) {
+                    if (
+                      transaction.status.current === status
+                      || (status === 'pending' && transaction.status.current === 'paid')
+                    ) {
+                      // ignore old/duplicated notification
+                      return;
+                    }
+                  }
+                  if (app && app.intermediator && app.intermediator.code !== 'paghiper') {
+                    return;
+                  }
+                  transactionId = transaction._id;
+                }
+              });
+            }
+
+            let bodyPaymentHistory: { [x: string]: any };
+
+            if (typeof status === 'object' && status !== null) {
+              // request body object sent as 'status' function param
+              bodyPaymentHistory = status;
+            } else {
+              bodyPaymentHistory = {
+                date_time: new Date().toISOString(),
+                status,
+              };
+              if (notificationCode) {
+                bodyPaymentHistory.notification_code = notificationCode;
+              }
+              if (typeof transactionId === 'string' && /^[a-f0-9]{24}$/.test(transactionId)) {
+                bodyPaymentHistory.transaction_id = transactionId;
+              }
+            }
+            await api.post(`orders/${_id}/payments_history`, bodyPaymentHistory as any); // TODO: incompatible type
+          });
+
+          return res.status(204).send('SUCCESS');
+        } catch (err: any) {
+          //
+          const { message, response } = err;
+          let statusCode: number;
+          if (!err.request && err.name !== CLIENT_ERR && err.code !== 'EMPTY') {
+            // not Axios error ?
+            logger.error(err);
+            statusCode = 500;
+          } else {
+            const resStatus = response && response.status;
+            let debugMsg = `[#${transactionCode}] Unhandled notification: `;
+            if (err.config) {
+              debugMsg += `${err.config.url} `;
+            }
+            debugMsg += (resStatus || message);
+
+            if (!isRetry
+              && ((resStatus === 401 && response.data && response.data.error_code === 132)
+                || resStatus >= 500)
+            ) {
+              // delay and retry once
+              await new Promise((resolve) => {
+                setTimeout(() => {
+                  resolve(true);
+                }, 700);
+              });
+              return handleNotification(true);
+              // statusCode = 503;
+            }
+            logger.error(debugMsg);
+            statusCode = 409;
+          }
+          // return response with error
+          return res.status(statusCode)
+            .send({
+              error: 'paghiper_notification_error',
+              message,
+            });
+        }
+      };
+      await handleNotification();
+    }
+
+    return res.status(400).send('API key does not match');
+  } catch (err: any) {
+    logger.error(err);
+    return res.sendStatus(500);
+  }
+};

package/packages/apps/paghiper/src/index.ts

@@ -0,0 +1 @@
+export * from './paghiper';

package/packages/apps/paghiper/src/paghiper-create-transaction.ts

@@ -0,0 +1,242 @@
+import type {
+  AppModuleBody,
+  CreateTransactionParams,
+  CreateTransactionResponse,
+} from '@cloudcommerce/types';
+import type { PagHiperApp } from '../types/config-app';
+import logger from 'firebase-functions/logger';
+import config from '@cloudcommerce/firebase/lib/config';
+import axios from './functions-lib/create-axios';
+
+type ItemsPagHiper = {
+  description: string,
+  item_id: string,
+  quantity: number,
+  price_cents: number,
+}
+
+const responseError = (status: number | null, error: string, message: string) => {
+  return {
+    status: status || 409,
+    error,
+    message,
+  };
+};
+
+const createTransactionPagHiper = async (
+  body: { [x: string]: any },
+  isPix?: boolean,
+): Promise<any> => {
+  // create new transaction to PagHiper API
+  // https://dev.paghiper.com/reference#gerar-boleto
+  if (!isPix && process.env.PAGHIPER_PARTNER_ID) {
+    body.partners_id = process.env.PAGHIPER_PARTNER_ID;
+  } else if (isPix && process.env.PAGHIPER_PIX_PARTNER_ID) {
+    body.partners_id = process.env.PAGHIPER_PIX_PARTNER_ID;
+  }
+
+  // returns request promise
+  const endpoint = `/${(isPix ? 'invoice' : 'transaction')}/create/`;
+  return new Promise((resolve, reject) => {
+    axios(isPix).post(endpoint, body)
+      .then(({ data }) => {
+        // save transaction ID on database first
+        let createRequest: any;
+        if (isPix) {
+          createRequest = data.pix_create_request;
+        }
+        if (!createRequest) {
+          createRequest = data.create_request;
+        }
+
+        resolve(createRequest);
+      })
+      .catch(reject);
+  });
+};
+
+export default async (appData: AppModuleBody) => {
+  const locationId = config.get().httpsFunctionOptions.region;
+  const baseUri = `https://${locationId}-${process.env.GCLOUD_PROJECT}.cloudfunctions.net`;
+
+  const webhookUrl = `${baseUri}/paghiper-webhook`;
+
+  // treat module request body
+  const { application } = appData;
+  const params = appData.params as CreateTransactionParams;
+
+  // app configured options
+  const configApp = {
+    ...application.data,
+    ...application.hidden_data,
+  } as PagHiperApp;
+
+  const orderId = params.order_id;
+  const orderNumber = params.order_number;
+  const {
+    amount,
+    items,
+    buyer,
+    to,
+  } = params;
+
+  const billingAddress = params.billing_address;
+
+  logger.log(`> (App PagHiper): Create transaction for #${orderId}`);
+  let transaction: CreateTransactionResponse['transaction'] = {
+    amount: amount.total,
+  };
+
+  // params object follows create transaction request schema:
+  // https://apx-mods.e-com.plus/api/v1/create_transaction/schema.json?store_id=100
+  //   const orderId = params.order_id;
+  //   logger.log(`> Create transaction for #${storeId} ${orderId}`);
+  // setup transaction body to PagHiper reference
+
+  // https://dev.paghiper.com/reference#gerar-boleto
+  const address = billingAddress || to;
+
+  const paghiperTransaction: { [x: string]: any } = {
+    order_id: orderId || orderNumber || new Date().getTime().toString(),
+    payer_email: buyer.email,
+    payer_name: buyer.fullname,
+    payer_cpf_cnpj: buyer.doc_number,
+    payer_phone: buyer.phone.number,
+    payer_street: address?.street || '',
+    payer_number: address?.number || '',
+    payer_complement: address?.complement || '',
+    payer_district: address?.borough || '',
+    payer_city: address?.city || '',
+    payer_state: address?.province_code || '',
+    payer_zip_code: address?.zip ? address.zip.replace(/\D/g, '') : '',
+    notification_url: webhookUrl,
+    discount_cents: amount.discount ? Math.round(amount.discount * 100) : '',
+    shipping_price_cents: amount.freight ? Math.round(amount.freight * 100) : '',
+    fixed_description: true,
+    type_bank_slip: 'boletoA4',
+    days_due_date: 5,
+    per_day_interest: true,
+    items: [] as ItemsPagHiper[],
+  };
+
+  // parse transaction items list
+  items.forEach((item) => {
+    paghiperTransaction.items.push({
+      description: item.name || item.product_id,
+      item_id: item.sku || item.product_id,
+      quantity: item.quantity,
+      price_cents: Math.round((item.final_price || item.price) * 100),
+    });
+  });
+
+  const isPix = params.payment_method.code === 'account_deposit';
+  if (isPix) {
+    paghiperTransaction.notification_url += '/pix';
+  }
+
+  // use configured PagHiper API key
+  paghiperTransaction.apiKey = configApp.paghiper_api_key;
+  // merge configured banking billet options
+  const options = configApp.banking_billet_options;
+  if (typeof options === 'object' && options !== null) {
+    // options must have only valid properties for PagHiper transaction object
+    Object.keys(options).forEach((prop) => {
+      if (options[prop]) {
+        paghiperTransaction[prop] = options[prop];
+      }
+    });
+  }
+
+  try {
+    // send request to PagHiper API
+    const createRequest = await createTransactionPagHiper(paghiperTransaction, isPix);
+
+    // transaction created successfully
+    // https://dev.paghiper.com/reference#exemplos
+    // mount response body
+    // https://apx-mods.e-com.plus/api/v1/create_transaction/response_schema.json?store_id=100
+    transaction = {
+      intermediator: {
+        transaction_id: createRequest.transaction_id,
+        transaction_code: createRequest.transaction_id,
+        transaction_reference: createRequest.order_id,
+      },
+      amount: createRequest.value_cents
+        ? parseInt(createRequest.value_cents, 10) / 100
+        // use amount from create transaction request body
+        : params.amount.total,
+    };
+
+    if (isPix) {
+      // https://dev.paghiper.com/reference#exemplos-pix
+      const pixCode = createRequest.pix_code;
+      if (transaction.intermediator) {
+        transaction.intermediator.transaction_code = pixCode.emv;
+      }
+      const pixCodeUrls = ['pix_url', 'qrcode_image_url', 'bacen_url'];
+      for (let i = 0; i < pixCodeUrls.length; i++) {
+        const pixUrl = pixCode[pixCodeUrls[i]];
+        if (pixUrl && pixUrl.startsWith('http')) {
+          transaction.payment_link = pixUrl;
+          break;
+        }
+      }
+      transaction.notes = `<img src="${pixCode.qrcode_image_url}" `
+        + 'style="display:block;max-width:100%;margin:0 auto" />';
+    } else {
+      const bankSlip = createRequest.bank_slip;
+      transaction.payment_link = bankSlip.url_slip;
+      transaction.banking_billet = {
+        code: bankSlip.digitable_line,
+        link: bankSlip.url_slip_pdf,
+      };
+      if (createRequest.due_date) {
+        transaction.banking_billet.valid_thru = new Date(createRequest.due_date).toISOString();
+      }
+    }
+
+    return {
+      redirect_to_payment: false,
+      transaction,
+    };
+  } catch (err: any) {
+    let { message } = err;
+    let statusCode: number | null;
+    if (!err.request) {
+      // not Axios error ?
+      logger.error('> (App PagHiper) =>', err);
+      statusCode = 500;
+    } else {
+      let debugMsg = 'Can\'t create transaction: ';
+      if (err.config) {
+        debugMsg += `${err.config.url} `;
+      }
+      if (err.response) {
+        debugMsg += err.response.status;
+
+        // https://dev.paghiper.com/reference#mensagens-de-retorno-2
+        if (err.response.status === 200) {
+          const { data } = err.response;
+          if (data) {
+            debugMsg += ` ${typeof data === 'object' ? JSON.stringify(data) : data}`;
+            debugMsg += ` ${JSON.stringify(paghiperTransaction)}`;
+            if (data.create_request && data.create_request.response_message) {
+              message = data.create_request.response_message;
+            }
+          }
+        }
+      } else {
+        debugMsg += message;
+      }
+      logger.error('> (App PagHiper) =>', debugMsg);
+      statusCode = 409;
+    }
+
+    // return error status code
+    return responseError(
+      statusCode,
+      'CREATE_TRANSACTION_ERR',
+      message,
+    );
+  }
+};