CDP: include vat and other amount details with payment intent and in post payment finalization #43

Author: alien45

src/cdp/handleCalcCDPPaymentAmount.js

@@ -0,0 +1,94 @@
+import { TYPES } from '../utils/validator'
+import { dbCompanies } from './couchdb'
+import { defs, messages } from './validation'
+
+export async function calcCDPPaymentAmount(company = {}) {
+    const {
+        countryCode = '',
+        regAddress: {
+            county,
+            country,
+        } = {}
+    } = company
+
+    let amount,
+        amountVAT,
+        currency,
+        amountTotal,
+        vatPercentage,
+        vatRegion
+    switch (`${countryCode || ''}`.toLowerCase()) {
+        case 'gb':
+            amount = 8250
+            currency = 'gbp'
+            vatPercentage = 20 // 20%
+            vatRegion = [countryCode] // for state/county based vat use [countryCode, state]
+            break
+        default:
+            throw new Error('Failed to set payment amount. Invalid or unsupported country!')
+    }
+
+    amountVAT = parseInt(amount * vatPercentage / 100)
+    amountTotal = parseInt(amount + amountVAT)
+
+    return {
+        amount,
+        amountVAT,
+        currency,
+        amountTotal,
+        vatPercentage, // 0 to 100
+        vatRegion,
+    }
+}
+
+export default async function handleCalcCDPPaymentAmount(companyId, callback) {
+    const company = await dbCompanies.get(companyId)
+    if (!company) return callback(messages.invalidCompany)
+
+    const result = await calcCDPPaymentAmount(company)
+    callback(null, result)
+}
+handleCalcCDPPaymentAmount.params = [
+    defs.companyId,
+    defs.callback,
+]
+handleCalcCDPPaymentAmount.result = {
+    properties: [
+        {
+            description: 'Amount before VAT in pennies/cents',
+            name: 'amount',
+            type: TYPES.integer,
+        },
+        {
+            description: 'Amount of VAT in pennies/cents',
+            name: 'amountVAT',
+            type: TYPES.integer,
+        },
+        {
+            description: 'Payment currency',
+            name: 'currency',
+            type: TYPES.string,
+        },
+        {
+            description: 'Amount after VAT in pennies/cents. The final/payment amount.',
+            name: 'amountTotal',
+            type: TYPES.integer,
+        },
+        {
+            description: 'VAT percentage.',
+            max: 100,
+            min: 0,
+            name: 'vatPercentage',
+            type: TYPES.integer,
+        },
+        {
+            description: 'The country/region VAT percentage is based on. If VAT is applied on the country-level, state/county will not be included. Eg: ["GB"], ["US", "New York"]',
+            maxLength: 2,
+            minLength: 1,
+            name: 'vatRegion',
+            type: TYPES.array,
+        },
+
+    ],
+    type: TYPES.object,
+}

src/cdp/handleFinalizePayment.js

