feat: Send metadata to GovPay

api.planx.uk/modules/pay/middleware.ts

@@ -2,6 +2,7 @@ import { NextFunction, Request, RequestHandler, Response } from "express";
 import { gql } from "graphql-request";
 import { $api } from "../../client";
 import { ServerError } from "../../errors";
+import { GovPayMetadata } from "./types";
 
 /**
  * Confirm that this local authority (aka team) has a pay token
@@ -32,6 +33,7 @@ interface GetPaymentRequestDetails {
   paymentRequest: {
     sessionId: string;
     paymentAmount: number;
+    govPayMetadata: GovPayMetadata[];
     session: {
       flowId: string;
       flow: {
@@ -45,14 +47,15 @@ interface GetPaymentRequestDetails {
 
 export async function fetchPaymentRequestDetails(
   req: Request,
-  _res: Response,
+  res: Response,
   next: NextFunction,
 ) {
   const query = gql`
     query GetPaymentRequestDetails($paymentRequestId: uuid!) {
       paymentRequest: payment_requests_by_pk(id: $paymentRequestId) {
         sessionId: session_id
         paymentAmount: payment_amount
+        govPayMetadata: govpay_metadata
         session {
           flowId: flow_id
           flow {
@@ -88,6 +91,8 @@ export async function fetchPaymentRequestDetails(
   const paymentAmount = paymentRequest.paymentAmount.toString();
   if (paymentAmount) req.params.paymentAmount = paymentAmount;
 
+  res.locals.govPayMetadata = paymentRequest.govPayMetadata;
+
   next();
 }
 
@@ -97,16 +102,12 @@ interface GovPayCreatePayment {
   reference: string;
   description: string;
   return_url: string;
-  metadata?: {
-    source: "PlanX";
-    flow: string;
-    inviteToPay: boolean;
-  };
+  metadata: Record<string, string | boolean>;
 }
 
 export async function buildPaymentPayload(
   req: Request,
-  _res: Response,
+  res: Response,
   next: NextFunction,
 ) {
   if (!req.query.returnURL) {
@@ -127,21 +128,20 @@ export async function buildPaymentPayload(
     );
   }
 
+  // Convert metadata to format required by GovPay
+  const govPayMetadata = Object.fromEntries(
+    res.locals.govPayMetadata.map(({ key, value }: GovPayMetadata) => [
+      key,
+      value,
+    ]),
+  );
+
   const createPaymentBody: GovPayCreatePayment = {
     amount: parseInt(req.params.paymentAmount),
     reference: req.query.sessionId as string,
     description: "New application (nominated payee)",
     return_url: req.query.returnURL as string,
-    metadata: {
-      source: "PlanX",
-      // Payment requests have /pay path suffix, so get flow-slug from second-to-last position
-      flow:
-        (req.query.returnURL as string)
-          .split("?")?.[0]
-          ?.split("/")
-          ?.slice(-2, -1)?.[0] || "Could not parse service name",
-      inviteToPay: true,
-    },
+    metadata: govPayMetadata,
   };
 
   req.body = createPaymentBody;

api.planx.uk/modules/pay/types.ts

@@ -49,3 +49,8 @@ export type PaymentRequestProxyController = ValidatedRequestHandler<
   typeof paymentRequestProxySchema,
   Buffer
 >;
+
+export interface GovPayMetadata {
+  key: string;
+  value: string | boolean;
+}

api.planx.uk/package.json

@@ -4,7 +4,7 @@
   "private": true,
   "dependencies": {
     "@airbrake/node": "^2.1.8",
-    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#eda1e67",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#10f239a",
     "@types/isomorphic-fetch": "^0.0.36",
     "adm-zip": "^0.5.10",
     "aws-sdk": "^2.1467.0",

e2e/tests/api-driven/package.json

@@ -6,7 +6,7 @@
   },
   "dependencies": {
     "@cucumber/cucumber": "^9.3.0",
-    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#eda1e67",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#10f239a",
     "axios": "^1.6.8",
     "dotenv": "^16.3.1",
     "dotenv-expand": "^10.0.0",

e2e/tests/api-driven/src/invite-to-pay/mocks/flow.json

@@ -63279,7 +63279,21 @@
         "yourDetailsTitle": "Your details",
         "instructionsTitle": "How to pay",
         "secondaryPageTitle": "Invite someone else to pay for this application",
-        "instructionsDescription": "<p>You can pay for your application by using GOV.UK Pay.</p>         <p>Your application will be sent after you have paid the fee.          Wait until you see an application sent message before closing your browser.</p>"
+        "instructionsDescription": "<p>You can pay for your application by using GOV.UK Pay.</p>         <p>Your application will be sent after you have paid the fee.          Wait until you see an application sent message before closing your browser.</p>",
+        "govPayMetadata": [
+          {
+            "key": "flow",
+            "value": "flow-name"
+          },
+          {
+            "key": "source",
+            "value": "PlanX"
+          },
+          {
+            "key": "isInviteToPay",
+            "value": true
+          }
+        ]
       },
       "type": 400
     },

e2e/tests/ui-driven/package.json

@@ -8,7 +8,7 @@
     "postinstall": "./install-dependencies.sh"
   },
   "dependencies": {
-    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#eda1e67",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#10f239a",
     "axios": "^1.6.8",
     "dotenv": "^16.3.1",
     "eslint": "^8.56.0",

editor.planx.uk/package.json

@@ -13,7 +13,7 @@
     "@mui/styles": "^5.15.2",
     "@mui/utils": "^5.15.2",
     "@opensystemslab/map": "^0.8.0",
-    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#eda1e67",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#10f239a",
     "@tiptap/core": "^2.0.3",
     "@tiptap/extension-bold": "^2.0.3",
     "@tiptap/extension-bubble-menu": "^2.1.13",