@@ -69,6 +69,7 @@ export default async function handleFinalizePayment(
     companyId,
     callback
 ) {
+    console.log('finalize')
     const [paid, intentLog] = await stripeCheckPaid(intentId, companyId)
     if (!paid) return callback(texts.paymentIncomplete)
     const {
@@ -242,37 +243,18 @@ export default async function handleFinalizePayment(
         ubos,
         relatedCompanies,
         contactDetails,
-        // ToDo: validate
-        payment: objClean({
-            ...draft.payment?.values || {},
-            amount: intentLog.amount,
-            currency: intentLog.currency,
+        payment: {
+            amountDetails: intentLog?.amountDetails || {},
+            billingDetails: intentLog?.stipping,
             invoiceNumber: generateInvoiceNumber(
                 company.countryCode,
                 cdp,
                 cdpIssueCount
             ),
+            paymentId: intentLog._id,
+            paymentProvider: 'stripe',
             status: 'paid',
-            vat: 0 // in pennies
-        }, [
-            'amount',
-            'addressLine1',
-            'addressLine2',
-            'addressLine3',
-            'countryCode',
-            'county',
-            'currency',
-            'email',
-            'invoiceNumber',
-            'nameOnCard',
-            'paymentIntentId',
-            'postCode',
-            'postTown',
-            'standardCountry',
-            'status',
-            'town',
-            'vat',
-        ]),
+        }
     }
 
     try {

src/cdp/index.js

@@ -1,13 +1,14 @@
 import { setup as setupCouchDB } from './couchdb'
+import handleCalcCDPPaymentAmount from './handleCalcCDPPaymentAmount'
 import handleCalcValidityPeriod from './handleCalcValidityPeriod'
 import handleCheckCreate from './handleCheckCreate'
 import handleCompanySearch from './handleCompanySearch'
-import handleSetAccessCode from './handleSetAccessCode'
 import { handleDraft } from './handleDraft'
 import handleFinalizePayment from './handleFinalizePayment'
 import handleGetPublicKeys from './handleGetPublicKeys'
 import handleLogProgress from './handleLogProgress'
 import handleReport from './handleReport'
+import handleSetAccessCode from './handleSetAccessCode'
 import handleValidateAccessCode from './handleValidateAccessCode'
 import handleVerify from './handleVerify'
 import { setup as setupNacl } from './nacl'
@@ -27,6 +28,7 @@ export const setup = async (expressApp) => {
 }
 
 const handlers = {
+    'cdp-calc-cdp-payment-amount': handleCalcCDPPaymentAmount,
     'cdp-calc-validity-period': handleCalcValidityPeriod,
     'cdp-check-create': handleCheckCreate,
     'cdp-company-search': handleCompanySearch,

src/cdp/stripe/handleCheckPaid.js

@@ -21,13 +21,15 @@ export const checkPaid = async (intentId, companyId) => {
 
 	const intentLog = await dbCdpStripeIntents.get(intentId)
 	const {
-		amount,
+		amountDetails: {
+			amountTotal
+		} = {},
 		metadata: md2 = {},
 	} = intentLog || {}
 
 	if (!intentLog || md2?.companyId !== companyId) return [false]
 
-	const paymentValid = amount_received === amount
+	const paymentValid = amount_received === amountTotal
 		&& Object // check all metatadata matches
 			.keys(md2)
 			.every(key => md1[key] === md2[key])

src/cdp/stripe/handleCreateIntent.js

@@ -17,6 +17,8 @@ import { defs, messages } from '../validation'
 import verifyGeneratedData from '../verifyGeneratedData'
 import { accessCodeHashed } from '../utils'
 import getStripe from './getStripe'
+import { calcCDPPaymentAmount } from '../handleCalcCDPPaymentAmount'
+import { checkPaid } from './handleCheckPaid'
 
 export const AMOUNT_GBP_PENNIES = 9900 // 99 Pounds Sterling in Pennies
 const CURRENCY = 'gbp'
@@ -31,8 +33,8 @@ const stripeAddressDef = {
         },
         {
             description: 'Two-letter country code (ISO 3166-1 alpha-2). Mode details: https://stripe.com/docs/api/payment_methods/object#payment_method_object-billing_details-address-country',
-            maxLength: 2,
-            minLength: 2,
+            // maxLength: 2,
+            // minLength: 2,
             name: 'country',
             required: true,
             type: TYPES.string,
@@ -138,8 +140,11 @@ export default async function handleCreateIntent(
             .map(x => x.name),
     )
     generatedData.serverIdentity = getIdentity()
-    const amount = AMOUNT_GBP_PENNIES
-    const currency = CURRENCY
+    const amountDetails = await calcCDPPaymentAmount(company)
+    const {
+        amountTotal,
+        currency,
+    } = amountDetails
     // remove any unintentional/unwanted properties
     const address = objClean(
         billingDetails.address || {},
@@ -163,51 +168,52 @@ export default async function handleCreateIntent(
         name,
         email,
         phone,
+        JSON.stringify(amountDetails),
     ].join('__'))
+
     const metadata = {
         cdpIssueCount: `${cdpIssueCount}`,
         companyId,
         registrationNumber,
         tsValidTo,
     }
+    // values to be supplied to stripe.js
     const intentParams = {
-        amount,
+        amount: amountTotal,
         // In the latest version of the API, specifying the `automatic_payment_methods` parameter is optional because Stripe enables its functionality by default.
         automatic_payment_methods: {
             enabled: true,
             allow_redirects: 'always' //default
         },
-        currency: CURRENCY, // pounds sterling
+        currency,
         description: !cdpEntry?.cdp
             ? 'CDP: Application'
             : `CDP: Renewal - ${monthYear}`,
         metadata,
-        shipping: {
-            address,
-            name,
-        },
-        receipt_email: email
+        receipt_email: email,
+        shipping: { address, name },
     }
     const intent = await stripe
         .paymentIntents
         .create(intentParams, { idempotencyKey })
         .catch(err => new Error(err))
     // stripe threw an error
     if (isError(intent)) return callback(intent.message)
-    const existingLogEntry = await dbCdpStripeIntents.get(intent.id)
+    const existingLogEntry = await dbCdpStripeIntents
+        .get(intent.id)
     const intentLogEntry = {
-        amount,
+        amountDetails,
         billingDetails: {
             address,
             email,
             name,
             phone,
         },
         createAccessCode: !code,
-        currency,
         generatedData,
         intentId: intent.id,
         metadata,
+        provider: 'stripe',
         status: 'created', // to be updated after payment is completed
     }
     await dbCdpStripeIntents.set(intent.id, intentLogEntry, true)