@defra/forms-engine-plugin 4.0.53 → 4.0.54

package/.server/server/plugins/engine/components/PaymentField.js

@@ -142,7 +142,7 @@ export class PaymentField extends FormComponent {
     const payCallbackUrl = `${baseUrl}/payment-callback?uuid=${uuid}`;
     const paymentPageUrl = args.sourceUrl;
     const amountInPence = Math.round(amount * 100);
-    const payment = await paymentService.createPayment(amountInPence, description, payCallbackUrl, reference, {
+    const payment = await paymentService.createPayment(amountInPence, description, payCallbackUrl, reference, isLivePayment, {
       formId,
       slug
     });
@@ -184,7 +184,7 @@ export class PaymentField extends FormComponent {
     /**
      * @see https://docs.payments.service.gov.uk/api_reference/#payment-status-lifecycle
      */
-    const status = await paymentService.getPaymentStatus(paymentId);
+    const status = await paymentService.getPaymentStatus(paymentId, isLivePayment);
     PaymentSubmissionError.checkPaymentAmount(status.amount, this.options.amount, this);
     if (status.state.status === 'success') {
       await this.markPaymentCaptured(request, paymentState);

package/.server/server/plugins/engine/components/PaymentField.js.map

@@ -1 +1 @@
-{"version":3,"file":"PaymentField.js","names":["randomUUID","StatusCodes","joi","FormComponent","getPluginOptions","PaymentErrorTypes","PaymentPreAuthError","PaymentSubmissionError","createPaymentService","formatCurrency","PaymentField","isAppendageStateSingleObject","constructor","def","props","options","paymentStateSchema","object","paymentId","string","required","reference","amount","number","description","uuid","formId","isLivePayment","boolean","preAuth","status","valid","createdAt","isoDate","unknown","label","formSchema","stateSchema","getPaymentStateFromState","state","value","name","isPaymentState","undefined","getDisplayStringFromState","getViewModel","payload","errors","viewModel","paymentState","Array","isArray","isState","getFormValue","getContextValueFromState","getAllPossibleErrors","baseErrors","type","template","advancedSettingsErrors","dispatcher","request","h","args","componentName","component","model","controller","getState","baseUrl","server","summaryUrl","basePath","existingPaymentState","redirect","code","SEE_OTHER","isLive","isPreview","paymentService","$$__referenceNumber","slug","payCallbackUrl","paymentPageUrl","sourceUrl","amountInPence","Math","round","payment","createPayment","sessionData","returnUrl","failureUrl","yar","set","paymentUrl","onSubmit","_metadata","context","PaymentIncomplete","capture","getPaymentStatus","checkPaymentAmount","markPaymentCaptured","PaymentExpired","captured","capturePayment","updatedState","Date","toISOString","page","currentState","mergeState"],"sources":["../../../../../src/server/plugins/engine/components/PaymentField.ts"],"sourcesContent":["import { randomUUID } from 'node:crypto'\n\nimport {\n  type FormMetadata,\n  type PaymentFieldComponent\n} from '@defra/forms-model'\nimport { StatusCodes } from 'http-status-codes'\nimport joi, { type ObjectSchema } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type PaymentState } from '~/src/server/plugins/engine/components/PaymentField.types.js'\nimport { getPluginOptions } from '~/src/server/plugins/engine/helpers.js'\nimport {\n  PaymentErrorTypes,\n  PaymentPreAuthError,\n  PaymentSubmissionError\n} from '~/src/server/plugins/engine/pageControllers/errors.js'\nimport {\n  type AnyFormRequest,\n  type FormContext,\n  type FormRequestPayload,\n  type FormResponseToolkit\n} from '~/src/server/plugins/engine/types/index.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  createPaymentService,\n  formatCurrency\n} from '~/src/server/plugins/payment/helper.js'\n\nexport class PaymentField extends FormComponent {\n  declare options: PaymentFieldComponent['options']\n  declare formSchema: ObjectSchema\n  declare stateSchema: ObjectSchema\n  isAppendageStateSingleObject = true\n\n  constructor(\n    def: PaymentFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    this.options = def.options\n\n    const paymentStateSchema = joi\n      .object({\n        paymentId: joi.string().required(),\n        reference: joi.string().required(),\n        amount: joi.number().required(),\n        description: joi.string().required(),\n        uuid: joi.string().uuid().required(),\n        formId: joi.string().required(),\n        isLivePayment: joi.boolean().required(),\n        preAuth: joi\n          .object({\n            status: joi\n              .string()\n              .valid('success', 'failed', 'started')\n              .required(),\n            createdAt: joi.string().isoDate().required()\n          })\n          .required()\n      })\n      .unknown(true)\n      .label(this.label)\n\n    this.formSchema = paymentStateSchema\n    // 'required()' forces the payment page to be invalid until we have valid payment state\n    // i.e. the user will automatically be directed back to the payment page\n    // if they attempt to access future pages when no payment entered yet\n    this.stateSchema = paymentStateSchema.required()\n  }\n\n  /**\n   * Gets the PaymentState from form submission state\n   */\n  getPaymentStateFromState(\n    state: FormSubmissionState\n  ): PaymentState | undefined {\n    const value = state[this.name]\n    return this.isPaymentState(value) ? value : undefined\n  }\n\n  getDisplayStringFromState(state: FormSubmissionState): string {\n    const value = this.getPaymentStateFromState(state)\n\n    if (!value) {\n      return ''\n    }\n\n    return `${formatCurrency(value.amount)} - ${value.description}`\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const viewModel = super.getViewModel(payload, errors)\n\n    // Payload is pre-populated from state if a payment has already been made\n    const paymentState = this.isPaymentState(payload[this.name] as unknown)\n      ? (payload[this.name] as unknown as PaymentState)\n      : undefined\n\n    // When user initially visits the payment page, there is no payment state yet so the amount is read form the form definition.\n    const amount = paymentState?.amount ?? this.options.amount\n\n    return {\n      ...viewModel,\n      amount: formatCurrency(amount),\n      description: this.options.description,\n      paymentState\n    }\n  }\n\n  /**\n   * Type guard to check if value is PaymentState\n   */\n  isPaymentState(value: unknown): value is PaymentState {\n    return PaymentField.isPaymentState(value)\n  }\n\n  /**\n   * Static type guard to check if value is PaymentState\n   */\n  static isPaymentState(value: unknown): value is PaymentState {\n    if (!value || typeof value !== 'object' || Array.isArray(value)) {\n      return false\n    }\n\n    const state = value as PaymentState\n    return (\n      typeof state.paymentId === 'string' &&\n      typeof state.amount === 'number' &&\n      typeof state.description === 'string'\n    )\n  }\n\n  /**\n   * Override base isState to validate PaymentState\n   */\n  isState(value?: FormStateValue | FormState): value is FormState {\n    return this.isPaymentState(value)\n  }\n\n  getFormValue(value?: FormStateValue | FormState) {\n    return this.isPaymentState(value)\n      ? (value as unknown as NonNullable<FormStateValue>)\n      : undefined\n  }\n\n  getContextValueFromState(state: FormSubmissionState) {\n    return this.isPaymentState(state)\n      ? `Reference: ${state.reference}\\nAmount: ${formatCurrency(state.amount)}`\n      : ''\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return PaymentField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        {\n          type: 'paymentRequired',\n          template: 'Complete the payment to continue'\n        }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n\n  /**\n   * Dispatcher for external redirect to GOV.UK Pay\n   */\n  static async dispatcher(\n    request: FormRequestPayload,\n    h: FormResponseToolkit,\n    args: PaymentDispatcherArgs\n  ): Promise<unknown> {\n    const { options, name: componentName } = args.component\n    const { model } = args.controller\n\n    const state = await args.controller.getState(request)\n    const { baseUrl } = getPluginOptions(request.server)\n    const summaryUrl = `${baseUrl}/${model.basePath}/summary`\n\n    const existingPaymentState = state[componentName]\n    if (\n      PaymentField.isPaymentState(existingPaymentState) &&\n      existingPaymentState.preAuth?.status === 'success'\n    ) {\n      return h.redirect(summaryUrl).code(StatusCodes.SEE_OTHER)\n    }\n\n    const isLivePayment = args.isLive && !args.isPreview\n    const formId = args.controller.model.formId\n    const paymentService = createPaymentService(isLivePayment, formId)\n\n    const uuid = randomUUID()\n\n    const reference = state.$$__referenceNumber as string\n    const amount = options.amount\n\n    const description = options.description\n\n    const slug = `/${model.basePath}`\n\n    const payCallbackUrl = `${baseUrl}/payment-callback?uuid=${uuid}`\n    const paymentPageUrl = args.sourceUrl\n\n    const amountInPence = Math.round(amount * 100)\n    const payment = await paymentService.createPayment(\n      amountInPence,\n      description,\n      payCallbackUrl,\n      reference,\n      { formId, slug }\n    )\n\n    const sessionData: PaymentSessionData = {\n      uuid,\n      formId,\n      reference,\n      amount,\n      description,\n      paymentId: payment.paymentId,\n      componentName,\n      returnUrl: summaryUrl,\n      failureUrl: paymentPageUrl,\n      isLivePayment\n    }\n\n    request.yar.set(`payment-${uuid}`, sessionData)\n\n    return h.redirect(payment.paymentUrl).code(StatusCodes.SEE_OTHER)\n  }\n\n  /**\n   * Called on form submission to capture the payment\n   * @see https://docs.payments.service.gov.uk/delayed_capture/#delay-taking-a-payment\n   */\n  async onSubmit(\n    request: FormRequestPayload,\n    _metadata: FormMetadata,\n    context: FormContext\n  ): Promise<void> {\n    const paymentState = this.getPaymentStateFromState(context.state)\n\n    if (!paymentState) {\n      throw new PaymentPreAuthError(\n        this,\n        'Complete the payment to continue',\n        true,\n        PaymentErrorTypes.PaymentIncomplete\n      )\n    }\n\n    if (paymentState.capture?.status === 'success') {\n      return\n    }\n\n    const { paymentId, isLivePayment, formId } = paymentState\n    const paymentService = createPaymentService(isLivePayment, formId)\n\n    /**\n     * @see https://docs.payments.service.gov.uk/api_reference/#payment-status-lifecycle\n     */\n    const status = await paymentService.getPaymentStatus(paymentId)\n\n    PaymentSubmissionError.checkPaymentAmount(\n      status.amount,\n      this.options.amount,\n      this\n    )\n\n    if (status.state.status === 'success') {\n      await this.markPaymentCaptured(request, paymentState)\n      return\n    }\n\n    if (status.state.status !== 'capturable') {\n      throw new PaymentPreAuthError(\n        this,\n        'Your payment authorisation has expired. Please add your payment details again.',\n        true,\n        PaymentErrorTypes.PaymentExpired\n      )\n    }\n\n    const captured = await paymentService.capturePayment(\n      paymentId,\n      status.amount\n    )\n\n    if (!captured) {\n      throw new PaymentPreAuthError(\n        this,\n        'There was a problem and your form was not submitted. Try submitting the form again.',\n        false\n      )\n    }\n\n    await this.markPaymentCaptured(request, paymentState)\n  }\n\n  /**\n   * Updates payment state to mark capture as successful\n   * This ensures we don't try to re-capture on submission retry\n   */\n  private async markPaymentCaptured(\n    request: FormRequestPayload,\n    paymentState: PaymentState\n  ): Promise<void> {\n    const updatedState: PaymentState = {\n      ...paymentState,\n      capture: {\n        status: 'success',\n        createdAt: new Date().toISOString()\n      }\n    }\n\n    if (this.page) {\n      const currentState = await this.page.getState(request)\n      await this.page.mergeState(request, currentState, {\n        [this.name]: updatedState\n      })\n    }\n  }\n}\n\nexport interface PaymentDispatcherArgs {\n  controller: {\n    model: {\n      formId: string\n      basePath: string\n      name: string\n    }\n    getState: (request: AnyFormRequest) => Promise<FormSubmissionState>\n  }\n  component: PaymentField\n  sourceUrl: string\n  isLive: boolean\n  isPreview: boolean\n}\n\n/**\n * Session data stored when dispatching to GOV.UK Pay\n */\nexport interface PaymentSessionData {\n  uuid: string\n  formId: string\n  reference: string\n  amount: number\n  description: string\n  paymentId: string\n  componentName: string\n  returnUrl: string\n  failureUrl: string\n  isLivePayment: boolean\n}\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,aAAa;AAMxC,SAASC,WAAW,QAAQ,mBAAmB;AAC/C,OAAOC,GAAG,MAA6B,KAAK;AAE5C,SAASC,aAAa;AAEtB,SAASC,gBAAgB;AACzB,SACEC,iBAAiB,EACjBC,mBAAmB,EACnBC,sBAAsB;AAgBxB,SACEC,oBAAoB,EACpBC,cAAc;AAGhB,OAAO,MAAMC,YAAY,SAASP,aAAa,CAAC;EAI9CQ,4BAA4B,GAAG,IAAI;EAEnCC,WAAWA,CACTC,GAA0B,EAC1BC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,IAAI,CAACC,OAAO,GAAGF,GAAG,CAACE,OAAO;IAE1B,MAAMC,kBAAkB,GAAGd,GAAG,CAC3Be,MAAM,CAAC;MACNC,SAAS,EAAEhB,GAAG,CAACiB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MAClCC,SAAS,EAAEnB,GAAG,CAACiB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MAClCE,MAAM,EAAEpB,GAAG,CAACqB,MAAM,CAAC,CAAC,CAACH,QAAQ,CAAC,CAAC;MAC/BI,WAAW,EAAEtB,GAAG,CAACiB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MACpCK,IAAI,EAAEvB,GAAG,CAACiB,MAAM,CAAC,CAAC,CAACM,IAAI,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;MACpCM,MAAM,EAAExB,GAAG,CAACiB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MAC/BO,aAAa,EAAEzB,GAAG,CAAC0B,OAAO,CAAC,CAAC,CAACR,QAAQ,CAAC,CAAC;MACvCS,OAAO,EAAE3B,GAAG,CACTe,MAAM,CAAC;QACNa,MAAM,EAAE5B,GAAG,CACRiB,MAAM,CAAC,CAAC,CACRY,KAAK,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,CACrCX,QAAQ,CAAC,CAAC;QACbY,SAAS,EAAE9B,GAAG,CAACiB,MAAM,CAAC,CAAC,CAACc,OAAO,CAAC,CAAC,CAACb,QAAQ,CAAC;MAC7C,CAAC,CAAC,CACDA,QAAQ,CAAC;IACd,CAAC,CAAC,CACDc,OAAO,CAAC,IAAI,CAAC,CACbC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC;IAEpB,IAAI,CAACC,UAAU,GAAGpB,kBAAkB;IACpC;IACA;IACA;IACA,IAAI,CAACqB,WAAW,GAAGrB,kBAAkB,CAACI,QAAQ,CAAC,CAAC;EAClD;;EAEA;AACF;AACA;EACEkB,wBAAwBA,CACtBC,KAA0B,EACA;IAC1B,MAAMC,KAAK,GAAGD,KAAK,CAAC,IAAI,CAACE,IAAI,CAAC;IAC9B,OAAO,IAAI,CAACC,cAAc,CAACF,KAAK,CAAC,GAAGA,KAAK,GAAGG,SAAS;EACvD;EAEAC,yBAAyBA,CAACL,KAA0B,EAAU;IAC5D,MAAMC,KAAK,GAAG,IAAI,CAACF,wBAAwB,CAACC,KAAK,CAAC;IAElD,IAAI,CAACC,KAAK,EAAE;MACV,OAAO,EAAE;IACX;IAEA,OAAO,GAAG/B,cAAc,CAAC+B,KAAK,CAAClB,MAAM,CAAC,MAAMkB,KAAK,CAAChB,WAAW,EAAE;EACjE;EAEAqB,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;;IAErD;IACA,MAAME,YAAY,GAAG,IAAI,CAACP,cAAc,CAACI,OAAO,CAAC,IAAI,CAACL,IAAI,CAAY,CAAC,GAClEK,OAAO,CAAC,IAAI,CAACL,IAAI,CAAC,GACnBE,SAAS;;IAEb;IACA,MAAMrB,MAAM,GAAG2B,YAAY,EAAE3B,MAAM,IAAI,IAAI,CAACP,OAAO,CAACO,MAAM;IAE1D,OAAO;MACL,GAAG0B,SAAS;MACZ1B,MAAM,EAAEb,cAAc,CAACa,MAAM,CAAC;MAC9BE,WAAW,EAAE,IAAI,CAACT,OAAO,CAACS,WAAW;MACrCyB;IACF,CAAC;EACH;;EAEA;AACF;AACA;EACEP,cAAcA,CAACF,KAAc,EAAyB;IACpD,OAAO9B,YAAY,CAACgC,cAAc,CAACF,KAAK,CAAC;EAC3C;;EAEA;AACF;AACA;EACE,OAAOE,cAAcA,CAACF,KAAc,EAAyB;IAC3D,IAAI,CAACA,KAAK,IAAI,OAAOA,KAAK,KAAK,QAAQ,IAAIU,KAAK,CAACC,OAAO,CAACX,KAAK,CAAC,EAAE;MAC/D,OAAO,KAAK;IACd;IAEA,MAAMD,KAAK,GAAGC,KAAqB;IACnC,OACE,OAAOD,KAAK,CAACrB,SAAS,KAAK,QAAQ,IACnC,OAAOqB,KAAK,CAACjB,MAAM,KAAK,QAAQ,IAChC,OAAOiB,KAAK,CAACf,WAAW,KAAK,QAAQ;EAEzC;;EAEA;AACF;AACA;EACE4B,OAAOA,CAACZ,KAAkC,EAAsB;IAC9D,OAAO,IAAI,CAACE,cAAc,CAACF,KAAK,CAAC;EACnC;EAEAa,YAAYA,CAACb,KAAkC,EAAE;IAC/C,OAAO,IAAI,CAACE,cAAc,CAACF,KAAK,CAAC,GAC5BA,KAAK,GACNG,SAAS;EACf;EAEAW,wBAAwBA,CAACf,KAA0B,EAAE;IACnD,OAAO,IAAI,CAACG,cAAc,CAACH,KAAK,CAAC,GAC7B,cAAcA,KAAK,CAAClB,SAAS,aAAaZ,cAAc,CAAC8B,KAAK,CAACjB,MAAM,CAAC,EAAE,GACxE,EAAE;EACR;;EAEA;AACF;AACA;EACEiC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO7C,YAAY,CAAC6C,oBAAoB,CAAC,CAAC;EAC5C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QACEC,IAAI,EAAE,iBAAiB;QACvBC,QAAQ,EAAE;MACZ,CAAC,CACF;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;;EAEA;AACF;AACA;EACE,aAAaC,UAAUA,CACrBC,OAA2B,EAC3BC,CAAsB,EACtBC,IAA2B,EACT;IAClB,MAAM;MAAEhD,OAAO;MAAE0B,IAAI,EAAEuB;IAAc,CAAC,GAAGD,IAAI,CAACE,SAAS;IACvD,MAAM;MAAEC;IAAM,CAAC,GAAGH,IAAI,CAACI,UAAU;IAEjC,MAAM5B,KAAK,GAAG,MAAMwB,IAAI,CAACI,UAAU,CAACC,QAAQ,CAACP,OAAO,CAAC;IACrD,MAAM;MAAEQ;IAAQ,CAAC,GAAGjE,gBAAgB,CAACyD,OAAO,CAACS,MAAM,CAAC;IACpD,MAAMC,UAAU,GAAG,GAAGF,OAAO,IAAIH,KAAK,CAACM,QAAQ,UAAU;IAEzD,MAAMC,oBAAoB,GAAGlC,KAAK,CAACyB,aAAa,CAAC;IACjD,IACEtD,YAAY,CAACgC,cAAc,CAAC+B,oBAAoB,CAAC,IACjDA,oBAAoB,CAAC5C,OAAO,EAAEC,MAAM,KAAK,SAAS,EAClD;MACA,OAAOgC,CAAC,CAACY,QAAQ,CAACH,UAAU,CAAC,CAACI,IAAI,CAAC1E,WAAW,CAAC2E,SAAS,CAAC;IAC3D;IAEA,MAAMjD,aAAa,GAAGoC,IAAI,CAACc,MAAM,IAAI,CAACd,IAAI,CAACe,SAAS;IACpD,MAAMpD,MAAM,GAAGqC,IAAI,CAACI,UAAU,CAACD,KAAK,CAACxC,MAAM;IAC3C,MAAMqD,cAAc,GAAGvE,oBAAoB,CAACmB,aAAa,EAAED,MAAM,CAAC;IAElE,MAAMD,IAAI,GAAGzB,UAAU,CAAC,CAAC;IAEzB,MAAMqB,SAAS,GAAGkB,KAAK,CAACyC,mBAA6B;IACrD,MAAM1D,MAAM,GAAGP,OAAO,CAACO,MAAM;IAE7B,MAAME,WAAW,GAAGT,OAAO,CAACS,WAAW;IAEvC,MAAMyD,IAAI,GAAG,IAAIf,KAAK,CAACM,QAAQ,EAAE;IAEjC,MAAMU,cAAc,GAAG,GAAGb,OAAO,0BAA0B5C,IAAI,EAAE;IACjE,MAAM0D,cAAc,GAAGpB,IAAI,CAACqB,SAAS;IAErC,MAAMC,aAAa,GAAGC,IAAI,CAACC,KAAK,CAACjE,MAAM,GAAG,GAAG,CAAC;IAC9C,MAAMkE,OAAO,GAAG,MAAMT,cAAc,CAACU,aAAa,CAChDJ,aAAa,EACb7D,WAAW,EACX0D,cAAc,EACd7D,SAAS,EACT;MAAEK,MAAM;MAAEuD;IAAK,CACjB,CAAC;IAED,MAAMS,WAA+B,GAAG;MACtCjE,IAAI;MACJC,MAAM;MACNL,SAAS;MACTC,MAAM;MACNE,WAAW;MACXN,SAAS,EAAEsE,OAAO,CAACtE,SAAS;MAC5B8C,aAAa;MACb2B,SAAS,EAAEpB,UAAU;MACrBqB,UAAU,EAAET,cAAc;MAC1BxD;IACF,CAAC;IAEDkC,OAAO,CAACgC,GAAG,CAACC,GAAG,CAAC,WAAWrE,IAAI,EAAE,EAAEiE,WAAW,CAAC;IAE/C,OAAO5B,CAAC,CAACY,QAAQ,CAACc,OAAO,CAACO,UAAU,CAAC,CAACpB,IAAI,CAAC1E,WAAW,CAAC2E,SAAS,CAAC;EACnE;;EAEA;AACF;AACA;AACA;EACE,MAAMoB,QAAQA,CACZnC,OAA2B,EAC3BoC,SAAuB,EACvBC,OAAoB,EACL;IACf,MAAMjD,YAAY,GAAG,IAAI,CAACX,wBAAwB,CAAC4D,OAAO,CAAC3D,KAAK,CAAC;IAEjE,IAAI,CAACU,YAAY,EAAE;MACjB,MAAM,IAAI3C,mBAAmB,CAC3B,IAAI,EACJ,kCAAkC,EAClC,IAAI,EACJD,iBAAiB,CAAC8F,iBACpB,CAAC;IACH;IAEA,IAAIlD,YAAY,CAACmD,OAAO,EAAEtE,MAAM,KAAK,SAAS,EAAE;MAC9C;IACF;IAEA,MAAM;MAAEZ,SAAS;MAAES,aAAa;MAAED;IAAO,CAAC,GAAGuB,YAAY;IACzD,MAAM8B,cAAc,GAAGvE,oBAAoB,CAACmB,aAAa,EAAED,MAAM,CAAC;;IAElE;AACJ;AACA;IACI,MAAMI,MAAM,GAAG,MAAMiD,cAAc,CAACsB,gBAAgB,CAACnF,SAAS,CAAC;IAE/DX,sBAAsB,CAAC+F,kBAAkB,CACvCxE,MAAM,CAACR,MAAM,EACb,IAAI,CAACP,OAAO,CAACO,MAAM,EACnB,IACF,CAAC;IAED,IAAIQ,MAAM,CAACS,KAAK,CAACT,MAAM,KAAK,SAAS,EAAE;MACrC,MAAM,IAAI,CAACyE,mBAAmB,CAAC1C,OAAO,EAAEZ,YAAY,CAAC;MACrD;IACF;IAEA,IAAInB,MAAM,CAACS,KAAK,CAACT,MAAM,KAAK,YAAY,EAAE;MACxC,MAAM,IAAIxB,mBAAmB,CAC3B,IAAI,EACJ,gFAAgF,EAChF,IAAI,EACJD,iBAAiB,CAACmG,cACpB,CAAC;IACH;IAEA,MAAMC,QAAQ,GAAG,MAAM1B,cAAc,CAAC2B,cAAc,CAClDxF,SAAS,EACTY,MAAM,CAACR,MACT,CAAC;IAED,IAAI,CAACmF,QAAQ,EAAE;MACb,MAAM,IAAInG,mBAAmB,CAC3B,IAAI,EACJ,qFAAqF,EACrF,KACF,CAAC;IACH;IAEA,MAAM,IAAI,CAACiG,mBAAmB,CAAC1C,OAAO,EAAEZ,YAAY,CAAC;EACvD;;EAEA;AACF;AACA;AACA;EACE,MAAcsD,mBAAmBA,CAC/B1C,OAA2B,EAC3BZ,YAA0B,EACX;IACf,MAAM0D,YAA0B,GAAG;MACjC,GAAG1D,YAAY;MACfmD,OAAO,EAAE;QACPtE,MAAM,EAAE,SAAS;QACjBE,SAAS,EAAE,IAAI4E,IAAI,CAAC,CAAC,CAACC,WAAW,CAAC;MACpC;IACF,CAAC;IAED,IAAI,IAAI,CAACC,IAAI,EAAE;MACb,MAAMC,YAAY,GAAG,MAAM,IAAI,CAACD,IAAI,CAAC1C,QAAQ,CAACP,OAAO,CAAC;MACtD,MAAM,IAAI,CAACiD,IAAI,CAACE,UAAU,CAACnD,OAAO,EAAEkD,YAAY,EAAE;QAChD,CAAC,IAAI,CAACtE,IAAI,GAAGkE;MACf,CAAC,CAAC;IACJ;EACF;AACF;;AAiBA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"PaymentField.js","names":["randomUUID","StatusCodes","joi","FormComponent","getPluginOptions","PaymentErrorTypes","PaymentPreAuthError","PaymentSubmissionError","createPaymentService","formatCurrency","PaymentField","isAppendageStateSingleObject","constructor","def","props","options","paymentStateSchema","object","paymentId","string","required","reference","amount","number","description","uuid","formId","isLivePayment","boolean","preAuth","status","valid","createdAt","isoDate","unknown","label","formSchema","stateSchema","getPaymentStateFromState","state","value","name","isPaymentState","undefined","getDisplayStringFromState","getViewModel","payload","errors","viewModel","paymentState","Array","isArray","isState","getFormValue","getContextValueFromState","getAllPossibleErrors","baseErrors","type","template","advancedSettingsErrors","dispatcher","request","h","args","componentName","component","model","controller","getState","baseUrl","server","summaryUrl","basePath","existingPaymentState","redirect","code","SEE_OTHER","isLive","isPreview","paymentService","$$__referenceNumber","slug","payCallbackUrl","paymentPageUrl","sourceUrl","amountInPence","Math","round","payment","createPayment","sessionData","returnUrl","failureUrl","yar","set","paymentUrl","onSubmit","_metadata","context","PaymentIncomplete","capture","getPaymentStatus","checkPaymentAmount","markPaymentCaptured","PaymentExpired","captured","capturePayment","updatedState","Date","toISOString","page","currentState","mergeState"],"sources":["../../../../../src/server/plugins/engine/components/PaymentField.ts"],"sourcesContent":["import { randomUUID } from 'node:crypto'\n\nimport {\n  type FormMetadata,\n  type PaymentFieldComponent\n} from '@defra/forms-model'\nimport { StatusCodes } from 'http-status-codes'\nimport joi, { type ObjectSchema } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type PaymentState } from '~/src/server/plugins/engine/components/PaymentField.types.js'\nimport { getPluginOptions } from '~/src/server/plugins/engine/helpers.js'\nimport {\n  PaymentErrorTypes,\n  PaymentPreAuthError,\n  PaymentSubmissionError\n} from '~/src/server/plugins/engine/pageControllers/errors.js'\nimport {\n  type AnyFormRequest,\n  type FormContext,\n  type FormRequestPayload,\n  type FormResponseToolkit\n} from '~/src/server/plugins/engine/types/index.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  createPaymentService,\n  formatCurrency\n} from '~/src/server/plugins/payment/helper.js'\n\nexport class PaymentField extends FormComponent {\n  declare options: PaymentFieldComponent['options']\n  declare formSchema: ObjectSchema\n  declare stateSchema: ObjectSchema\n  isAppendageStateSingleObject = true\n\n  constructor(\n    def: PaymentFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    this.options = def.options\n\n    const paymentStateSchema = joi\n      .object({\n        paymentId: joi.string().required(),\n        reference: joi.string().required(),\n        amount: joi.number().required(),\n        description: joi.string().required(),\n        uuid: joi.string().uuid().required(),\n        formId: joi.string().required(),\n        isLivePayment: joi.boolean().required(),\n        preAuth: joi\n          .object({\n            status: joi\n              .string()\n              .valid('success', 'failed', 'started')\n              .required(),\n            createdAt: joi.string().isoDate().required()\n          })\n          .required()\n      })\n      .unknown(true)\n      .label(this.label)\n\n    this.formSchema = paymentStateSchema\n    // 'required()' forces the payment page to be invalid until we have valid payment state\n    // i.e. the user will automatically be directed back to the payment page\n    // if they attempt to access future pages when no payment entered yet\n    this.stateSchema = paymentStateSchema.required()\n  }\n\n  /**\n   * Gets the PaymentState from form submission state\n   */\n  getPaymentStateFromState(\n    state: FormSubmissionState\n  ): PaymentState | undefined {\n    const value = state[this.name]\n    return this.isPaymentState(value) ? value : undefined\n  }\n\n  getDisplayStringFromState(state: FormSubmissionState): string {\n    const value = this.getPaymentStateFromState(state)\n\n    if (!value) {\n      return ''\n    }\n\n    return `${formatCurrency(value.amount)} - ${value.description}`\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const viewModel = super.getViewModel(payload, errors)\n\n    // Payload is pre-populated from state if a payment has already been made\n    const paymentState = this.isPaymentState(payload[this.name] as unknown)\n      ? (payload[this.name] as unknown as PaymentState)\n      : undefined\n\n    // When user initially visits the payment page, there is no payment state yet so the amount is read form the form definition.\n    const amount = paymentState?.amount ?? this.options.amount\n\n    return {\n      ...viewModel,\n      amount: formatCurrency(amount),\n      description: this.options.description,\n      paymentState\n    }\n  }\n\n  /**\n   * Type guard to check if value is PaymentState\n   */\n  isPaymentState(value: unknown): value is PaymentState {\n    return PaymentField.isPaymentState(value)\n  }\n\n  /**\n   * Static type guard to check if value is PaymentState\n   */\n  static isPaymentState(value: unknown): value is PaymentState {\n    if (!value || typeof value !== 'object' || Array.isArray(value)) {\n      return false\n    }\n\n    const state = value as PaymentState\n    return (\n      typeof state.paymentId === 'string' &&\n      typeof state.amount === 'number' &&\n      typeof state.description === 'string'\n    )\n  }\n\n  /**\n   * Override base isState to validate PaymentState\n   */\n  isState(value?: FormStateValue | FormState): value is FormState {\n    return this.isPaymentState(value)\n  }\n\n  getFormValue(value?: FormStateValue | FormState) {\n    return this.isPaymentState(value)\n      ? (value as unknown as NonNullable<FormStateValue>)\n      : undefined\n  }\n\n  getContextValueFromState(state: FormSubmissionState) {\n    return this.isPaymentState(state)\n      ? `Reference: ${state.reference}\\nAmount: ${formatCurrency(state.amount)}`\n      : ''\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return PaymentField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        {\n          type: 'paymentRequired',\n          template: 'Complete the payment to continue'\n        }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n\n  /**\n   * Dispatcher for external redirect to GOV.UK Pay\n   */\n  static async dispatcher(\n    request: FormRequestPayload,\n    h: FormResponseToolkit,\n    args: PaymentDispatcherArgs\n  ): Promise<unknown> {\n    const { options, name: componentName } = args.component\n    const { model } = args.controller\n\n    const state = await args.controller.getState(request)\n    const { baseUrl } = getPluginOptions(request.server)\n    const summaryUrl = `${baseUrl}/${model.basePath}/summary`\n\n    const existingPaymentState = state[componentName]\n    if (\n      PaymentField.isPaymentState(existingPaymentState) &&\n      existingPaymentState.preAuth?.status === 'success'\n    ) {\n      return h.redirect(summaryUrl).code(StatusCodes.SEE_OTHER)\n    }\n\n    const isLivePayment = args.isLive && !args.isPreview\n    const formId = args.controller.model.formId\n    const paymentService = createPaymentService(isLivePayment, formId)\n\n    const uuid = randomUUID()\n\n    const reference = state.$$__referenceNumber as string\n    const amount = options.amount\n\n    const description = options.description\n\n    const slug = `/${model.basePath}`\n\n    const payCallbackUrl = `${baseUrl}/payment-callback?uuid=${uuid}`\n    const paymentPageUrl = args.sourceUrl\n\n    const amountInPence = Math.round(amount * 100)\n    const payment = await paymentService.createPayment(\n      amountInPence,\n      description,\n      payCallbackUrl,\n      reference,\n      isLivePayment,\n      { formId, slug }\n    )\n\n    const sessionData: PaymentSessionData = {\n      uuid,\n      formId,\n      reference,\n      amount,\n      description,\n      paymentId: payment.paymentId,\n      componentName,\n      returnUrl: summaryUrl,\n      failureUrl: paymentPageUrl,\n      isLivePayment\n    }\n\n    request.yar.set(`payment-${uuid}`, sessionData)\n\n    return h.redirect(payment.paymentUrl).code(StatusCodes.SEE_OTHER)\n  }\n\n  /**\n   * Called on form submission to capture the payment\n   * @see https://docs.payments.service.gov.uk/delayed_capture/#delay-taking-a-payment\n   */\n  async onSubmit(\n    request: FormRequestPayload,\n    _metadata: FormMetadata,\n    context: FormContext\n  ): Promise<void> {\n    const paymentState = this.getPaymentStateFromState(context.state)\n\n    if (!paymentState) {\n      throw new PaymentPreAuthError(\n        this,\n        'Complete the payment to continue',\n        true,\n        PaymentErrorTypes.PaymentIncomplete\n      )\n    }\n\n    if (paymentState.capture?.status === 'success') {\n      return\n    }\n\n    const { paymentId, isLivePayment, formId } = paymentState\n    const paymentService = createPaymentService(isLivePayment, formId)\n\n    /**\n     * @see https://docs.payments.service.gov.uk/api_reference/#payment-status-lifecycle\n     */\n    const status = await paymentService.getPaymentStatus(\n      paymentId,\n      isLivePayment\n    )\n\n    PaymentSubmissionError.checkPaymentAmount(\n      status.amount,\n      this.options.amount,\n      this\n    )\n\n    if (status.state.status === 'success') {\n      await this.markPaymentCaptured(request, paymentState)\n      return\n    }\n\n    if (status.state.status !== 'capturable') {\n      throw new PaymentPreAuthError(\n        this,\n        'Your payment authorisation has expired. Please add your payment details again.',\n        true,\n        PaymentErrorTypes.PaymentExpired\n      )\n    }\n\n    const captured = await paymentService.capturePayment(\n      paymentId,\n      status.amount\n    )\n\n    if (!captured) {\n      throw new PaymentPreAuthError(\n        this,\n        'There was a problem and your form was not submitted. Try submitting the form again.',\n        false\n      )\n    }\n\n    await this.markPaymentCaptured(request, paymentState)\n  }\n\n  /**\n   * Updates payment state to mark capture as successful\n   * This ensures we don't try to re-capture on submission retry\n   */\n  private async markPaymentCaptured(\n    request: FormRequestPayload,\n    paymentState: PaymentState\n  ): Promise<void> {\n    const updatedState: PaymentState = {\n      ...paymentState,\n      capture: {\n        status: 'success',\n        createdAt: new Date().toISOString()\n      }\n    }\n\n    if (this.page) {\n      const currentState = await this.page.getState(request)\n      await this.page.mergeState(request, currentState, {\n        [this.name]: updatedState\n      })\n    }\n  }\n}\n\nexport interface PaymentDispatcherArgs {\n  controller: {\n    model: {\n      formId: string\n      basePath: string\n      name: string\n    }\n    getState: (request: AnyFormRequest) => Promise<FormSubmissionState>\n  }\n  component: PaymentField\n  sourceUrl: string\n  isLive: boolean\n  isPreview: boolean\n}\n\n/**\n * Session data stored when dispatching to GOV.UK Pay\n */\nexport interface PaymentSessionData {\n  uuid: string\n  formId: string\n  reference: string\n  amount: number\n  description: string\n  paymentId: string\n  componentName: string\n  returnUrl: string\n  failureUrl: string\n  isLivePayment: boolean\n}\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,aAAa;AAMxC,SAASC,WAAW,QAAQ,mBAAmB;AAC/C,OAAOC,GAAG,MAA6B,KAAK;AAE5C,SAASC,aAAa;AAEtB,SAASC,gBAAgB;AACzB,SACEC,iBAAiB,EACjBC,mBAAmB,EACnBC,sBAAsB;AAgBxB,SACEC,oBAAoB,EACpBC,cAAc;AAGhB,OAAO,MAAMC,YAAY,SAASP,aAAa,CAAC;EAI9CQ,4BAA4B,GAAG,IAAI;EAEnCC,WAAWA,CACTC,GAA0B,EAC1BC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,IAAI,CAACC,OAAO,GAAGF,GAAG,CAACE,OAAO;IAE1B,MAAMC,kBAAkB,GAAGd,GAAG,CAC3Be,MAAM,CAAC;MACNC,SAAS,EAAEhB,GAAG,CAACiB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MAClCC,SAAS,EAAEnB,GAAG,CAACiB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MAClCE,MAAM,EAAEpB,GAAG,CAACqB,MAAM,CAAC,CAAC,CAACH,QAAQ,CAAC,CAAC;MAC/BI,WAAW,EAAEtB,GAAG,CAACiB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MACpCK,IAAI,EAAEvB,GAAG,CAACiB,MAAM,CAAC,CAAC,CAACM,IAAI,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;MACpCM,MAAM,EAAExB,GAAG,CAACiB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MAC/BO,aAAa,EAAEzB,GAAG,CAAC0B,OAAO,CAAC,CAAC,CAACR,QAAQ,CAAC,CAAC;MACvCS,OAAO,EAAE3B,GAAG,CACTe,MAAM,CAAC;QACNa,MAAM,EAAE5B,GAAG,CACRiB,MAAM,CAAC,CAAC,CACRY,KAAK,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,CACrCX,QAAQ,CAAC,CAAC;QACbY,SAAS,EAAE9B,GAAG,CAACiB,MAAM,CAAC,CAAC,CAACc,OAAO,CAAC,CAAC,CAACb,QAAQ,CAAC;MAC7C,CAAC,CAAC,CACDA,QAAQ,CAAC;IACd,CAAC,CAAC,CACDc,OAAO,CAAC,IAAI,CAAC,CACbC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC;IAEpB,IAAI,CAACC,UAAU,GAAGpB,kBAAkB;IACpC;IACA;IACA;IACA,IAAI,CAACqB,WAAW,GAAGrB,kBAAkB,CAACI,QAAQ,CAAC,CAAC;EAClD;;EAEA;AACF;AACA;EACEkB,wBAAwBA,CACtBC,KAA0B,EACA;IAC1B,MAAMC,KAAK,GAAGD,KAAK,CAAC,IAAI,CAACE,IAAI,CAAC;IAC9B,OAAO,IAAI,CAACC,cAAc,CAACF,KAAK,CAAC,GAAGA,KAAK,GAAGG,SAAS;EACvD;EAEAC,yBAAyBA,CAACL,KAA0B,EAAU;IAC5D,MAAMC,KAAK,GAAG,IAAI,CAACF,wBAAwB,CAACC,KAAK,CAAC;IAElD,IAAI,CAACC,KAAK,EAAE;MACV,OAAO,EAAE;IACX;IAEA,OAAO,GAAG/B,cAAc,CAAC+B,KAAK,CAAClB,MAAM,CAAC,MAAMkB,KAAK,CAAChB,WAAW,EAAE;EACjE;EAEAqB,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;;IAErD;IACA,MAAME,YAAY,GAAG,IAAI,CAACP,cAAc,CAACI,OAAO,CAAC,IAAI,CAACL,IAAI,CAAY,CAAC,GAClEK,OAAO,CAAC,IAAI,CAACL,IAAI,CAAC,GACnBE,SAAS;;IAEb;IACA,MAAMrB,MAAM,GAAG2B,YAAY,EAAE3B,MAAM,IAAI,IAAI,CAACP,OAAO,CAACO,MAAM;IAE1D,OAAO;MACL,GAAG0B,SAAS;MACZ1B,MAAM,EAAEb,cAAc,CAACa,MAAM,CAAC;MAC9BE,WAAW,EAAE,IAAI,CAACT,OAAO,CAACS,WAAW;MACrCyB;IACF,CAAC;EACH;;EAEA;AACF;AACA;EACEP,cAAcA,CAACF,KAAc,EAAyB;IACpD,OAAO9B,YAAY,CAACgC,cAAc,CAACF,KAAK,CAAC;EAC3C;;EAEA;AACF;AACA;EACE,OAAOE,cAAcA,CAACF,KAAc,EAAyB;IAC3D,IAAI,CAACA,KAAK,IAAI,OAAOA,KAAK,KAAK,QAAQ,IAAIU,KAAK,CAACC,OAAO,CAACX,KAAK,CAAC,EAAE;MAC/D,OAAO,KAAK;IACd;IAEA,MAAMD,KAAK,GAAGC,KAAqB;IACnC,OACE,OAAOD,KAAK,CAACrB,SAAS,KAAK,QAAQ,IACnC,OAAOqB,KAAK,CAACjB,MAAM,KAAK,QAAQ,IAChC,OAAOiB,KAAK,CAACf,WAAW,KAAK,QAAQ;EAEzC;;EAEA;AACF;AACA;EACE4B,OAAOA,CAACZ,KAAkC,EAAsB;IAC9D,OAAO,IAAI,CAACE,cAAc,CAACF,KAAK,CAAC;EACnC;EAEAa,YAAYA,CAACb,KAAkC,EAAE;IAC/C,OAAO,IAAI,CAACE,cAAc,CAACF,KAAK,CAAC,GAC5BA,KAAK,GACNG,SAAS;EACf;EAEAW,wBAAwBA,CAACf,KAA0B,EAAE;IACnD,OAAO,IAAI,CAACG,cAAc,CAACH,KAAK,CAAC,GAC7B,cAAcA,KAAK,CAAClB,SAAS,aAAaZ,cAAc,CAAC8B,KAAK,CAACjB,MAAM,CAAC,EAAE,GACxE,EAAE;EACR;;EAEA;AACF;AACA;EACEiC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO7C,YAAY,CAAC6C,oBAAoB,CAAC,CAAC;EAC5C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QACEC,IAAI,EAAE,iBAAiB;QACvBC,QAAQ,EAAE;MACZ,CAAC,CACF;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;;EAEA;AACF;AACA;EACE,aAAaC,UAAUA,CACrBC,OAA2B,EAC3BC,CAAsB,EACtBC,IAA2B,EACT;IAClB,MAAM;MAAEhD,OAAO;MAAE0B,IAAI,EAAEuB;IAAc,CAAC,GAAGD,IAAI,CAACE,SAAS;IACvD,MAAM;MAAEC;IAAM,CAAC,GAAGH,IAAI,CAACI,UAAU;IAEjC,MAAM5B,KAAK,GAAG,MAAMwB,IAAI,CAACI,UAAU,CAACC,QAAQ,CAACP,OAAO,CAAC;IACrD,MAAM;MAAEQ;IAAQ,CAAC,GAAGjE,gBAAgB,CAACyD,OAAO,CAACS,MAAM,CAAC;IACpD,MAAMC,UAAU,GAAG,GAAGF,OAAO,IAAIH,KAAK,CAACM,QAAQ,UAAU;IAEzD,MAAMC,oBAAoB,GAAGlC,KAAK,CAACyB,aAAa,CAAC;IACjD,IACEtD,YAAY,CAACgC,cAAc,CAAC+B,oBAAoB,CAAC,IACjDA,oBAAoB,CAAC5C,OAAO,EAAEC,MAAM,KAAK,SAAS,EAClD;MACA,OAAOgC,CAAC,CAACY,QAAQ,CAACH,UAAU,CAAC,CAACI,IAAI,CAAC1E,WAAW,CAAC2E,SAAS,CAAC;IAC3D;IAEA,MAAMjD,aAAa,GAAGoC,IAAI,CAACc,MAAM,IAAI,CAACd,IAAI,CAACe,SAAS;IACpD,MAAMpD,MAAM,GAAGqC,IAAI,CAACI,UAAU,CAACD,KAAK,CAACxC,MAAM;IAC3C,MAAMqD,cAAc,GAAGvE,oBAAoB,CAACmB,aAAa,EAAED,MAAM,CAAC;IAElE,MAAMD,IAAI,GAAGzB,UAAU,CAAC,CAAC;IAEzB,MAAMqB,SAAS,GAAGkB,KAAK,CAACyC,mBAA6B;IACrD,MAAM1D,MAAM,GAAGP,OAAO,CAACO,MAAM;IAE7B,MAAME,WAAW,GAAGT,OAAO,CAACS,WAAW;IAEvC,MAAMyD,IAAI,GAAG,IAAIf,KAAK,CAACM,QAAQ,EAAE;IAEjC,MAAMU,cAAc,GAAG,GAAGb,OAAO,0BAA0B5C,IAAI,EAAE;IACjE,MAAM0D,cAAc,GAAGpB,IAAI,CAACqB,SAAS;IAErC,MAAMC,aAAa,GAAGC,IAAI,CAACC,KAAK,CAACjE,MAAM,GAAG,GAAG,CAAC;IAC9C,MAAMkE,OAAO,GAAG,MAAMT,cAAc,CAACU,aAAa,CAChDJ,aAAa,EACb7D,WAAW,EACX0D,cAAc,EACd7D,SAAS,EACTM,aAAa,EACb;MAAED,MAAM;MAAEuD;IAAK,CACjB,CAAC;IAED,MAAMS,WAA+B,GAAG;MACtCjE,IAAI;MACJC,MAAM;MACNL,SAAS;MACTC,MAAM;MACNE,WAAW;MACXN,SAAS,EAAEsE,OAAO,CAACtE,SAAS;MAC5B8C,aAAa;MACb2B,SAAS,EAAEpB,UAAU;MACrBqB,UAAU,EAAET,cAAc;MAC1BxD;IACF,CAAC;IAEDkC,OAAO,CAACgC,GAAG,CAACC,GAAG,CAAC,WAAWrE,IAAI,EAAE,EAAEiE,WAAW,CAAC;IAE/C,OAAO5B,CAAC,CAACY,QAAQ,CAACc,OAAO,CAACO,UAAU,CAAC,CAACpB,IAAI,CAAC1E,WAAW,CAAC2E,SAAS,CAAC;EACnE;;EAEA;AACF;AACA;AACA;EACE,MAAMoB,QAAQA,CACZnC,OAA2B,EAC3BoC,SAAuB,EACvBC,OAAoB,EACL;IACf,MAAMjD,YAAY,GAAG,IAAI,CAACX,wBAAwB,CAAC4D,OAAO,CAAC3D,KAAK,CAAC;IAEjE,IAAI,CAACU,YAAY,EAAE;MACjB,MAAM,IAAI3C,mBAAmB,CAC3B,IAAI,EACJ,kCAAkC,EAClC,IAAI,EACJD,iBAAiB,CAAC8F,iBACpB,CAAC;IACH;IAEA,IAAIlD,YAAY,CAACmD,OAAO,EAAEtE,MAAM,KAAK,SAAS,EAAE;MAC9C;IACF;IAEA,MAAM;MAAEZ,SAAS;MAAES,aAAa;MAAED;IAAO,CAAC,GAAGuB,YAAY;IACzD,MAAM8B,cAAc,GAAGvE,oBAAoB,CAACmB,aAAa,EAAED,MAAM,CAAC;;IAElE;AACJ;AACA;IACI,MAAMI,MAAM,GAAG,MAAMiD,cAAc,CAACsB,gBAAgB,CAClDnF,SAAS,EACTS,aACF,CAAC;IAEDpB,sBAAsB,CAAC+F,kBAAkB,CACvCxE,MAAM,CAACR,MAAM,EACb,IAAI,CAACP,OAAO,CAACO,MAAM,EACnB,IACF,CAAC;IAED,IAAIQ,MAAM,CAACS,KAAK,CAACT,MAAM,KAAK,SAAS,EAAE;MACrC,MAAM,IAAI,CAACyE,mBAAmB,CAAC1C,OAAO,EAAEZ,YAAY,CAAC;MACrD;IACF;IAEA,IAAInB,MAAM,CAACS,KAAK,CAACT,MAAM,KAAK,YAAY,EAAE;MACxC,MAAM,IAAIxB,mBAAmB,CAC3B,IAAI,EACJ,gFAAgF,EAChF,IAAI,EACJD,iBAAiB,CAACmG,cACpB,CAAC;IACH;IAEA,MAAMC,QAAQ,GAAG,MAAM1B,cAAc,CAAC2B,cAAc,CAClDxF,SAAS,EACTY,MAAM,CAACR,MACT,CAAC;IAED,IAAI,CAACmF,QAAQ,EAAE;MACb,MAAM,IAAInG,mBAAmB,CAC3B,IAAI,EACJ,qFAAqF,EACrF,KACF,CAAC;IACH;IAEA,MAAM,IAAI,CAACiG,mBAAmB,CAAC1C,OAAO,EAAEZ,YAAY,CAAC;EACvD;;EAEA;AACF;AACA;AACA;EACE,MAAcsD,mBAAmBA,CAC/B1C,OAA2B,EAC3BZ,YAA0B,EACX;IACf,MAAM0D,YAA0B,GAAG;MACjC,GAAG1D,YAAY;MACfmD,OAAO,EAAE;QACPtE,MAAM,EAAE,SAAS;QACjBE,SAAS,EAAE,IAAI4E,IAAI,CAAC,CAAC,CAACC,WAAW,CAAC;MACpC;IACF,CAAC;IAED,IAAI,IAAI,CAACC,IAAI,EAAE;MACb,MAAMC,YAAY,GAAG,MAAM,IAAI,CAACD,IAAI,CAAC1C,QAAQ,CAACP,OAAO,CAAC;MACtD,MAAM,IAAI,CAACiD,IAAI,CAACE,UAAU,CAACnD,OAAO,EAAEkD,YAAY,EAAE;QAChD,CAAC,IAAI,CAACtE,IAAI,GAAGkE;MACf,CAAC,CAAC;IACJ;EACF;AACF;;AAiBA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/engine/routes/payment-helper.d.ts

@@ -9,6 +9,28 @@ export function getPaymentContext(request: Request, uuid: string): Promise<{
     sessionKey: string;
     paymentStatus: GetPaymentResponse;
 }>;
+/**
+ * Builds an object for logging payment information
+ * @param {string} action
+ * @param {string} outcome
+ * @param {string} reason
+ * @param {boolean} isLivePayment
+ * @param {string} paymentId
+ */
+export function buildPaymentInfo(action: string, outcome: string, reason: string, isLivePayment: boolean, paymentId: string): {
+    event: {
+        category: string;
+        action: string;
+        outcome: string;
+        reason: string;
+        type: string;
+        reference: string;
+    };
+};
+/**
+ * @param {number} amount
+ */
+export function convertPenceToPounds(amount: number): string;
 import type { Request } from '@hapi/hapi';
 import type { PaymentSessionData } from '~/src/server/plugins/payment/types.js';
 import type { GetPaymentResponse } from '~/src/server/plugins/payment/types.js';

package/.server/server/plugins/engine/routes/payment-helper.js

@@ -26,7 +26,7 @@ export async function getPaymentContext(request, uuid) {
   }
   const apiKey = getPaymentApiKey(isLivePayment, formId);
   const paymentService = new PaymentService(apiKey);
-  const paymentStatus = await paymentService.getPaymentStatus(paymentId);
+  const paymentStatus = await paymentService.getPaymentStatus(paymentId, isLivePayment);
   return {
     session,
     sessionKey,
@@ -34,6 +34,34 @@ export async function getPaymentContext(request, uuid) {
   };
 }
 
+/**
+ * Builds an object for logging payment information
+ * @param {string} action
+ * @param {string} outcome
+ * @param {string} reason
+ * @param {boolean} isLivePayment
+ * @param {string} paymentId
+ */
+export function buildPaymentInfo(action, outcome, reason, isLivePayment, paymentId) {
+  return {
+    event: {
+      category: 'payment',
+      action,
+      outcome,
+      reason,
+      type: isLivePayment ? 'live' : 'test',
+      reference: paymentId
+    }
+  };
+}
+
+/**
+ * @param {number} amount
+ */
+export function convertPenceToPounds(amount) {
+  return `${amount / 100}`;
+}
+
 /**
  * @import { Request } from '@hapi/hapi'
  * @import { GetPaymentResponse, PaymentSessionData } from '~/src/server/plugins/payment/types.js'

package/.server/server/plugins/engine/routes/payment-helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"payment-helper.js","names":["Boom","PAYMENT_SESSION_PREFIX","getPaymentApiKey","PaymentService","getPaymentContext","request","uuid","sessionKey","session","yar","get","badRequest","paymentId","isLivePayment","formId","apiKey","paymentService","paymentStatus","getPaymentStatus"],"sources":["../../../../../src/server/plugins/engine/routes/payment-helper.js"],"sourcesContent":["import Boom from '@hapi/boom'\n\nimport { PAYMENT_SESSION_PREFIX } from '~/src/server/plugins/engine/routes/payment.js'\nimport { getPaymentApiKey } from '~/src/server/plugins/payment/helper.js'\nimport { PaymentService } from '~/src/server/plugins/payment/service.js'\n\n/**\n * Validates session data and retrieves payment status\n * @param {Request} request - the request\n * @param {string} uuid - the payment UUID\n * @returns {Promise<{ session: PaymentSessionData, sessionKey: string, paymentStatus: GetPaymentResponse }>}\n */\nexport async function getPaymentContext(request, uuid) {\n  const sessionKey = `${PAYMENT_SESSION_PREFIX}${uuid}`\n  const session = /** @type {PaymentSessionData | null} */ (\n    request.yar.get(sessionKey)\n  )\n\n  if (!session) {\n    throw Boom.badRequest(`No payment session found for uuid=${uuid}`)\n  }\n\n  const { paymentId, isLivePayment, formId } = session\n\n  if (!paymentId) {\n    throw Boom.badRequest('No paymentId in session')\n  }\n\n  const apiKey = getPaymentApiKey(isLivePayment, formId)\n  const paymentService = new PaymentService(apiKey)\n  const paymentStatus = await paymentService.getPaymentStatus(paymentId)\n\n  return { session, sessionKey, paymentStatus }\n}\n\n/**\n * @import { Request } from '@hapi/hapi'\n * @import { GetPaymentResponse, PaymentSessionData } from '~/src/server/plugins/payment/types.js'\n */\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAE7B,SAASC,sBAAsB;AAC/B,SAASC,gBAAgB;AACzB,SAASC,cAAc;;AAEvB;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,iBAAiBA,CAACC,OAAO,EAAEC,IAAI,EAAE;EACrD,MAAMC,UAAU,GAAG,GAAGN,sBAAsB,GAAGK,IAAI,EAAE;EACrD,MAAME,OAAO,GAAG;EACdH,OAAO,CAACI,GAAG,CAACC,GAAG,CAACH,UAAU,CAC3B;EAED,IAAI,CAACC,OAAO,EAAE;IACZ,MAAMR,IAAI,CAACW,UAAU,CAAC,qCAAqCL,IAAI,EAAE,CAAC;EACpE;EAEA,MAAM;IAAEM,SAAS;IAAEC,aAAa;IAAEC;EAAO,CAAC,GAAGN,OAAO;EAEpD,IAAI,CAACI,SAAS,EAAE;IACd,MAAMZ,IAAI,CAACW,UAAU,CAAC,yBAAyB,CAAC;EAClD;EAEA,MAAMI,MAAM,GAAGb,gBAAgB,CAACW,aAAa,EAAEC,MAAM,CAAC;EACtD,MAAME,cAAc,GAAG,IAAIb,cAAc,CAACY,MAAM,CAAC;EACjD,MAAME,aAAa,GAAG,MAAMD,cAAc,CAACE,gBAAgB,CAACN,SAAS,CAAC;EAEtE,OAAO;IAAEJ,OAAO;IAAED,UAAU;IAAEU;EAAc,CAAC;AAC/C;;AAEA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"payment-helper.js","names":["Boom","PAYMENT_SESSION_PREFIX","getPaymentApiKey","PaymentService","getPaymentContext","request","uuid","sessionKey","session","yar","get","badRequest","paymentId","isLivePayment","formId","apiKey","paymentService","paymentStatus","getPaymentStatus","buildPaymentInfo","action","outcome","reason","event","category","type","reference","convertPenceToPounds","amount"],"sources":["../../../../../src/server/plugins/engine/routes/payment-helper.js"],"sourcesContent":["import Boom from '@hapi/boom'\n\nimport { PAYMENT_SESSION_PREFIX } from '~/src/server/plugins/engine/routes/payment.js'\nimport { getPaymentApiKey } from '~/src/server/plugins/payment/helper.js'\nimport { PaymentService } from '~/src/server/plugins/payment/service.js'\n\n/**\n * Validates session data and retrieves payment status\n * @param {Request} request - the request\n * @param {string} uuid - the payment UUID\n * @returns {Promise<{ session: PaymentSessionData, sessionKey: string, paymentStatus: GetPaymentResponse }>}\n */\nexport async function getPaymentContext(request, uuid) {\n  const sessionKey = `${PAYMENT_SESSION_PREFIX}${uuid}`\n  const session = /** @type {PaymentSessionData | null} */ (\n    request.yar.get(sessionKey)\n  )\n\n  if (!session) {\n    throw Boom.badRequest(`No payment session found for uuid=${uuid}`)\n  }\n\n  const { paymentId, isLivePayment, formId } = session\n\n  if (!paymentId) {\n    throw Boom.badRequest('No paymentId in session')\n  }\n\n  const apiKey = getPaymentApiKey(isLivePayment, formId)\n  const paymentService = new PaymentService(apiKey)\n  const paymentStatus = await paymentService.getPaymentStatus(\n    paymentId,\n    isLivePayment\n  )\n\n  return { session, sessionKey, paymentStatus }\n}\n\n/**\n * Builds an object for logging payment information\n * @param {string} action\n * @param {string} outcome\n * @param {string} reason\n * @param {boolean} isLivePayment\n * @param {string} paymentId\n */\nexport function buildPaymentInfo(\n  action,\n  outcome,\n  reason,\n  isLivePayment,\n  paymentId\n) {\n  return {\n    event: {\n      category: 'payment',\n      action,\n      outcome,\n      reason,\n      type: isLivePayment ? 'live' : 'test',\n      reference: paymentId\n    }\n  }\n}\n\n/**\n * @param {number} amount\n */\nexport function convertPenceToPounds(amount) {\n  return `${amount / 100}`\n}\n\n/**\n * @import { Request } from '@hapi/hapi'\n * @import { GetPaymentResponse, PaymentSessionData } from '~/src/server/plugins/payment/types.js'\n */\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAE7B,SAASC,sBAAsB;AAC/B,SAASC,gBAAgB;AACzB,SAASC,cAAc;;AAEvB;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,iBAAiBA,CAACC,OAAO,EAAEC,IAAI,EAAE;EACrD,MAAMC,UAAU,GAAG,GAAGN,sBAAsB,GAAGK,IAAI,EAAE;EACrD,MAAME,OAAO,GAAG;EACdH,OAAO,CAACI,GAAG,CAACC,GAAG,CAACH,UAAU,CAC3B;EAED,IAAI,CAACC,OAAO,EAAE;IACZ,MAAMR,IAAI,CAACW,UAAU,CAAC,qCAAqCL,IAAI,EAAE,CAAC;EACpE;EAEA,MAAM;IAAEM,SAAS;IAAEC,aAAa;IAAEC;EAAO,CAAC,GAAGN,OAAO;EAEpD,IAAI,CAACI,SAAS,EAAE;IACd,MAAMZ,IAAI,CAACW,UAAU,CAAC,yBAAyB,CAAC;EAClD;EAEA,MAAMI,MAAM,GAAGb,gBAAgB,CAACW,aAAa,EAAEC,MAAM,CAAC;EACtD,MAAME,cAAc,GAAG,IAAIb,cAAc,CAACY,MAAM,CAAC;EACjD,MAAME,aAAa,GAAG,MAAMD,cAAc,CAACE,gBAAgB,CACzDN,SAAS,EACTC,aACF,CAAC;EAED,OAAO;IAAEL,OAAO;IAAED,UAAU;IAAEU;EAAc,CAAC;AAC/C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,gBAAgBA,CAC9BC,MAAM,EACNC,OAAO,EACPC,MAAM,EACNT,aAAa,EACbD,SAAS,EACT;EACA,OAAO;IACLW,KAAK,EAAE;MACLC,QAAQ,EAAE,SAAS;MACnBJ,MAAM;MACNC,OAAO;MACPC,MAAM;MACNG,IAAI,EAAEZ,aAAa,GAAG,MAAM,GAAG,MAAM;MACrCa,SAAS,EAAEd;IACb;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA,OAAO,SAASe,oBAAoBA,CAACC,MAAM,EAAE;EAC3C,OAAO,GAAGA,MAAM,GAAG,GAAG,EAAE;AAC1B;;AAEA;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/engine/routes/payment-helper.test.js

@@ -1,4 +1,4 @@
-import { getPaymentContext } from "./payment-helper.js";
+import { buildPaymentInfo, getPaymentContext } from "./payment-helper.js";
 import { get } from "../../../services/httpService.js";
 jest.mock("../../../services/httpService.ts");
 describe('payment helper', () => {
@@ -73,6 +73,32 @@ describe('payment helper', () => {
       sessionKey: 'payment-5a54c2fe-da49-4202-8cd3-2121eaca03c3'
     });
   });
+  it('should create logging info for a test payment', () => {
+    const res = buildPaymentInfo('action1', 'outcome1', 'reason1', false, 'pay-123');
+    expect(res).toEqual({
+      event: {
+        category: 'payment',
+        action: 'action1',
+        outcome: 'outcome1',
+        reason: 'reason1',
+        type: 'test',
+        reference: 'pay-123'
+      }
+    });
+  });
+  it('should create logging info for a live payment', () => {
+    const res = buildPaymentInfo('action2', 'outcome2', 'reason2', true, 'pay-123');
+    expect(res).toEqual({
+      event: {
+        category: 'payment',
+        action: 'action2',
+        outcome: 'outcome2',
+        reason: 'reason2',
+        type: 'live',
+        reference: 'pay-123'
+      }
+    });
+  });
 });
 
 /**

package/.server/server/plugins/engine/routes/payment-helper.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"payment-helper.test.js","names":["getPaymentContext","get","jest","mock","describe","uuid","it","mockRequest","yar","fn","mockReturnValueOnce","undefined","expect","rejects","toThrow","paymentId","isLivePayment","formId","getPaymentStatusApiResult","payment_id","_links","next_url","href","state","status","mocked","mockResolvedValueOnce","res","statusCode","headers","payload","error","toEqual","paymentStatus","session","sessionKey"],"sources":["../../../../../src/server/plugins/engine/routes/payment-helper.test.js"],"sourcesContent":["import { getPaymentContext } from '~/src/server/plugins/engine/routes/payment-helper.js'\nimport { get } from '~/src/server/services/httpService.js'\n\njest.mock('~/src/server/services/httpService.ts')\n\ndescribe('payment helper', () => {\n  const uuid = '5a54c2fe-da49-4202-8cd3-2121eaca03c3'\n  it('should throw if no session', async () => {\n    const mockRequest = {\n      yar: {\n        get: jest.fn().mockReturnValueOnce(undefined)\n      }\n    }\n    // @ts-expect-error - partial request mock\n    await expect(() => getPaymentContext(mockRequest, uuid)).rejects.toThrow(\n      'No payment session found for uuid=5a54c2fe-da49-4202-8cd3-2121eaca03c3'\n    )\n  })\n\n  it('should throw if no payment id', async () => {\n    const mockRequest = {\n      yar: {\n        get: jest.fn().mockReturnValueOnce({})\n      }\n    }\n    // @ts-expect-error - partial request mock\n    await expect(() => getPaymentContext(mockRequest, uuid)).rejects.toThrow(\n      'No paymentId in session'\n    )\n  })\n\n  it('should get context successfully', async () => {\n    const mockRequest = {\n      yar: {\n        get: jest.fn().mockReturnValueOnce({\n          paymentId: 'payment-id',\n          isLivePayment: false,\n          formId: 'formid'\n        })\n      }\n    }\n\n    const getPaymentStatusApiResult = {\n      payment_id: 'payment-id-12345',\n      _links: {\n        next_url: {\n          href: 'http://next-url-href/payment'\n        }\n      },\n      state: {\n        status: 'created'\n      }\n    }\n\n    jest.mocked(get).mockResolvedValueOnce({\n      res: /** @type {IncomingMessage} */ ({\n        statusCode: 200,\n        headers: {}\n      }),\n      payload: getPaymentStatusApiResult,\n      error: undefined\n    })\n\n    // @ts-expect-error - partial request mock\n    const res = await getPaymentContext(mockRequest, uuid)\n    expect(res).toEqual({\n      paymentStatus: {\n        paymentId: 'payment-id-12345',\n        _links: {\n          next_url: {\n            href: 'http://next-url-href/payment'\n          }\n        },\n        state: {\n          status: 'created'\n        }\n      },\n      session: {\n        formId: 'formid',\n        isLivePayment: false,\n        paymentId: 'payment-id'\n      },\n      sessionKey: 'payment-5a54c2fe-da49-4202-8cd3-2121eaca03c3'\n    })\n  })\n})\n\n/**\n * @import  { IncomingMessage } from 'node:http'\n */\n"],"mappings":"AAAA,SAASA,iBAAiB;AAC1B,SAASC,GAAG;AAEZC,IAAI,CAACC,IAAI,mCAAuC,CAAC;AAEjDC,QAAQ,CAAC,gBAAgB,EAAE,MAAM;EAC/B,MAAMC,IAAI,GAAG,sCAAsC;EACnDC,EAAE,CAAC,4BAA4B,EAAE,YAAY;IAC3C,MAAMC,WAAW,GAAG;MAClBC,GAAG,EAAE;QACHP,GAAG,EAAEC,IAAI,CAACO,EAAE,CAAC,CAAC,CAACC,mBAAmB,CAACC,SAAS;MAC9C;IACF,CAAC;IACD;IACA,MAAMC,MAAM,CAAC,MAAMZ,iBAAiB,CAACO,WAAW,EAAEF,IAAI,CAAC,CAAC,CAACQ,OAAO,CAACC,OAAO,CACtE,wEACF,CAAC;EACH,CAAC,CAAC;EAEFR,EAAE,CAAC,+BAA+B,EAAE,YAAY;IAC9C,MAAMC,WAAW,GAAG;MAClBC,GAAG,EAAE;QACHP,GAAG,EAAEC,IAAI,CAACO,EAAE,CAAC,CAAC,CAACC,mBAAmB,CAAC,CAAC,CAAC;MACvC;IACF,CAAC;IACD;IACA,MAAME,MAAM,CAAC,MAAMZ,iBAAiB,CAACO,WAAW,EAAEF,IAAI,CAAC,CAAC,CAACQ,OAAO,CAACC,OAAO,CACtE,yBACF,CAAC;EACH,CAAC,CAAC;EAEFR,EAAE,CAAC,iCAAiC,EAAE,YAAY;IAChD,MAAMC,WAAW,GAAG;MAClBC,GAAG,EAAE;QACHP,GAAG,EAAEC,IAAI,CAACO,EAAE,CAAC,CAAC,CAACC,mBAAmB,CAAC;UACjCK,SAAS,EAAE,YAAY;UACvBC,aAAa,EAAE,KAAK;UACpBC,MAAM,EAAE;QACV,CAAC;MACH;IACF,CAAC;IAED,MAAMC,yBAAyB,GAAG;MAChCC,UAAU,EAAE,kBAAkB;MAC9BC,MAAM,EAAE;QACNC,QAAQ,EAAE;UACRC,IAAI,EAAE;QACR;MACF,CAAC;MACDC,KAAK,EAAE;QACLC,MAAM,EAAE;MACV;IACF,CAAC;IAEDtB,IAAI,CAACuB,MAAM,CAACxB,GAAG,CAAC,CAACyB,qBAAqB,CAAC;MACrCC,GAAG,GAAE,8BAAgC;QACnCC,UAAU,EAAE,GAAG;QACfC,OAAO,EAAE,CAAC;MACZ,CAAC,CAAC;MACFC,OAAO,EAAEZ,yBAAyB;MAClCa,KAAK,EAAEpB;IACT,CAAC,CAAC;;IAEF;IACA,MAAMgB,GAAG,GAAG,MAAM3B,iBAAiB,CAACO,WAAW,EAAEF,IAAI,CAAC;IACtDO,MAAM,CAACe,GAAG,CAAC,CAACK,OAAO,CAAC;MAClBC,aAAa,EAAE;QACblB,SAAS,EAAE,kBAAkB;QAC7BK,MAAM,EAAE;UACNC,QAAQ,EAAE;YACRC,IAAI,EAAE;UACR;QACF,CAAC;QACDC,KAAK,EAAE;UACLC,MAAM,EAAE;QACV;MACF,CAAC;MACDU,OAAO,EAAE;QACPjB,MAAM,EAAE,QAAQ;QAChBD,aAAa,EAAE,KAAK;QACpBD,SAAS,EAAE;MACb,CAAC;MACDoB,UAAU,EAAE;IACd,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"payment-helper.test.js","names":["buildPaymentInfo","getPaymentContext","get","jest","mock","describe","uuid","it","mockRequest","yar","fn","mockReturnValueOnce","undefined","expect","rejects","toThrow","paymentId","isLivePayment","formId","getPaymentStatusApiResult","payment_id","_links","next_url","href","state","status","mocked","mockResolvedValueOnce","res","statusCode","headers","payload","error","toEqual","paymentStatus","session","sessionKey","event","category","action","outcome","reason","type","reference"],"sources":["../../../../../src/server/plugins/engine/routes/payment-helper.test.js"],"sourcesContent":["import {\n  buildPaymentInfo,\n  getPaymentContext\n} from '~/src/server/plugins/engine/routes/payment-helper.js'\nimport { get } from '~/src/server/services/httpService.js'\n\njest.mock('~/src/server/services/httpService.ts')\n\ndescribe('payment helper', () => {\n  const uuid = '5a54c2fe-da49-4202-8cd3-2121eaca03c3'\n  it('should throw if no session', async () => {\n    const mockRequest = {\n      yar: {\n        get: jest.fn().mockReturnValueOnce(undefined)\n      }\n    }\n    // @ts-expect-error - partial request mock\n    await expect(() => getPaymentContext(mockRequest, uuid)).rejects.toThrow(\n      'No payment session found for uuid=5a54c2fe-da49-4202-8cd3-2121eaca03c3'\n    )\n  })\n\n  it('should throw if no payment id', async () => {\n    const mockRequest = {\n      yar: {\n        get: jest.fn().mockReturnValueOnce({})\n      }\n    }\n    // @ts-expect-error - partial request mock\n    await expect(() => getPaymentContext(mockRequest, uuid)).rejects.toThrow(\n      'No paymentId in session'\n    )\n  })\n\n  it('should get context successfully', async () => {\n    const mockRequest = {\n      yar: {\n        get: jest.fn().mockReturnValueOnce({\n          paymentId: 'payment-id',\n          isLivePayment: false,\n          formId: 'formid'\n        })\n      }\n    }\n\n    const getPaymentStatusApiResult = {\n      payment_id: 'payment-id-12345',\n      _links: {\n        next_url: {\n          href: 'http://next-url-href/payment'\n        }\n      },\n      state: {\n        status: 'created'\n      }\n    }\n\n    jest.mocked(get).mockResolvedValueOnce({\n      res: /** @type {IncomingMessage} */ ({\n        statusCode: 200,\n        headers: {}\n      }),\n      payload: getPaymentStatusApiResult,\n      error: undefined\n    })\n\n    // @ts-expect-error - partial request mock\n    const res = await getPaymentContext(mockRequest, uuid)\n    expect(res).toEqual({\n      paymentStatus: {\n        paymentId: 'payment-id-12345',\n        _links: {\n          next_url: {\n            href: 'http://next-url-href/payment'\n          }\n        },\n        state: {\n          status: 'created'\n        }\n      },\n      session: {\n        formId: 'formid',\n        isLivePayment: false,\n        paymentId: 'payment-id'\n      },\n      sessionKey: 'payment-5a54c2fe-da49-4202-8cd3-2121eaca03c3'\n    })\n  })\n\n  it('should create logging info for a test payment', () => {\n    const res = buildPaymentInfo(\n      'action1',\n      'outcome1',\n      'reason1',\n      false,\n      'pay-123'\n    )\n    expect(res).toEqual({\n      event: {\n        category: 'payment',\n        action: 'action1',\n        outcome: 'outcome1',\n        reason: 'reason1',\n        type: 'test',\n        reference: 'pay-123'\n      }\n    })\n  })\n\n  it('should create logging info for a live payment', () => {\n    const res = buildPaymentInfo(\n      'action2',\n      'outcome2',\n      'reason2',\n      true,\n      'pay-123'\n    )\n    expect(res).toEqual({\n      event: {\n        category: 'payment',\n        action: 'action2',\n        outcome: 'outcome2',\n        reason: 'reason2',\n        type: 'live',\n        reference: 'pay-123'\n      }\n    })\n  })\n})\n\n/**\n * @import  { IncomingMessage } from 'node:http'\n */\n"],"mappings":"AAAA,SACEA,gBAAgB,EAChBC,iBAAiB;AAEnB,SAASC,GAAG;AAEZC,IAAI,CAACC,IAAI,mCAAuC,CAAC;AAEjDC,QAAQ,CAAC,gBAAgB,EAAE,MAAM;EAC/B,MAAMC,IAAI,GAAG,sCAAsC;EACnDC,EAAE,CAAC,4BAA4B,EAAE,YAAY;IAC3C,MAAMC,WAAW,GAAG;MAClBC,GAAG,EAAE;QACHP,GAAG,EAAEC,IAAI,CAACO,EAAE,CAAC,CAAC,CAACC,mBAAmB,CAACC,SAAS;MAC9C;IACF,CAAC;IACD;IACA,MAAMC,MAAM,CAAC,MAAMZ,iBAAiB,CAACO,WAAW,EAAEF,IAAI,CAAC,CAAC,CAACQ,OAAO,CAACC,OAAO,CACtE,wEACF,CAAC;EACH,CAAC,CAAC;EAEFR,EAAE,CAAC,+BAA+B,EAAE,YAAY;IAC9C,MAAMC,WAAW,GAAG;MAClBC,GAAG,EAAE;QACHP,GAAG,EAAEC,IAAI,CAACO,EAAE,CAAC,CAAC,CAACC,mBAAmB,CAAC,CAAC,CAAC;MACvC;IACF,CAAC;IACD;IACA,MAAME,MAAM,CAAC,MAAMZ,iBAAiB,CAACO,WAAW,EAAEF,IAAI,CAAC,CAAC,CAACQ,OAAO,CAACC,OAAO,CACtE,yBACF,CAAC;EACH,CAAC,CAAC;EAEFR,EAAE,CAAC,iCAAiC,EAAE,YAAY;IAChD,MAAMC,WAAW,GAAG;MAClBC,GAAG,EAAE;QACHP,GAAG,EAAEC,IAAI,CAACO,EAAE,CAAC,CAAC,CAACC,mBAAmB,CAAC;UACjCK,SAAS,EAAE,YAAY;UACvBC,aAAa,EAAE,KAAK;UACpBC,MAAM,EAAE;QACV,CAAC;MACH;IACF,CAAC;IAED,MAAMC,yBAAyB,GAAG;MAChCC,UAAU,EAAE,kBAAkB;MAC9BC,MAAM,EAAE;QACNC,QAAQ,EAAE;UACRC,IAAI,EAAE;QACR;MACF,CAAC;MACDC,KAAK,EAAE;QACLC,MAAM,EAAE;MACV;IACF,CAAC;IAEDtB,IAAI,CAACuB,MAAM,CAACxB,GAAG,CAAC,CAACyB,qBAAqB,CAAC;MACrCC,GAAG,GAAE,8BAAgC;QACnCC,UAAU,EAAE,GAAG;QACfC,OAAO,EAAE,CAAC;MACZ,CAAC,CAAC;MACFC,OAAO,EAAEZ,yBAAyB;MAClCa,KAAK,EAAEpB;IACT,CAAC,CAAC;;IAEF;IACA,MAAMgB,GAAG,GAAG,MAAM3B,iBAAiB,CAACO,WAAW,EAAEF,IAAI,CAAC;IACtDO,MAAM,CAACe,GAAG,CAAC,CAACK,OAAO,CAAC;MAClBC,aAAa,EAAE;QACblB,SAAS,EAAE,kBAAkB;QAC7BK,MAAM,EAAE;UACNC,QAAQ,EAAE;YACRC,IAAI,EAAE;UACR;QACF,CAAC;QACDC,KAAK,EAAE;UACLC,MAAM,EAAE;QACV;MACF,CAAC;MACDU,OAAO,EAAE;QACPjB,MAAM,EAAE,QAAQ;QAChBD,aAAa,EAAE,KAAK;QACpBD,SAAS,EAAE;MACb,CAAC;MACDoB,UAAU,EAAE;IACd,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF7B,EAAE,CAAC,+CAA+C,EAAE,MAAM;IACxD,MAAMqB,GAAG,GAAG5B,gBAAgB,CAC1B,SAAS,EACT,UAAU,EACV,SAAS,EACT,KAAK,EACL,SACF,CAAC;IACDa,MAAM,CAACe,GAAG,CAAC,CAACK,OAAO,CAAC;MAClBI,KAAK,EAAE;QACLC,QAAQ,EAAE,SAAS;QACnBC,MAAM,EAAE,SAAS;QACjBC,OAAO,EAAE,UAAU;QACnBC,MAAM,EAAE,SAAS;QACjBC,IAAI,EAAE,MAAM;QACZC,SAAS,EAAE;MACb;IACF,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFpC,EAAE,CAAC,+CAA+C,EAAE,MAAM;IACxD,MAAMqB,GAAG,GAAG5B,gBAAgB,CAC1B,SAAS,EACT,UAAU,EACV,SAAS,EACT,IAAI,EACJ,SACF,CAAC;IACDa,MAAM,CAACe,GAAG,CAAC,CAACK,OAAO,CAAC;MAClBI,KAAK,EAAE;QACLC,QAAQ,EAAE,SAAS;QACnBC,MAAM,EAAE,SAAS;QACjBC,OAAO,EAAE,UAAU;QACnBC,MAAM,EAAE,SAAS;QACjBC,IAAI,EAAE,MAAM;QACZC,SAAS,EAAE;MACb;IACF,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/engine/routes/payment.js

@@ -1,10 +1,12 @@
 import Boom from '@hapi/boom';
 import { StatusCodes } from 'http-status-codes';
 import Joi from 'joi';
+import { createLogger } from "../../../common/helpers/logging/logger.js";
 import { EXTERNAL_STATE_APPENDAGE } from "../../../constants.js";
-import { getPaymentContext } from "./payment-helper.js";
+import { buildPaymentInfo, convertPenceToPounds, getPaymentContext } from "./payment-helper.js";
 export const PAYMENT_RETURN_PATH = '/payment-callback';
 export const PAYMENT_SESSION_PREFIX = 'payment-';
+const logger = createLogger();
 
 /**
  * Flash form component state after successful payment
@@ -45,6 +47,24 @@ export function getRoutes() {
   return [getReturnRoute()];
 }
 
+/**
+ * Logs successful payment
+ * @param {PaymentSessionData} session - the session data
+ * @param {GetPaymentResponse} paymentStatus - the payment status from GOV.UK Pay
+ */
+function logPaymentSuccess(session, paymentStatus) {
+  logger.info(buildPaymentInfo('pre-auth', 'success', `${paymentStatus.state.status} amount=${convertPenceToPounds(paymentStatus.amount)}`, session.isLivePayment, paymentStatus.paymentId), `[payment] Successful pre-auth for paymentId=${paymentStatus.paymentId}`);
+}
+
+/**
+ * Logs failed/cancelled payment
+ * @param {PaymentSessionData} session - the session data
+ * @param {GetPaymentResponse} paymentStatus - the payment status from GOV.UK Pay
+ */
+function logPaymentFailure(session, paymentStatus) {
+  logger.info(buildPaymentInfo('pre-auth', 'failed/cancelled', `${paymentStatus.state.status} amount=${convertPenceToPounds(paymentStatus.amount)}`, session.isLivePayment, paymentStatus.paymentId), `[payment] Failed/cancelled pre-auth for paymentId=${paymentStatus.paymentId}`);
+}
+
 /**
  * Handles successful payment states (capturable/success)
  * @param {Request} request - the request
@@ -99,10 +119,12 @@ function getReturnRoute() {
       switch (status) {
         case 'capturable':
         case 'success':
+          logPaymentSuccess(session, paymentStatus);
           return handlePaymentSuccess(request, h, session, sessionKey, paymentStatus);
         case 'cancelled':
         case 'failed':
         case 'error':
+          logPaymentFailure(session, paymentStatus);
           return handlePaymentFailure(request, h, session, sessionKey);
         case 'created':
         case 'started':

package/.server/server/plugins/engine/routes/payment.js.map

@@ -1 +1 @@
-{"version":3,"file":"payment.js","names":["Boom","StatusCodes","Joi","EXTERNAL_STATE_APPENDAGE","getPaymentContext","PAYMENT_RETURN_PATH","PAYMENT_SESSION_PREFIX","flashComponentState","request","session","paymentStatus","paymentState","paymentId","reference","amount","description","uuid","formId","isLivePayment","payerEmail","email","preAuth","status","createdAt","Date","toISOString","appendage","component","componentName","data","yar","flash","getRoutes","getReturnRoute","handlePaymentSuccess","h","sessionKey","clear","redirect","returnUrl","code","SEE_OTHER","handlePaymentFailure","failureUrl","method","path","handler","query","state","nextUrl","_links","next_url","href","badRequest","unknownStatus","internal","options","validate","object","keys","string","required"],"sources":["../../../../../src/server/plugins/engine/routes/payment.js"],"sourcesContent":["import Boom from '@hapi/boom'\nimport { StatusCodes } from 'http-status-codes'\nimport Joi from 'joi'\n\nimport { EXTERNAL_STATE_APPENDAGE } from '~/src/server/constants.js'\nimport { getPaymentContext } from '~/src/server/plugins/engine/routes/payment-helper.js'\n\nexport const PAYMENT_RETURN_PATH = '/payment-callback'\nexport const PAYMENT_SESSION_PREFIX = 'payment-'\n\n/**\n * Flash form component state after successful payment\n * @param {Request} request - the request\n * @param {PaymentSessionData} session - the session data containing payment state\n * @param {GetPaymentResponse} paymentStatus - the payment status response from GOV.UK Pay\n */\nfunction flashComponentState(request, session, paymentStatus) {\n  /** @type {PaymentState} */\n  const paymentState = {\n    paymentId: paymentStatus.paymentId,\n    reference: session.reference,\n    amount: session.amount,\n    description: session.description,\n    uuid: session.uuid,\n    formId: session.formId,\n    isLivePayment: session.isLivePayment,\n    payerEmail: paymentStatus.email,\n    preAuth: {\n      status: 'success',\n      createdAt: new Date().toISOString()\n    }\n  }\n\n  /** @type {ExternalStateAppendage} */\n  const appendage = {\n    component: session.componentName,\n    data: /** @type {FormState} */ (/** @type {unknown} */ (paymentState))\n  }\n\n  request.yar.flash(EXTERNAL_STATE_APPENDAGE, appendage, true)\n}\n\n/**\n * Gets the payment routes for handling GOV.UK Pay callbacks\n * @returns {ServerRoute[]}\n */\nexport function getRoutes() {\n  return [getReturnRoute()]\n}\n\n/**\n * Handles successful payment states (capturable/success)\n * @param {Request} request - the request\n * @param {ResponseToolkit} h - the response toolkit\n * @param {PaymentSessionData} session - the session data\n * @param {string} sessionKey - the session key\n * @param {GetPaymentResponse} paymentStatus - the payment status from GOV.UK Pay\n */\nfunction handlePaymentSuccess(request, h, session, sessionKey, paymentStatus) {\n  flashComponentState(request, session, paymentStatus)\n  request.yar.clear(sessionKey)\n  return h.redirect(session.returnUrl).code(StatusCodes.SEE_OTHER)\n}\n\n/**\n * Handles failed/cancelled/error payment states\n * @param {Request} request - the request\n * @param {ResponseToolkit} h - the response toolkit\n * @param {PaymentSessionData} session - the session data\n * @param {string} sessionKey - the session key\n */\nfunction handlePaymentFailure(request, h, session, sessionKey) {\n  request.yar.clear(sessionKey)\n  return h.redirect(session.failureUrl).code(StatusCodes.SEE_OTHER)\n}\n\n/**\n * Route handler for payment return URL\n * This is called when GOV.UK Pay redirects the user back after payment\n * @returns {ServerRoute}\n */\nfunction getReturnRoute() {\n  return {\n    method: 'GET',\n    path: PAYMENT_RETURN_PATH,\n    async handler(request, h) {\n      const { uuid } = /** @type {{ uuid: string }} */ (request.query)\n      const { session, sessionKey, paymentStatus } = await getPaymentContext(\n        request,\n        uuid\n      )\n\n      /**\n       * @see https://docs.payments.service.gov.uk/api_reference/#payment-status-lifecycle\n       */\n      const { status } = paymentStatus.state\n\n      switch (status) {\n        case 'capturable':\n        case 'success':\n          return handlePaymentSuccess(\n            request,\n            h,\n            session,\n            sessionKey,\n            paymentStatus\n          )\n\n        case 'cancelled':\n        case 'failed':\n        case 'error':\n          return handlePaymentFailure(request, h, session, sessionKey)\n\n        case 'created':\n        case 'started':\n        case 'submitted': {\n          const nextUrl = paymentStatus._links.next_url?.href\n\n          if (!nextUrl) {\n            throw Boom.badRequest(\n              `Payment in state '${status}' but no next_url available`\n            )\n          }\n\n          return h.redirect(nextUrl).code(StatusCodes.SEE_OTHER)\n        }\n\n        default: {\n          const unknownStatus = /** @type {string} */ (status)\n          throw Boom.internal(`Unknown payment status: ${unknownStatus}`)\n        }\n      }\n    },\n    options: {\n      validate: {\n        query: Joi.object()\n          .keys({\n            uuid: Joi.string().uuid().required()\n          })\n          .required()\n      }\n    }\n  }\n}\n\n/**\n * @import { Request, ResponseToolkit, ServerRoute } from '@hapi/hapi'\n * @import { GetPaymentResponse, PaymentSessionData } from '~/src/server/plugins/payment/types.js'\n * @import { PaymentState } from '~/src/server/plugins/engine/components/PaymentField.types.js'\n * @import { ExternalStateAppendage, FormState } from '~/src/server/plugins/engine/types.js'\n */\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAC7B,SAASC,WAAW,QAAQ,mBAAmB;AAC/C,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,wBAAwB;AACjC,SAASC,iBAAiB;AAE1B,OAAO,MAAMC,mBAAmB,GAAG,mBAAmB;AACtD,OAAO,MAAMC,sBAAsB,GAAG,UAAU;;AAEhD;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,mBAAmBA,CAACC,OAAO,EAAEC,OAAO,EAAEC,aAAa,EAAE;EAC5D;EACA,MAAMC,YAAY,GAAG;IACnBC,SAAS,EAAEF,aAAa,CAACE,SAAS;IAClCC,SAAS,EAAEJ,OAAO,CAACI,SAAS;IAC5BC,MAAM,EAAEL,OAAO,CAACK,MAAM;IACtBC,WAAW,EAAEN,OAAO,CAACM,WAAW;IAChCC,IAAI,EAAEP,OAAO,CAACO,IAAI;IAClBC,MAAM,EAAER,OAAO,CAACQ,MAAM;IACtBC,aAAa,EAAET,OAAO,CAACS,aAAa;IACpCC,UAAU,EAAET,aAAa,CAACU,KAAK;IAC/BC,OAAO,EAAE;MACPC,MAAM,EAAE,SAAS;MACjBC,SAAS,EAAE,IAAIC,IAAI,CAAC,CAAC,CAACC,WAAW,CAAC;IACpC;EACF,CAAC;;EAED;EACA,MAAMC,SAAS,GAAG;IAChBC,SAAS,EAAElB,OAAO,CAACmB,aAAa;IAChCC,IAAI,GAAE,yBAA0B,sBAAwBlB,YAAY;EACtE,CAAC;EAEDH,OAAO,CAACsB,GAAG,CAACC,KAAK,CAAC5B,wBAAwB,EAAEuB,SAAS,EAAE,IAAI,CAAC;AAC9D;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASM,SAASA,CAAA,EAAG;EAC1B,OAAO,CAACC,cAAc,CAAC,CAAC,CAAC;AAC3B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,oBAAoBA,CAAC1B,OAAO,EAAE2B,CAAC,EAAE1B,OAAO,EAAE2B,UAAU,EAAE1B,aAAa,EAAE;EAC5EH,mBAAmB,CAACC,OAAO,EAAEC,OAAO,EAAEC,aAAa,CAAC;EACpDF,OAAO,CAACsB,GAAG,CAACO,KAAK,CAACD,UAAU,CAAC;EAC7B,OAAOD,CAAC,CAACG,QAAQ,CAAC7B,OAAO,CAAC8B,SAAS,CAAC,CAACC,IAAI,CAACvC,WAAW,CAACwC,SAAS,CAAC;AAClE;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,oBAAoBA,CAAClC,OAAO,EAAE2B,CAAC,EAAE1B,OAAO,EAAE2B,UAAU,EAAE;EAC7D5B,OAAO,CAACsB,GAAG,CAACO,KAAK,CAACD,UAAU,CAAC;EAC7B,OAAOD,CAAC,CAACG,QAAQ,CAAC7B,OAAO,CAACkC,UAAU,CAAC,CAACH,IAAI,CAACvC,WAAW,CAACwC,SAAS,CAAC;AACnE;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASR,cAAcA,CAAA,EAAG;EACxB,OAAO;IACLW,MAAM,EAAE,KAAK;IACbC,IAAI,EAAExC,mBAAmB;IACzB,MAAMyC,OAAOA,CAACtC,OAAO,EAAE2B,CAAC,EAAE;MACxB,MAAM;QAAEnB;MAAK,CAAC,GAAG,+BAAiCR,OAAO,CAACuC,KAAM;MAChE,MAAM;QAAEtC,OAAO;QAAE2B,UAAU;QAAE1B;MAAc,CAAC,GAAG,MAAMN,iBAAiB,CACpEI,OAAO,EACPQ,IACF,CAAC;;MAED;AACN;AACA;MACM,MAAM;QAAEM;MAAO,CAAC,GAAGZ,aAAa,CAACsC,KAAK;MAEtC,QAAQ1B,MAAM;QACZ,KAAK,YAAY;QACjB,KAAK,SAAS;UACZ,OAAOY,oBAAoB,CACzB1B,OAAO,EACP2B,CAAC,EACD1B,OAAO,EACP2B,UAAU,EACV1B,aACF,CAAC;QAEH,KAAK,WAAW;QAChB,KAAK,QAAQ;QACb,KAAK,OAAO;UACV,OAAOgC,oBAAoB,CAAClC,OAAO,EAAE2B,CAAC,EAAE1B,OAAO,EAAE2B,UAAU,CAAC;QAE9D,KAAK,SAAS;QACd,KAAK,SAAS;QACd,KAAK,WAAW;UAAE;YAChB,MAAMa,OAAO,GAAGvC,aAAa,CAACwC,MAAM,CAACC,QAAQ,EAAEC,IAAI;YAEnD,IAAI,CAACH,OAAO,EAAE;cACZ,MAAMjD,IAAI,CAACqD,UAAU,CACnB,qBAAqB/B,MAAM,6BAC7B,CAAC;YACH;YAEA,OAAOa,CAAC,CAACG,QAAQ,CAACW,OAAO,CAAC,CAACT,IAAI,CAACvC,WAAW,CAACwC,SAAS,CAAC;UACxD;QAEA;UAAS;YACP,MAAMa,aAAa,GAAG,qBAAuBhC,MAAO;YACpD,MAAMtB,IAAI,CAACuD,QAAQ,CAAC,2BAA2BD,aAAa,EAAE,CAAC;UACjE;MACF;IACF,CAAC;IACDE,OAAO,EAAE;MACPC,QAAQ,EAAE;QACRV,KAAK,EAAE7C,GAAG,CAACwD,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJ3C,IAAI,EAAEd,GAAG,CAAC0D,MAAM,CAAC,CAAC,CAAC5C,IAAI,CAAC,CAAC,CAAC6C,QAAQ,CAAC;QACrC,CAAC,CAAC,CACDA,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"payment.js","names":["Boom","StatusCodes","Joi","createLogger","EXTERNAL_STATE_APPENDAGE","buildPaymentInfo","convertPenceToPounds","getPaymentContext","PAYMENT_RETURN_PATH","PAYMENT_SESSION_PREFIX","logger","flashComponentState","request","session","paymentStatus","paymentState","paymentId","reference","amount","description","uuid","formId","isLivePayment","payerEmail","email","preAuth","status","createdAt","Date","toISOString","appendage","component","componentName","data","yar","flash","getRoutes","getReturnRoute","logPaymentSuccess","info","state","logPaymentFailure","handlePaymentSuccess","h","sessionKey","clear","redirect","returnUrl","code","SEE_OTHER","handlePaymentFailure","failureUrl","method","path","handler","query","nextUrl","_links","next_url","href","badRequest","unknownStatus","internal","options","validate","object","keys","string","required"],"sources":["../../../../../src/server/plugins/engine/routes/payment.js"],"sourcesContent":["import Boom from '@hapi/boom'\nimport { StatusCodes } from 'http-status-codes'\nimport Joi from 'joi'\n\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport { EXTERNAL_STATE_APPENDAGE } from '~/src/server/constants.js'\nimport {\n  buildPaymentInfo,\n  convertPenceToPounds,\n  getPaymentContext\n} from '~/src/server/plugins/engine/routes/payment-helper.js'\n\nexport const PAYMENT_RETURN_PATH = '/payment-callback'\nexport const PAYMENT_SESSION_PREFIX = 'payment-'\n\nconst logger = createLogger()\n\n/**\n * Flash form component state after successful payment\n * @param {Request} request - the request\n * @param {PaymentSessionData} session - the session data containing payment state\n * @param {GetPaymentResponse} paymentStatus - the payment status response from GOV.UK Pay\n */\nfunction flashComponentState(request, session, paymentStatus) {\n  /** @type {PaymentState} */\n  const paymentState = {\n    paymentId: paymentStatus.paymentId,\n    reference: session.reference,\n    amount: session.amount,\n    description: session.description,\n    uuid: session.uuid,\n    formId: session.formId,\n    isLivePayment: session.isLivePayment,\n    payerEmail: paymentStatus.email,\n    preAuth: {\n      status: 'success',\n      createdAt: new Date().toISOString()\n    }\n  }\n\n  /** @type {ExternalStateAppendage} */\n  const appendage = {\n    component: session.componentName,\n    data: /** @type {FormState} */ (/** @type {unknown} */ (paymentState))\n  }\n\n  request.yar.flash(EXTERNAL_STATE_APPENDAGE, appendage, true)\n}\n\n/**\n * Gets the payment routes for handling GOV.UK Pay callbacks\n * @returns {ServerRoute[]}\n */\nexport function getRoutes() {\n  return [getReturnRoute()]\n}\n\n/**\n * Logs successful payment\n * @param {PaymentSessionData} session - the session data\n * @param {GetPaymentResponse} paymentStatus - the payment status from GOV.UK Pay\n */\nfunction logPaymentSuccess(session, paymentStatus) {\n  logger.info(\n    buildPaymentInfo(\n      'pre-auth',\n      'success',\n      `${paymentStatus.state.status} amount=${convertPenceToPounds(paymentStatus.amount)}`,\n      session.isLivePayment,\n      paymentStatus.paymentId\n    ),\n    `[payment] Successful pre-auth for paymentId=${paymentStatus.paymentId}`\n  )\n}\n\n/**\n * Logs failed/cancelled payment\n * @param {PaymentSessionData} session - the session data\n * @param {GetPaymentResponse} paymentStatus - the payment status from GOV.UK Pay\n */\nfunction logPaymentFailure(session, paymentStatus) {\n  logger.info(\n    buildPaymentInfo(\n      'pre-auth',\n      'failed/cancelled',\n      `${paymentStatus.state.status} amount=${convertPenceToPounds(paymentStatus.amount)}`,\n      session.isLivePayment,\n      paymentStatus.paymentId\n    ),\n    `[payment] Failed/cancelled pre-auth for paymentId=${paymentStatus.paymentId}`\n  )\n}\n\n/**\n * Handles successful payment states (capturable/success)\n * @param {Request} request - the request\n * @param {ResponseToolkit} h - the response toolkit\n * @param {PaymentSessionData} session - the session data\n * @param {string} sessionKey - the session key\n * @param {GetPaymentResponse} paymentStatus - the payment status from GOV.UK Pay\n */\nfunction handlePaymentSuccess(request, h, session, sessionKey, paymentStatus) {\n  flashComponentState(request, session, paymentStatus)\n  request.yar.clear(sessionKey)\n  return h.redirect(session.returnUrl).code(StatusCodes.SEE_OTHER)\n}\n\n/**\n * Handles failed/cancelled/error payment states\n * @param {Request} request - the request\n * @param {ResponseToolkit} h - the response toolkit\n * @param {PaymentSessionData} session - the session data\n * @param {string} sessionKey - the session key\n */\nfunction handlePaymentFailure(request, h, session, sessionKey) {\n  request.yar.clear(sessionKey)\n  return h.redirect(session.failureUrl).code(StatusCodes.SEE_OTHER)\n}\n\n/**\n * Route handler for payment return URL\n * This is called when GOV.UK Pay redirects the user back after payment\n * @returns {ServerRoute}\n */\nfunction getReturnRoute() {\n  return {\n    method: 'GET',\n    path: PAYMENT_RETURN_PATH,\n    async handler(request, h) {\n      const { uuid } = /** @type {{ uuid: string }} */ (request.query)\n      const { session, sessionKey, paymentStatus } = await getPaymentContext(\n        request,\n        uuid\n      )\n\n      /**\n       * @see https://docs.payments.service.gov.uk/api_reference/#payment-status-lifecycle\n       */\n      const { status } = paymentStatus.state\n\n      switch (status) {\n        case 'capturable':\n        case 'success':\n          logPaymentSuccess(session, paymentStatus)\n          return handlePaymentSuccess(\n            request,\n            h,\n            session,\n            sessionKey,\n            paymentStatus\n          )\n\n        case 'cancelled':\n        case 'failed':\n        case 'error':\n          logPaymentFailure(session, paymentStatus)\n          return handlePaymentFailure(request, h, session, sessionKey)\n\n        case 'created':\n        case 'started':\n        case 'submitted': {\n          const nextUrl = paymentStatus._links.next_url?.href\n\n          if (!nextUrl) {\n            throw Boom.badRequest(\n              `Payment in state '${status}' but no next_url available`\n            )\n          }\n\n          return h.redirect(nextUrl).code(StatusCodes.SEE_OTHER)\n        }\n\n        default: {\n          const unknownStatus = /** @type {string} */ (status)\n          throw Boom.internal(`Unknown payment status: ${unknownStatus}`)\n        }\n      }\n    },\n    options: {\n      validate: {\n        query: Joi.object()\n          .keys({\n            uuid: Joi.string().uuid().required()\n          })\n          .required()\n      }\n    }\n  }\n}\n\n/**\n * @import { Request, ResponseToolkit, ServerRoute } from '@hapi/hapi'\n * @import { GetPaymentResponse, PaymentSessionData } from '~/src/server/plugins/payment/types.js'\n * @import { PaymentState } from '~/src/server/plugins/engine/components/PaymentField.types.js'\n * @import { ExternalStateAppendage, FormState } from '~/src/server/plugins/engine/types.js'\n */\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAC7B,SAASC,WAAW,QAAQ,mBAAmB;AAC/C,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,YAAY;AACrB,SAASC,wBAAwB;AACjC,SACEC,gBAAgB,EAChBC,oBAAoB,EACpBC,iBAAiB;AAGnB,OAAO,MAAMC,mBAAmB,GAAG,mBAAmB;AACtD,OAAO,MAAMC,sBAAsB,GAAG,UAAU;AAEhD,MAAMC,MAAM,GAAGP,YAAY,CAAC,CAAC;;AAE7B;AACA;AACA;AACA;AACA;AACA;AACA,SAASQ,mBAAmBA,CAACC,OAAO,EAAEC,OAAO,EAAEC,aAAa,EAAE;EAC5D;EACA,MAAMC,YAAY,GAAG;IACnBC,SAAS,EAAEF,aAAa,CAACE,SAAS;IAClCC,SAAS,EAAEJ,OAAO,CAACI,SAAS;IAC5BC,MAAM,EAAEL,OAAO,CAACK,MAAM;IACtBC,WAAW,EAAEN,OAAO,CAACM,WAAW;IAChCC,IAAI,EAAEP,OAAO,CAACO,IAAI;IAClBC,MAAM,EAAER,OAAO,CAACQ,MAAM;IACtBC,aAAa,EAAET,OAAO,CAACS,aAAa;IACpCC,UAAU,EAAET,aAAa,CAACU,KAAK;IAC/BC,OAAO,EAAE;MACPC,MAAM,EAAE,SAAS;MACjBC,SAAS,EAAE,IAAIC,IAAI,CAAC,CAAC,CAACC,WAAW,CAAC;IACpC;EACF,CAAC;;EAED;EACA,MAAMC,SAAS,GAAG;IAChBC,SAAS,EAAElB,OAAO,CAACmB,aAAa;IAChCC,IAAI,GAAE,yBAA0B,sBAAwBlB,YAAY;EACtE,CAAC;EAEDH,OAAO,CAACsB,GAAG,CAACC,KAAK,CAAC/B,wBAAwB,EAAE0B,SAAS,EAAE,IAAI,CAAC;AAC9D;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASM,SAASA,CAAA,EAAG;EAC1B,OAAO,CAACC,cAAc,CAAC,CAAC,CAAC;AAC3B;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASC,iBAAiBA,CAACzB,OAAO,EAAEC,aAAa,EAAE;EACjDJ,MAAM,CAAC6B,IAAI,CACTlC,gBAAgB,CACd,UAAU,EACV,SAAS,EACT,GAAGS,aAAa,CAAC0B,KAAK,CAACd,MAAM,WAAWpB,oBAAoB,CAACQ,aAAa,CAACI,MAAM,CAAC,EAAE,EACpFL,OAAO,CAACS,aAAa,EACrBR,aAAa,CAACE,SAChB,CAAC,EACD,+CAA+CF,aAAa,CAACE,SAAS,EACxE,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASyB,iBAAiBA,CAAC5B,OAAO,EAAEC,aAAa,EAAE;EACjDJ,MAAM,CAAC6B,IAAI,CACTlC,gBAAgB,CACd,UAAU,EACV,kBAAkB,EAClB,GAAGS,aAAa,CAAC0B,KAAK,CAACd,MAAM,WAAWpB,oBAAoB,CAACQ,aAAa,CAACI,MAAM,CAAC,EAAE,EACpFL,OAAO,CAACS,aAAa,EACrBR,aAAa,CAACE,SAChB,CAAC,EACD,qDAAqDF,aAAa,CAACE,SAAS,EAC9E,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS0B,oBAAoBA,CAAC9B,OAAO,EAAE+B,CAAC,EAAE9B,OAAO,EAAE+B,UAAU,EAAE9B,aAAa,EAAE;EAC5EH,mBAAmB,CAACC,OAAO,EAAEC,OAAO,EAAEC,aAAa,CAAC;EACpDF,OAAO,CAACsB,GAAG,CAACW,KAAK,CAACD,UAAU,CAAC;EAC7B,OAAOD,CAAC,CAACG,QAAQ,CAACjC,OAAO,CAACkC,SAAS,CAAC,CAACC,IAAI,CAAC/C,WAAW,CAACgD,SAAS,CAAC;AAClE;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,oBAAoBA,CAACtC,OAAO,EAAE+B,CAAC,EAAE9B,OAAO,EAAE+B,UAAU,EAAE;EAC7DhC,OAAO,CAACsB,GAAG,CAACW,KAAK,CAACD,UAAU,CAAC;EAC7B,OAAOD,CAAC,CAACG,QAAQ,CAACjC,OAAO,CAACsC,UAAU,CAAC,CAACH,IAAI,CAAC/C,WAAW,CAACgD,SAAS,CAAC;AACnE;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASZ,cAAcA,CAAA,EAAG;EACxB,OAAO;IACLe,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE7C,mBAAmB;IACzB,MAAM8C,OAAOA,CAAC1C,OAAO,EAAE+B,CAAC,EAAE;MACxB,MAAM;QAAEvB;MAAK,CAAC,GAAG,+BAAiCR,OAAO,CAAC2C,KAAM;MAChE,MAAM;QAAE1C,OAAO;QAAE+B,UAAU;QAAE9B;MAAc,CAAC,GAAG,MAAMP,iBAAiB,CACpEK,OAAO,EACPQ,IACF,CAAC;;MAED;AACN;AACA;MACM,MAAM;QAAEM;MAAO,CAAC,GAAGZ,aAAa,CAAC0B,KAAK;MAEtC,QAAQd,MAAM;QACZ,KAAK,YAAY;QACjB,KAAK,SAAS;UACZY,iBAAiB,CAACzB,OAAO,EAAEC,aAAa,CAAC;UACzC,OAAO4B,oBAAoB,CACzB9B,OAAO,EACP+B,CAAC,EACD9B,OAAO,EACP+B,UAAU,EACV9B,aACF,CAAC;QAEH,KAAK,WAAW;QAChB,KAAK,QAAQ;QACb,KAAK,OAAO;UACV2B,iBAAiB,CAAC5B,OAAO,EAAEC,aAAa,CAAC;UACzC,OAAOoC,oBAAoB,CAACtC,OAAO,EAAE+B,CAAC,EAAE9B,OAAO,EAAE+B,UAAU,CAAC;QAE9D,KAAK,SAAS;QACd,KAAK,SAAS;QACd,KAAK,WAAW;UAAE;YAChB,MAAMY,OAAO,GAAG1C,aAAa,CAAC2C,MAAM,CAACC,QAAQ,EAAEC,IAAI;YAEnD,IAAI,CAACH,OAAO,EAAE;cACZ,MAAMxD,IAAI,CAAC4D,UAAU,CACnB,qBAAqBlC,MAAM,6BAC7B,CAAC;YACH;YAEA,OAAOiB,CAAC,CAACG,QAAQ,CAACU,OAAO,CAAC,CAACR,IAAI,CAAC/C,WAAW,CAACgD,SAAS,CAAC;UACxD;QAEA;UAAS;YACP,MAAMY,aAAa,GAAG,qBAAuBnC,MAAO;YACpD,MAAM1B,IAAI,CAAC8D,QAAQ,CAAC,2BAA2BD,aAAa,EAAE,CAAC;UACjE;MACF;IACF,CAAC;IACDE,OAAO,EAAE;MACPC,QAAQ,EAAE;QACRT,KAAK,EAAErD,GAAG,CAAC+D,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJ9C,IAAI,EAAElB,GAAG,CAACiE,MAAM,CAAC,CAAC,CAAC/C,IAAI,CAAC,CAAC,CAACgD,QAAQ,CAAC;QACrC,CAAC,CAAC,CACDA,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/payment/service.d.ts

@@ -9,9 +9,10 @@ export class PaymentService {
      * @param {string} description
      * @param {string} returnUrl
      * @param {string} reference
+     * @param {boolean} isLivePayment
      * @param {{ formId: string, slug: string }} metadata
      */
-    createPayment(amount: number, description: string, returnUrl: string, reference: string, metadata: {
+    createPayment(amount: number, description: string, returnUrl: string, reference: string, isLivePayment: boolean, metadata: {
         formId: string;
         slug: string;
     }): Promise<{
@@ -20,9 +21,10 @@ export class PaymentService {
     }>;
     /**
      * @param {string} paymentId
+     * @param {boolean} isLivePayment
      * @returns {Promise<GetPaymentResponse>}
      */
-    getPaymentStatus(paymentId: string): Promise<GetPaymentResponse>;
+    getPaymentStatus(paymentId: string, isLivePayment: boolean): Promise<GetPaymentResponse>;
     /**
      * Captures a payment that is in 'capturable' status
      * @param {string} paymentId

package/.server/server/plugins/payment/service.js

@@ -1,5 +1,6 @@
 import { StatusCodes } from 'http-status-codes';
 import { createLogger } from "../../common/helpers/logging/logger.js";
+import { buildPaymentInfo, convertPenceToPounds } from "../engine/routes/payment-helper.js";
 import { get, post, postJson } from "../../services/httpService.js";
 const PAYMENT_BASE_URL = 'https://publicapi.payments.service.gov.uk';
 const PAYMENT_ENDPOINT = '/v1/payments';
@@ -31,9 +32,10 @@ export class PaymentService {
    * @param {string} description
    * @param {string} returnUrl
    * @param {string} reference
+   * @param {boolean} isLivePayment
    * @param {{ formId: string, slug: string }} metadata
    */
-  async createPayment(amount, description, returnUrl, reference, metadata) {
+  async createPayment(amount, description, returnUrl, reference, isLivePayment, metadata) {
     const response = await this.postToPayProvider({
       amount,
       description,
@@ -42,15 +44,7 @@ export class PaymentService {
       return_url: returnUrl,
       delayed_capture: true
     });
-    logger.info({
-      event: {
-        category: 'payment',
-        action: 'create-payment',
-        outcome: 'success',
-        reason: `amount=${amount}`,
-        reference: response.payment_id
-      }
-    }, `[payment] Created payment and user taken to enter pre-auth details for paymentId=${response.payment_id}`);
+    logger.info(buildPaymentInfo('create-payment', 'success', `amount=${convertPenceToPounds(amount)}`, isLivePayment, response.payment_id), `[payment] Created payment and user taken to enter pre-auth details for paymentId=${response.payment_id}`);
     return {
       paymentId: response.payment_id,
       paymentUrl: response._links.next_url.href
@@ -59,9 +53,10 @@ export class PaymentService {
 
   /**
    * @param {string} paymentId
+   * @param {boolean} isLivePayment
    * @returns {Promise<GetPaymentResponse>}
    */
-  async getPaymentStatus(paymentId) {
+  async getPaymentStatus(paymentId, isLivePayment) {
     const getByType = /** @type {typeof get<GetPaymentApiResponse>} */get;
     try {
       const response = await getByType(`${PAYMENT_BASE_URL}${PAYMENT_ENDPOINT}/${paymentId}`, {
@@ -73,15 +68,7 @@ export class PaymentService {
         throw new Error(`Failed to get payment status: ${errorMessage}`);
       }
       const state = response.payload.state;
-      logger.info({
-        event: {
-          category: 'payment',
-          action: 'get-payment-status',
-          outcome: state.status === 'capturable' || state.status === 'success' ? 'success' : 'failure',
-          reason: `status:${state.status} code:${state.code ?? 'N/A'} message:${state.message ?? 'N/A'}`,
-          reference: paymentId
-        }
-      }, `[payment] Got payment status for paymentId=${paymentId}: status=${state.status}`);
+      logger.info(buildPaymentInfo('get-payment-status', state.status === 'capturable' || state.status === 'success' ? 'success' : 'failure', `status:${state.status} code:${state.code ?? 'N/A'} message:${state.message ?? 'N/A'}`, isLivePayment, paymentId), `[payment] Got payment status for paymentId=${paymentId}: status=${state.status}`);
       return {
         state,
         _links: response.payload._links,
@@ -114,7 +101,7 @@ export class PaymentService {
             category: 'payment',
             action: 'capture-payment',
             outcome: 'success',
-            reason: `amount=${amount}`,
+            reason: `amount=${convertPenceToPounds(amount)}`,
             reference: paymentId
           }
         }, `[payment] Successfully captured payment for paymentId=${paymentId}`);

package/.server/server/plugins/payment/service.js.map

@@ -1 +1 @@
-{"version":3,"file":"service.js","names":["StatusCodes","createLogger","get","post","postJson","PAYMENT_BASE_URL","PAYMENT_ENDPOINT","logger","getAuthHeaders","apiKey","Authorization","PaymentService","constructor","createPayment","amount","description","returnUrl","reference","metadata","response","postToPayProvider","return_url","delayed_capture","info","event","category","action","outcome","reason","payment_id","paymentId","paymentUrl","_links","next_url","href","getPaymentStatus","getByType","headers","json","error","errorMessage","Error","message","JSON","stringify","state","payload","status","code","email","err","capturePayment","statusCode","res","OK","NO_CONTENT","postJsonByType"],"sources":["../../../../src/server/plugins/payment/service.js"],"sourcesContent":["import { StatusCodes } from 'http-status-codes'\n\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport { get, post, postJson } from '~/src/server/services/httpService.js'\n\nconst PAYMENT_BASE_URL = 'https://publicapi.payments.service.gov.uk'\nconst PAYMENT_ENDPOINT = '/v1/payments'\n\nconst logger = createLogger()\n\n/**\n * @param {string} apiKey\n * @returns {{ Authorization: string }}\n */\nfunction getAuthHeaders(apiKey) {\n  return {\n    Authorization: `Bearer ${apiKey}`\n  }\n}\n\nexport class PaymentService {\n  /** @type {string} */\n  #apiKey\n\n  /**\n   * @param {string} apiKey - API key to use (global config for test value, per-form config for live value)\n   */\n  constructor(apiKey) {\n    this.#apiKey = apiKey\n  }\n\n  /**\n   * Creates a payment with delayed capture (pre-authorisation)\n   * @param {number} amount - in pence\n   * @param {string} description\n   * @param {string} returnUrl\n   * @param {string} reference\n   * @param {{ formId: string, slug: string }} metadata\n   */\n  async createPayment(amount, description, returnUrl, reference, metadata) {\n    const response = await this.postToPayProvider({\n      amount,\n      description,\n      reference,\n      metadata,\n      return_url: returnUrl,\n      delayed_capture: true\n    })\n\n    logger.info(\n      {\n        event: {\n          category: 'payment',\n          action: 'create-payment',\n          outcome: 'success',\n          reason: `amount=${amount}`,\n          reference: response.payment_id\n        }\n      },\n      `[payment] Created payment and user taken to enter pre-auth details for paymentId=${response.payment_id}`\n    )\n\n    return {\n      paymentId: response.payment_id,\n      paymentUrl: response._links.next_url.href\n    }\n  }\n\n  /**\n   * @param {string} paymentId\n   * @returns {Promise<GetPaymentResponse>}\n   */\n  async getPaymentStatus(paymentId) {\n    const getByType = /** @type {typeof get<GetPaymentApiResponse>} */ (get)\n\n    try {\n      const response = await getByType(\n        `${PAYMENT_BASE_URL}${PAYMENT_ENDPOINT}/${paymentId}`,\n        {\n          headers: getAuthHeaders(this.#apiKey),\n          json: true\n        }\n      )\n\n      if (response.error) {\n        const errorMessage =\n          response.error instanceof Error\n            ? response.error.message\n            : JSON.stringify(response.error)\n        throw new Error(`Failed to get payment status: ${errorMessage}`)\n      }\n\n      const state = response.payload.state\n      logger.info(\n        {\n          event: {\n            category: 'payment',\n            action: 'get-payment-status',\n            outcome:\n              state.status === 'capturable' || state.status === 'success'\n                ? 'success'\n                : 'failure',\n            reason: `status:${state.status} code:${state.code ?? 'N/A'} message:${state.message ?? 'N/A'}`,\n            reference: paymentId\n          }\n        },\n        `[payment] Got payment status for paymentId=${paymentId}: status=${state.status}`\n      )\n\n      return {\n        state,\n        _links: response.payload._links,\n        email: response.payload.email,\n        paymentId: response.payload.payment_id,\n        amount: response.payload.amount\n      }\n    } catch (err) {\n      const error = /** @type {Error} */ (err)\n      logger.error(\n        error,\n        `[payment] Error getting payment status for paymentId=${paymentId}: ${error.message}`\n      )\n      throw err\n    }\n  }\n\n  /**\n   * Captures a payment that is in 'capturable' status\n   * @param {string} paymentId\n   * @param {number} amount\n   * @returns {Promise<boolean>}\n   */\n  async capturePayment(paymentId, amount) {\n    try {\n      const response = await post(\n        `${PAYMENT_BASE_URL}${PAYMENT_ENDPOINT}/${paymentId}/capture`,\n        {\n          headers: getAuthHeaders(this.#apiKey)\n        }\n      )\n\n      const statusCode = response.res.statusCode\n\n      if (\n        statusCode === StatusCodes.OK ||\n        statusCode === StatusCodes.NO_CONTENT\n      ) {\n        logger.info(\n          {\n            event: {\n              category: 'payment',\n              action: 'capture-payment',\n              outcome: 'success',\n              reason: `amount=${amount}`,\n              reference: paymentId\n            }\n          },\n          `[payment] Successfully captured payment for paymentId=${paymentId}`\n        )\n        return true\n      }\n\n      logger.error(\n        `[payment] Capture failed for paymentId=${paymentId}: HTTP ${statusCode}`\n      )\n      return false\n    } catch (err) {\n      const error = /** @type {Error} */ (err)\n      logger.error(\n        error,\n        `[payment] Error capturing payment for paymentId=${paymentId}: ${error.message}`\n      )\n      throw err\n    }\n  }\n\n  /**\n   * @param {CreatePaymentRequest} payload\n   */\n  async postToPayProvider(payload) {\n    const postJsonByType =\n      /** @type {typeof postJson<CreatePaymentResponse>} */ (postJson)\n\n    try {\n      const response = await postJsonByType(\n        `${PAYMENT_BASE_URL}${PAYMENT_ENDPOINT}`,\n        {\n          payload,\n          headers: getAuthHeaders(this.#apiKey)\n        }\n      )\n\n      if (response.payload?.state.status !== 'created') {\n        throw new Error(\n          `Failed to create payment for reference=${payload.reference}`\n        )\n      }\n\n      return response.payload\n    } catch (err) {\n      const error = /** @type {Error} */ (err)\n      logger.error(\n        error,\n        `[payment] Error creating payment for reference=${payload.reference}: ${error.message}`\n      )\n      throw err\n    }\n  }\n}\n\n/**\n * @import { CreatePaymentRequest, CreatePaymentResponse, GetPaymentApiResponse, GetPaymentResponse } from '~/src/server/plugins/payment/types.js'\n */\n"],"mappings":"AAAA,SAASA,WAAW,QAAQ,mBAAmB;AAE/C,SAASC,YAAY;AACrB,SAASC,GAAG,EAAEC,IAAI,EAAEC,QAAQ;AAE5B,MAAMC,gBAAgB,GAAG,2CAA2C;AACpE,MAAMC,gBAAgB,GAAG,cAAc;AAEvC,MAAMC,MAAM,GAAGN,YAAY,CAAC,CAAC;;AAE7B;AACA;AACA;AACA;AACA,SAASO,cAAcA,CAACC,MAAM,EAAE;EAC9B,OAAO;IACLC,aAAa,EAAE,UAAUD,MAAM;EACjC,CAAC;AACH;AAEA,OAAO,MAAME,cAAc,CAAC;EAC1B;EACA,CAACF,MAAM;;EAEP;AACF;AACA;EACEG,WAAWA,CAACH,MAAM,EAAE;IAClB,IAAI,CAAC,CAACA,MAAM,GAAGA,MAAM;EACvB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMI,aAAaA,CAACC,MAAM,EAAEC,WAAW,EAAEC,SAAS,EAAEC,SAAS,EAAEC,QAAQ,EAAE;IACvE,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACC,iBAAiB,CAAC;MAC5CN,MAAM;MACNC,WAAW;MACXE,SAAS;MACTC,QAAQ;MACRG,UAAU,EAAEL,SAAS;MACrBM,eAAe,EAAE;IACnB,CAAC,CAAC;IAEFf,MAAM,CAACgB,IAAI,CACT;MACEC,KAAK,EAAE;QACLC,QAAQ,EAAE,SAAS;QACnBC,MAAM,EAAE,gBAAgB;QACxBC,OAAO,EAAE,SAAS;QAClBC,MAAM,EAAE,UAAUd,MAAM,EAAE;QAC1BG,SAAS,EAAEE,QAAQ,CAACU;MACtB;IACF,CAAC,EACD,oFAAoFV,QAAQ,CAACU,UAAU,EACzG,CAAC;IAED,OAAO;MACLC,SAAS,EAAEX,QAAQ,CAACU,UAAU;MAC9BE,UAAU,EAAEZ,QAAQ,CAACa,MAAM,CAACC,QAAQ,CAACC;IACvC,CAAC;EACH;;EAEA;AACF;AACA;AACA;EACE,MAAMC,gBAAgBA,CAACL,SAAS,EAAE;IAChC,MAAMM,SAAS,GAAG,gDAAkDlC,GAAI;IAExE,IAAI;MACF,MAAMiB,QAAQ,GAAG,MAAMiB,SAAS,CAC9B,GAAG/B,gBAAgB,GAAGC,gBAAgB,IAAIwB,SAAS,EAAE,EACrD;QACEO,OAAO,EAAE7B,cAAc,CAAC,IAAI,CAAC,CAACC,MAAM,CAAC;QACrC6B,IAAI,EAAE;MACR,CACF,CAAC;MAED,IAAInB,QAAQ,CAACoB,KAAK,EAAE;QAClB,MAAMC,YAAY,GAChBrB,QAAQ,CAACoB,KAAK,YAAYE,KAAK,GAC3BtB,QAAQ,CAACoB,KAAK,CAACG,OAAO,GACtBC,IAAI,CAACC,SAAS,CAACzB,QAAQ,CAACoB,KAAK,CAAC;QACpC,MAAM,IAAIE,KAAK,CAAC,iCAAiCD,YAAY,EAAE,CAAC;MAClE;MAEA,MAAMK,KAAK,GAAG1B,QAAQ,CAAC2B,OAAO,CAACD,KAAK;MACpCtC,MAAM,CAACgB,IAAI,CACT;QACEC,KAAK,EAAE;UACLC,QAAQ,EAAE,SAAS;UACnBC,MAAM,EAAE,oBAAoB;UAC5BC,OAAO,EACLkB,KAAK,CAACE,MAAM,KAAK,YAAY,IAAIF,KAAK,CAACE,MAAM,KAAK,SAAS,GACvD,SAAS,GACT,SAAS;UACfnB,MAAM,EAAE,UAAUiB,KAAK,CAACE,MAAM,SAASF,KAAK,CAACG,IAAI,IAAI,KAAK,YAAYH,KAAK,CAACH,OAAO,IAAI,KAAK,EAAE;UAC9FzB,SAAS,EAAEa;QACb;MACF,CAAC,EACD,8CAA8CA,SAAS,YAAYe,KAAK,CAACE,MAAM,EACjF,CAAC;MAED,OAAO;QACLF,KAAK;QACLb,MAAM,EAAEb,QAAQ,CAAC2B,OAAO,CAACd,MAAM;QAC/BiB,KAAK,EAAE9B,QAAQ,CAAC2B,OAAO,CAACG,KAAK;QAC7BnB,SAAS,EAAEX,QAAQ,CAAC2B,OAAO,CAACjB,UAAU;QACtCf,MAAM,EAAEK,QAAQ,CAAC2B,OAAO,CAAChC;MAC3B,CAAC;IACH,CAAC,CAAC,OAAOoC,GAAG,EAAE;MACZ,MAAMX,KAAK,GAAG,oBAAsBW,GAAI;MACxC3C,MAAM,CAACgC,KAAK,CACVA,KAAK,EACL,wDAAwDT,SAAS,KAAKS,KAAK,CAACG,OAAO,EACrF,CAAC;MACD,MAAMQ,GAAG;IACX;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE,MAAMC,cAAcA,CAACrB,SAAS,EAAEhB,MAAM,EAAE;IACtC,IAAI;MACF,MAAMK,QAAQ,GAAG,MAAMhB,IAAI,CACzB,GAAGE,gBAAgB,GAAGC,gBAAgB,IAAIwB,SAAS,UAAU,EAC7D;QACEO,OAAO,EAAE7B,cAAc,CAAC,IAAI,CAAC,CAACC,MAAM;MACtC,CACF,CAAC;MAED,MAAM2C,UAAU,GAAGjC,QAAQ,CAACkC,GAAG,CAACD,UAAU;MAE1C,IACEA,UAAU,KAAKpD,WAAW,CAACsD,EAAE,IAC7BF,UAAU,KAAKpD,WAAW,CAACuD,UAAU,EACrC;QACAhD,MAAM,CAACgB,IAAI,CACT;UACEC,KAAK,EAAE;YACLC,QAAQ,EAAE,SAAS;YACnBC,MAAM,EAAE,iBAAiB;YACzBC,OAAO,EAAE,SAAS;YAClBC,MAAM,EAAE,UAAUd,MAAM,EAAE;YAC1BG,SAAS,EAAEa;UACb;QACF,CAAC,EACD,yDAAyDA,SAAS,EACpE,CAAC;QACD,OAAO,IAAI;MACb;MAEAvB,MAAM,CAACgC,KAAK,CACV,0CAA0CT,SAAS,UAAUsB,UAAU,EACzE,CAAC;MACD,OAAO,KAAK;IACd,CAAC,CAAC,OAAOF,GAAG,EAAE;MACZ,MAAMX,KAAK,GAAG,oBAAsBW,GAAI;MACxC3C,MAAM,CAACgC,KAAK,CACVA,KAAK,EACL,mDAAmDT,SAAS,KAAKS,KAAK,CAACG,OAAO,EAChF,CAAC;MACD,MAAMQ,GAAG;IACX;EACF;;EAEA;AACF;AACA;EACE,MAAM9B,iBAAiBA,CAAC0B,OAAO,EAAE;IAC/B,MAAMU,cAAc,GAClB,qDAAuDpD,QAAS;IAElE,IAAI;MACF,MAAMe,QAAQ,GAAG,MAAMqC,cAAc,CACnC,GAAGnD,gBAAgB,GAAGC,gBAAgB,EAAE,EACxC;QACEwC,OAAO;QACPT,OAAO,EAAE7B,cAAc,CAAC,IAAI,CAAC,CAACC,MAAM;MACtC,CACF,CAAC;MAED,IAAIU,QAAQ,CAAC2B,OAAO,EAAED,KAAK,CAACE,MAAM,KAAK,SAAS,EAAE;QAChD,MAAM,IAAIN,KAAK,CACb,0CAA0CK,OAAO,CAAC7B,SAAS,EAC7D,CAAC;MACH;MAEA,OAAOE,QAAQ,CAAC2B,OAAO;IACzB,CAAC,CAAC,OAAOI,GAAG,EAAE;MACZ,MAAMX,KAAK,GAAG,oBAAsBW,GAAI;MACxC3C,MAAM,CAACgC,KAAK,CACVA,KAAK,EACL,kDAAkDO,OAAO,CAAC7B,SAAS,KAAKsB,KAAK,CAACG,OAAO,EACvF,CAAC;MACD,MAAMQ,GAAG;IACX;EACF;AACF;;AAEA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"service.js","names":["StatusCodes","createLogger","buildPaymentInfo","convertPenceToPounds","get","post","postJson","PAYMENT_BASE_URL","PAYMENT_ENDPOINT","logger","getAuthHeaders","apiKey","Authorization","PaymentService","constructor","createPayment","amount","description","returnUrl","reference","isLivePayment","metadata","response","postToPayProvider","return_url","delayed_capture","info","payment_id","paymentId","paymentUrl","_links","next_url","href","getPaymentStatus","getByType","headers","json","error","errorMessage","Error","message","JSON","stringify","state","payload","status","code","email","err","capturePayment","statusCode","res","OK","NO_CONTENT","event","category","action","outcome","reason","postJsonByType"],"sources":["../../../../src/server/plugins/payment/service.js"],"sourcesContent":["import { StatusCodes } from 'http-status-codes'\n\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport {\n  buildPaymentInfo,\n  convertPenceToPounds\n} from '~/src/server/plugins/engine/routes/payment-helper.js'\nimport { get, post, postJson } from '~/src/server/services/httpService.js'\n\nconst PAYMENT_BASE_URL = 'https://publicapi.payments.service.gov.uk'\nconst PAYMENT_ENDPOINT = '/v1/payments'\n\nconst logger = createLogger()\n\n/**\n * @param {string} apiKey\n * @returns {{ Authorization: string }}\n */\nfunction getAuthHeaders(apiKey) {\n  return {\n    Authorization: `Bearer ${apiKey}`\n  }\n}\n\nexport class PaymentService {\n  /** @type {string} */\n  #apiKey\n\n  /**\n   * @param {string} apiKey - API key to use (global config for test value, per-form config for live value)\n   */\n  constructor(apiKey) {\n    this.#apiKey = apiKey\n  }\n\n  /**\n   * Creates a payment with delayed capture (pre-authorisation)\n   * @param {number} amount - in pence\n   * @param {string} description\n   * @param {string} returnUrl\n   * @param {string} reference\n   * @param {boolean} isLivePayment\n   * @param {{ formId: string, slug: string }} metadata\n   */\n  async createPayment(\n    amount,\n    description,\n    returnUrl,\n    reference,\n    isLivePayment,\n    metadata\n  ) {\n    const response = await this.postToPayProvider({\n      amount,\n      description,\n      reference,\n      metadata,\n      return_url: returnUrl,\n      delayed_capture: true\n    })\n\n    logger.info(\n      buildPaymentInfo(\n        'create-payment',\n        'success',\n        `amount=${convertPenceToPounds(amount)}`,\n        isLivePayment,\n        response.payment_id\n      ),\n      `[payment] Created payment and user taken to enter pre-auth details for paymentId=${response.payment_id}`\n    )\n\n    return {\n      paymentId: response.payment_id,\n      paymentUrl: response._links.next_url.href\n    }\n  }\n\n  /**\n   * @param {string} paymentId\n   * @param {boolean} isLivePayment\n   * @returns {Promise<GetPaymentResponse>}\n   */\n  async getPaymentStatus(paymentId, isLivePayment) {\n    const getByType = /** @type {typeof get<GetPaymentApiResponse>} */ (get)\n\n    try {\n      const response = await getByType(\n        `${PAYMENT_BASE_URL}${PAYMENT_ENDPOINT}/${paymentId}`,\n        {\n          headers: getAuthHeaders(this.#apiKey),\n          json: true\n        }\n      )\n\n      if (response.error) {\n        const errorMessage =\n          response.error instanceof Error\n            ? response.error.message\n            : JSON.stringify(response.error)\n        throw new Error(`Failed to get payment status: ${errorMessage}`)\n      }\n\n      const state = response.payload.state\n      logger.info(\n        buildPaymentInfo(\n          'get-payment-status',\n          state.status === 'capturable' || state.status === 'success'\n            ? 'success'\n            : 'failure',\n          `status:${state.status} code:${state.code ?? 'N/A'} message:${state.message ?? 'N/A'}`,\n          isLivePayment,\n          paymentId\n        ),\n        `[payment] Got payment status for paymentId=${paymentId}: status=${state.status}`\n      )\n\n      return {\n        state,\n        _links: response.payload._links,\n        email: response.payload.email,\n        paymentId: response.payload.payment_id,\n        amount: response.payload.amount\n      }\n    } catch (err) {\n      const error = /** @type {Error} */ (err)\n      logger.error(\n        error,\n        `[payment] Error getting payment status for paymentId=${paymentId}: ${error.message}`\n      )\n      throw err\n    }\n  }\n\n  /**\n   * Captures a payment that is in 'capturable' status\n   * @param {string} paymentId\n   * @param {number} amount\n   * @returns {Promise<boolean>}\n   */\n  async capturePayment(paymentId, amount) {\n    try {\n      const response = await post(\n        `${PAYMENT_BASE_URL}${PAYMENT_ENDPOINT}/${paymentId}/capture`,\n        {\n          headers: getAuthHeaders(this.#apiKey)\n        }\n      )\n\n      const statusCode = response.res.statusCode\n\n      if (\n        statusCode === StatusCodes.OK ||\n        statusCode === StatusCodes.NO_CONTENT\n      ) {\n        logger.info(\n          {\n            event: {\n              category: 'payment',\n              action: 'capture-payment',\n              outcome: 'success',\n              reason: `amount=${convertPenceToPounds(amount)}`,\n              reference: paymentId\n            }\n          },\n          `[payment] Successfully captured payment for paymentId=${paymentId}`\n        )\n        return true\n      }\n\n      logger.error(\n        `[payment] Capture failed for paymentId=${paymentId}: HTTP ${statusCode}`\n      )\n      return false\n    } catch (err) {\n      const error = /** @type {Error} */ (err)\n      logger.error(\n        error,\n        `[payment] Error capturing payment for paymentId=${paymentId}: ${error.message}`\n      )\n      throw err\n    }\n  }\n\n  /**\n   * @param {CreatePaymentRequest} payload\n   */\n  async postToPayProvider(payload) {\n    const postJsonByType =\n      /** @type {typeof postJson<CreatePaymentResponse>} */ (postJson)\n\n    try {\n      const response = await postJsonByType(\n        `${PAYMENT_BASE_URL}${PAYMENT_ENDPOINT}`,\n        {\n          payload,\n          headers: getAuthHeaders(this.#apiKey)\n        }\n      )\n\n      if (response.payload?.state.status !== 'created') {\n        throw new Error(\n          `Failed to create payment for reference=${payload.reference}`\n        )\n      }\n\n      return response.payload\n    } catch (err) {\n      const error = /** @type {Error} */ (err)\n      logger.error(\n        error,\n        `[payment] Error creating payment for reference=${payload.reference}: ${error.message}`\n      )\n      throw err\n    }\n  }\n}\n\n/**\n * @import { CreatePaymentRequest, CreatePaymentResponse, GetPaymentApiResponse, GetPaymentResponse } from '~/src/server/plugins/payment/types.js'\n */\n"],"mappings":"AAAA,SAASA,WAAW,QAAQ,mBAAmB;AAE/C,SAASC,YAAY;AACrB,SACEC,gBAAgB,EAChBC,oBAAoB;AAEtB,SAASC,GAAG,EAAEC,IAAI,EAAEC,QAAQ;AAE5B,MAAMC,gBAAgB,GAAG,2CAA2C;AACpE,MAAMC,gBAAgB,GAAG,cAAc;AAEvC,MAAMC,MAAM,GAAGR,YAAY,CAAC,CAAC;;AAE7B;AACA;AACA;AACA;AACA,SAASS,cAAcA,CAACC,MAAM,EAAE;EAC9B,OAAO;IACLC,aAAa,EAAE,UAAUD,MAAM;EACjC,CAAC;AACH;AAEA,OAAO,MAAME,cAAc,CAAC;EAC1B;EACA,CAACF,MAAM;;EAEP;AACF;AACA;EACEG,WAAWA,CAACH,MAAM,EAAE;IAClB,IAAI,CAAC,CAACA,MAAM,GAAGA,MAAM;EACvB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMI,aAAaA,CACjBC,MAAM,EACNC,WAAW,EACXC,SAAS,EACTC,SAAS,EACTC,aAAa,EACbC,QAAQ,EACR;IACA,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACC,iBAAiB,CAAC;MAC5CP,MAAM;MACNC,WAAW;MACXE,SAAS;MACTE,QAAQ;MACRG,UAAU,EAAEN,SAAS;MACrBO,eAAe,EAAE;IACnB,CAAC,CAAC;IAEFhB,MAAM,CAACiB,IAAI,CACTxB,gBAAgB,CACd,gBAAgB,EAChB,SAAS,EACT,UAAUC,oBAAoB,CAACa,MAAM,CAAC,EAAE,EACxCI,aAAa,EACbE,QAAQ,CAACK,UACX,CAAC,EACD,oFAAoFL,QAAQ,CAACK,UAAU,EACzG,CAAC;IAED,OAAO;MACLC,SAAS,EAAEN,QAAQ,CAACK,UAAU;MAC9BE,UAAU,EAAEP,QAAQ,CAACQ,MAAM,CAACC,QAAQ,CAACC;IACvC,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMC,gBAAgBA,CAACL,SAAS,EAAER,aAAa,EAAE;IAC/C,MAAMc,SAAS,GAAG,gDAAkD9B,GAAI;IAExE,IAAI;MACF,MAAMkB,QAAQ,GAAG,MAAMY,SAAS,CAC9B,GAAG3B,gBAAgB,GAAGC,gBAAgB,IAAIoB,SAAS,EAAE,EACrD;QACEO,OAAO,EAAEzB,cAAc,CAAC,IAAI,CAAC,CAACC,MAAM,CAAC;QACrCyB,IAAI,EAAE;MACR,CACF,CAAC;MAED,IAAId,QAAQ,CAACe,KAAK,EAAE;QAClB,MAAMC,YAAY,GAChBhB,QAAQ,CAACe,KAAK,YAAYE,KAAK,GAC3BjB,QAAQ,CAACe,KAAK,CAACG,OAAO,GACtBC,IAAI,CAACC,SAAS,CAACpB,QAAQ,CAACe,KAAK,CAAC;QACpC,MAAM,IAAIE,KAAK,CAAC,iCAAiCD,YAAY,EAAE,CAAC;MAClE;MAEA,MAAMK,KAAK,GAAGrB,QAAQ,CAACsB,OAAO,CAACD,KAAK;MACpClC,MAAM,CAACiB,IAAI,CACTxB,gBAAgB,CACd,oBAAoB,EACpByC,KAAK,CAACE,MAAM,KAAK,YAAY,IAAIF,KAAK,CAACE,MAAM,KAAK,SAAS,GACvD,SAAS,GACT,SAAS,EACb,UAAUF,KAAK,CAACE,MAAM,SAASF,KAAK,CAACG,IAAI,IAAI,KAAK,YAAYH,KAAK,CAACH,OAAO,IAAI,KAAK,EAAE,EACtFpB,aAAa,EACbQ,SACF,CAAC,EACD,8CAA8CA,SAAS,YAAYe,KAAK,CAACE,MAAM,EACjF,CAAC;MAED,OAAO;QACLF,KAAK;QACLb,MAAM,EAAER,QAAQ,CAACsB,OAAO,CAACd,MAAM;QAC/BiB,KAAK,EAAEzB,QAAQ,CAACsB,OAAO,CAACG,KAAK;QAC7BnB,SAAS,EAAEN,QAAQ,CAACsB,OAAO,CAACjB,UAAU;QACtCX,MAAM,EAAEM,QAAQ,CAACsB,OAAO,CAAC5B;MAC3B,CAAC;IACH,CAAC,CAAC,OAAOgC,GAAG,EAAE;MACZ,MAAMX,KAAK,GAAG,oBAAsBW,GAAI;MACxCvC,MAAM,CAAC4B,KAAK,CACVA,KAAK,EACL,wDAAwDT,SAAS,KAAKS,KAAK,CAACG,OAAO,EACrF,CAAC;MACD,MAAMQ,GAAG;IACX;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE,MAAMC,cAAcA,CAACrB,SAAS,EAAEZ,MAAM,EAAE;IACtC,IAAI;MACF,MAAMM,QAAQ,GAAG,MAAMjB,IAAI,CACzB,GAAGE,gBAAgB,GAAGC,gBAAgB,IAAIoB,SAAS,UAAU,EAC7D;QACEO,OAAO,EAAEzB,cAAc,CAAC,IAAI,CAAC,CAACC,MAAM;MACtC,CACF,CAAC;MAED,MAAMuC,UAAU,GAAG5B,QAAQ,CAAC6B,GAAG,CAACD,UAAU;MAE1C,IACEA,UAAU,KAAKlD,WAAW,CAACoD,EAAE,IAC7BF,UAAU,KAAKlD,WAAW,CAACqD,UAAU,EACrC;QACA5C,MAAM,CAACiB,IAAI,CACT;UACE4B,KAAK,EAAE;YACLC,QAAQ,EAAE,SAAS;YACnBC,MAAM,EAAE,iBAAiB;YACzBC,OAAO,EAAE,SAAS;YAClBC,MAAM,EAAE,UAAUvD,oBAAoB,CAACa,MAAM,CAAC,EAAE;YAChDG,SAAS,EAAES;UACb;QACF,CAAC,EACD,yDAAyDA,SAAS,EACpE,CAAC;QACD,OAAO,IAAI;MACb;MAEAnB,MAAM,CAAC4B,KAAK,CACV,0CAA0CT,SAAS,UAAUsB,UAAU,EACzE,CAAC;MACD,OAAO,KAAK;IACd,CAAC,CAAC,OAAOF,GAAG,EAAE;MACZ,MAAMX,KAAK,GAAG,oBAAsBW,GAAI;MACxCvC,MAAM,CAAC4B,KAAK,CACVA,KAAK,EACL,mDAAmDT,SAAS,KAAKS,KAAK,CAACG,OAAO,EAChF,CAAC;MACD,MAAMQ,GAAG;IACX;EACF;;EAEA;AACF;AACA;EACE,MAAMzB,iBAAiBA,CAACqB,OAAO,EAAE;IAC/B,MAAMe,cAAc,GAClB,qDAAuDrD,QAAS;IAElE,IAAI;MACF,MAAMgB,QAAQ,GAAG,MAAMqC,cAAc,CACnC,GAAGpD,gBAAgB,GAAGC,gBAAgB,EAAE,EACxC;QACEoC,OAAO;QACPT,OAAO,EAAEzB,cAAc,CAAC,IAAI,CAAC,CAACC,MAAM;MACtC,CACF,CAAC;MAED,IAAIW,QAAQ,CAACsB,OAAO,EAAED,KAAK,CAACE,MAAM,KAAK,SAAS,EAAE;QAChD,MAAM,IAAIN,KAAK,CACb,0CAA0CK,OAAO,CAACzB,SAAS,EAC7D,CAAC;MACH;MAEA,OAAOG,QAAQ,CAACsB,OAAO;IACzB,CAAC,CAAC,OAAOI,GAAG,EAAE;MACZ,MAAMX,KAAK,GAAG,oBAAsBW,GAAI;MACxCvC,MAAM,CAAC4B,KAAK,CACVA,KAAK,EACL,kDAAkDO,OAAO,CAACzB,SAAS,KAAKkB,KAAK,CAACG,OAAO,EACvF,CAAC;MACD,MAAMQ,GAAG;IACX;EACF;AACF;;AAEA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/payment/service.test.js

@@ -35,7 +35,7 @@ describe('payment service', () => {
         formId: 'form-id',
         slug: 'my-form-slug'
       };
-      const payment = await service.createPayment(100, 'Payment description', returnUrl, referenceNumber, metadata);
+      const payment = await service.createPayment(100, 'Payment description', returnUrl, referenceNumber, false, metadata);
       expect(payment.paymentId).toBe('payment-id-12345');
       expect(payment.paymentUrl).toBe('http://next-url-href/payment');
     });
@@ -47,7 +47,7 @@ describe('payment service', () => {
         formId: 'form-id',
         slug: 'my-form-slug'
       };
-      await expect(() => service.createPayment(100, 'Payment description', returnUrl, referenceNumber, metadata)).rejects.toThrow('internal creation error');
+      await expect(() => service.createPayment(100, 'Payment description', returnUrl, referenceNumber, false, metadata)).rejects.toThrow('internal creation error');
     });
     it('should throw if fails to create a payment - bad result from API call', async () => {
       const createPaymentResult = {
@@ -69,7 +69,7 @@ describe('payment service', () => {
         formId: 'form-id',
         slug: 'my-form-slug'
       };
-      await expect(() => service.createPayment(100, 'Payment description', returnUrl, referenceNumber, metadata)).rejects.toThrow('Failed to create payment');
+      await expect(() => service.createPayment(100, 'Payment description', returnUrl, referenceNumber, false, metadata)).rejects.toThrow('Failed to create payment');
     });
   });
   describe('getPaymentStatus', () => {
@@ -93,7 +93,7 @@ describe('payment service', () => {
         payload: getPaymentStatusResult,
         error: undefined
       });
-      const paymentStatus = await service.getPaymentStatus('payment-id-12345');
+      const paymentStatus = await service.getPaymentStatus('payment-id-12345', false);
       expect(paymentStatus.paymentId).toBe('payment-id-12345');
       expect(paymentStatus._links.next_url?.href).toBe('http://next-url-href/payment');
     });
@@ -106,7 +106,7 @@ describe('payment service', () => {
         payload: undefined,
         error: new Error('some-error')
       });
-      await expect(() => service.getPaymentStatus('payment-id-12345')).rejects.toThrow('Failed to get payment status: some-error');
+      await expect(() => service.getPaymentStatus('payment-id-12345', false)).rejects.toThrow('Failed to get payment status: some-error');
     });
   });
   describe('capturePayment', () => {

package/.server/server/plugins/payment/service.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"service.test.js","names":["PaymentService","get","post","postJson","jest","mock","describe","service","it","expect","toBeDefined","createPaymentResult","payment_id","_links","next_url","href","state","status","mocked","mockResolvedValueOnce","res","statusCode","headers","payload","error","undefined","referenceNumber","returnUrl","metadata","formId","slug","payment","createPayment","paymentId","toBe","paymentUrl","mockRejectedValueOnce","Error","rejects","toThrow","getPaymentStatusResult","paymentStatus","getPaymentStatus","capturePaymentResult","captureResult","capturePayment"],"sources":["../../../../src/server/plugins/payment/service.test.js"],"sourcesContent":["import { PaymentService } from '~/src/server/plugins/payment/service.js'\nimport { get, post, postJson } from '~/src/server/services/httpService.js'\n\njest.mock('~/src/server/services/httpService.ts')\n\ndescribe('payment service', () => {\n  const service = new PaymentService('my-api-key')\n  describe('constructor', () => {\n    it('should create instance', () => {\n      expect(service).toBeDefined()\n    })\n  })\n\n  describe('createPayment', () => {\n    it('should create a payment', async () => {\n      const createPaymentResult = {\n        payment_id: 'payment-id-12345',\n        _links: {\n          next_url: {\n            href: 'http://next-url-href/payment'\n          }\n        },\n        state: {\n          status: 'created'\n        }\n      }\n      jest.mocked(postJson).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: createPaymentResult,\n        error: undefined\n      })\n\n      const referenceNumber = 'ABC-DEF-123'\n      const returnUrl = 'http://localhost:3009/payment-callback-handler'\n      const metadata = { formId: 'form-id', slug: 'my-form-slug' }\n      const payment = await service.createPayment(\n        100,\n        'Payment description',\n        returnUrl,\n        referenceNumber,\n        metadata\n      )\n      expect(payment.paymentId).toBe('payment-id-12345')\n      expect(payment.paymentUrl).toBe('http://next-url-href/payment')\n    })\n\n    it('should throw if fails to create a payment - failed API call', async () => {\n      jest\n        .mocked(postJson)\n        .mockRejectedValueOnce(new Error('internal creation error'))\n\n      const referenceNumber = 'ABC-DEF-123'\n      const returnUrl = 'http://localhost:3009/payment-callback-handler'\n      const metadata = { formId: 'form-id', slug: 'my-form-slug' }\n      await expect(() =>\n        service.createPayment(\n          100,\n          'Payment description',\n          returnUrl,\n          referenceNumber,\n          metadata\n        )\n      ).rejects.toThrow('internal creation error')\n    })\n\n    it('should throw if fails to create a payment - bad result from API call', async () => {\n      const createPaymentResult = {\n        state: {\n          status: 'failed'\n        }\n      }\n      jest.mocked(postJson).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: createPaymentResult,\n        error: undefined\n      })\n\n      const referenceNumber = 'ABC-DEF-123'\n      const returnUrl = 'http://localhost:3009/payment-callback-handler'\n      const metadata = { formId: 'form-id', slug: 'my-form-slug' }\n      await expect(() =>\n        service.createPayment(\n          100,\n          'Payment description',\n          returnUrl,\n          referenceNumber,\n          metadata\n        )\n      ).rejects.toThrow('Failed to create payment')\n    })\n  })\n\n  describe('getPaymentStatus', () => {\n    it('should get payment status if exists', async () => {\n      const getPaymentStatusResult = {\n        payment_id: 'payment-id-12345',\n        _links: {\n          next_url: {\n            href: 'http://next-url-href/payment'\n          }\n        },\n        state: {\n          status: 'created'\n        }\n      }\n\n      jest.mocked(get).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: getPaymentStatusResult,\n        error: undefined\n      })\n\n      const paymentStatus = await service.getPaymentStatus('payment-id-12345')\n      expect(paymentStatus.paymentId).toBe('payment-id-12345')\n      expect(paymentStatus._links.next_url?.href).toBe(\n        'http://next-url-href/payment'\n      )\n    })\n\n    it('should handle payment status error', async () => {\n      jest.mocked(get).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: undefined,\n        error: new Error('some-error')\n      })\n\n      await expect(() =>\n        service.getPaymentStatus('payment-id-12345')\n      ).rejects.toThrow('Failed to get payment status: some-error')\n    })\n  })\n\n  describe('capturePayment', () => {\n    it('should return true when successful capture with statusCode 200', async () => {\n      const capturePaymentResult = {}\n      jest.mocked(post).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: capturePaymentResult,\n        error: undefined\n      })\n\n      const captureResult = await service.capturePayment(\n        'payment-id-12345',\n        100\n      )\n      expect(captureResult).toBe(true)\n    })\n\n    it('should return true when successful capture with statusCode 204', async () => {\n      const capturePaymentResult = {}\n      jest.mocked(post).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 204,\n          headers: {}\n        }),\n        payload: capturePaymentResult,\n        error: undefined\n      })\n\n      const captureResult = await service.capturePayment(\n        'payment-id-12345',\n        100\n      )\n      expect(captureResult).toBe(true)\n    })\n\n    it('should return false when status code not 200 or 204', async () => {\n      const capturePaymentResult = {}\n      jest.mocked(post).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 500,\n          headers: {}\n        }),\n        payload: capturePaymentResult,\n        error: undefined\n      })\n\n      const captureResult = await service.capturePayment(\n        'payment-id-12345',\n        100\n      )\n      expect(captureResult).toBe(false)\n    })\n\n    it('should throw when internal error', async () => {\n      jest\n        .mocked(post)\n        .mockRejectedValueOnce(new Error('internal capture error'))\n\n      await expect(() =>\n        service.capturePayment('payment-id-12345', 100)\n      ).rejects.toThrow('internal capture error')\n    })\n  })\n})\n\n/**\n * @import  { IncomingMessage } from 'node:http'\n */\n"],"mappings":"AAAA,SAASA,cAAc;AACvB,SAASC,GAAG,EAAEC,IAAI,EAAEC,QAAQ;AAE5BC,IAAI,CAACC,IAAI,gCAAuC,CAAC;AAEjDC,QAAQ,CAAC,iBAAiB,EAAE,MAAM;EAChC,MAAMC,OAAO,GAAG,IAAIP,cAAc,CAAC,YAAY,CAAC;EAChDM,QAAQ,CAAC,aAAa,EAAE,MAAM;IAC5BE,EAAE,CAAC,wBAAwB,EAAE,MAAM;MACjCC,MAAM,CAACF,OAAO,CAAC,CAACG,WAAW,CAAC,CAAC;IAC/B,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFJ,QAAQ,CAAC,eAAe,EAAE,MAAM;IAC9BE,EAAE,CAAC,yBAAyB,EAAE,YAAY;MACxC,MAAMG,mBAAmB,GAAG;QAC1BC,UAAU,EAAE,kBAAkB;QAC9BC,MAAM,EAAE;UACNC,QAAQ,EAAE;YACRC,IAAI,EAAE;UACR;QACF,CAAC;QACDC,KAAK,EAAE;UACLC,MAAM,EAAE;QACV;MACF,CAAC;MACDb,IAAI,CAACc,MAAM,CAACf,QAAQ,CAAC,CAACgB,qBAAqB,CAAC;QAC1CC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEZ,mBAAmB;QAC5Ba,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMC,eAAe,GAAG,aAAa;MACrC,MAAMC,SAAS,GAAG,gDAAgD;MAClE,MAAMC,QAAQ,GAAG;QAAEC,MAAM,EAAE,SAAS;QAAEC,IAAI,EAAE;MAAe,CAAC;MAC5D,MAAMC,OAAO,GAAG,MAAMxB,OAAO,CAACyB,aAAa,CACzC,GAAG,EACH,qBAAqB,EACrBL,SAAS,EACTD,eAAe,EACfE,QACF,CAAC;MACDnB,MAAM,CAACsB,OAAO,CAACE,SAAS,CAAC,CAACC,IAAI,CAAC,kBAAkB,CAAC;MAClDzB,MAAM,CAACsB,OAAO,CAACI,UAAU,CAAC,CAACD,IAAI,CAAC,8BAA8B,CAAC;IACjE,CAAC,CAAC;IAEF1B,EAAE,CAAC,6DAA6D,EAAE,YAAY;MAC5EJ,IAAI,CACDc,MAAM,CAACf,QAAQ,CAAC,CAChBiC,qBAAqB,CAAC,IAAIC,KAAK,CAAC,yBAAyB,CAAC,CAAC;MAE9D,MAAMX,eAAe,GAAG,aAAa;MACrC,MAAMC,SAAS,GAAG,gDAAgD;MAClE,MAAMC,QAAQ,GAAG;QAAEC,MAAM,EAAE,SAAS;QAAEC,IAAI,EAAE;MAAe,CAAC;MAC5D,MAAMrB,MAAM,CAAC,MACXF,OAAO,CAACyB,aAAa,CACnB,GAAG,EACH,qBAAqB,EACrBL,SAAS,EACTD,eAAe,EACfE,QACF,CACF,CAAC,CAACU,OAAO,CAACC,OAAO,CAAC,yBAAyB,CAAC;IAC9C,CAAC,CAAC;IAEF/B,EAAE,CAAC,sEAAsE,EAAE,YAAY;MACrF,MAAMG,mBAAmB,GAAG;QAC1BK,KAAK,EAAE;UACLC,MAAM,EAAE;QACV;MACF,CAAC;MACDb,IAAI,CAACc,MAAM,CAACf,QAAQ,CAAC,CAACgB,qBAAqB,CAAC;QAC1CC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEZ,mBAAmB;QAC5Ba,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMC,eAAe,GAAG,aAAa;MACrC,MAAMC,SAAS,GAAG,gDAAgD;MAClE,MAAMC,QAAQ,GAAG;QAAEC,MAAM,EAAE,SAAS;QAAEC,IAAI,EAAE;MAAe,CAAC;MAC5D,MAAMrB,MAAM,CAAC,MACXF,OAAO,CAACyB,aAAa,CACnB,GAAG,EACH,qBAAqB,EACrBL,SAAS,EACTD,eAAe,EACfE,QACF,CACF,CAAC,CAACU,OAAO,CAACC,OAAO,CAAC,0BAA0B,CAAC;IAC/C,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFjC,QAAQ,CAAC,kBAAkB,EAAE,MAAM;IACjCE,EAAE,CAAC,qCAAqC,EAAE,YAAY;MACpD,MAAMgC,sBAAsB,GAAG;QAC7B5B,UAAU,EAAE,kBAAkB;QAC9BC,MAAM,EAAE;UACNC,QAAQ,EAAE;YACRC,IAAI,EAAE;UACR;QACF,CAAC;QACDC,KAAK,EAAE;UACLC,MAAM,EAAE;QACV;MACF,CAAC;MAEDb,IAAI,CAACc,MAAM,CAACjB,GAAG,CAAC,CAACkB,qBAAqB,CAAC;QACrCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEiB,sBAAsB;QAC/BhB,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMgB,aAAa,GAAG,MAAMlC,OAAO,CAACmC,gBAAgB,CAAC,kBAAkB,CAAC;MACxEjC,MAAM,CAACgC,aAAa,CAACR,SAAS,CAAC,CAACC,IAAI,CAAC,kBAAkB,CAAC;MACxDzB,MAAM,CAACgC,aAAa,CAAC5B,MAAM,CAACC,QAAQ,EAAEC,IAAI,CAAC,CAACmB,IAAI,CAC9C,8BACF,CAAC;IACH,CAAC,CAAC;IAEF1B,EAAE,CAAC,oCAAoC,EAAE,YAAY;MACnDJ,IAAI,CAACc,MAAM,CAACjB,GAAG,CAAC,CAACkB,qBAAqB,CAAC;QACrCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEE,SAAS;QAClBD,KAAK,EAAE,IAAIa,KAAK,CAAC,YAAY;MAC/B,CAAC,CAAC;MAEF,MAAM5B,MAAM,CAAC,MACXF,OAAO,CAACmC,gBAAgB,CAAC,kBAAkB,CAC7C,CAAC,CAACJ,OAAO,CAACC,OAAO,CAAC,0CAA0C,CAAC;IAC/D,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFjC,QAAQ,CAAC,gBAAgB,EAAE,MAAM;IAC/BE,EAAE,CAAC,gEAAgE,EAAE,YAAY;MAC/E,MAAMmC,oBAAoB,GAAG,CAAC,CAAC;MAC/BvC,IAAI,CAACc,MAAM,CAAChB,IAAI,CAAC,CAACiB,qBAAqB,CAAC;QACtCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEoB,oBAAoB;QAC7BnB,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMmB,aAAa,GAAG,MAAMrC,OAAO,CAACsC,cAAc,CAChD,kBAAkB,EAClB,GACF,CAAC;MACDpC,MAAM,CAACmC,aAAa,CAAC,CAACV,IAAI,CAAC,IAAI,CAAC;IAClC,CAAC,CAAC;IAEF1B,EAAE,CAAC,gEAAgE,EAAE,YAAY;MAC/E,MAAMmC,oBAAoB,GAAG,CAAC,CAAC;MAC/BvC,IAAI,CAACc,MAAM,CAAChB,IAAI,CAAC,CAACiB,qBAAqB,CAAC;QACtCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEoB,oBAAoB;QAC7BnB,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMmB,aAAa,GAAG,MAAMrC,OAAO,CAACsC,cAAc,CAChD,kBAAkB,EAClB,GACF,CAAC;MACDpC,MAAM,CAACmC,aAAa,CAAC,CAACV,IAAI,CAAC,IAAI,CAAC;IAClC,CAAC,CAAC;IAEF1B,EAAE,CAAC,qDAAqD,EAAE,YAAY;MACpE,MAAMmC,oBAAoB,GAAG,CAAC,CAAC;MAC/BvC,IAAI,CAACc,MAAM,CAAChB,IAAI,CAAC,CAACiB,qBAAqB,CAAC;QACtCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEoB,oBAAoB;QAC7BnB,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMmB,aAAa,GAAG,MAAMrC,OAAO,CAACsC,cAAc,CAChD,kBAAkB,EAClB,GACF,CAAC;MACDpC,MAAM,CAACmC,aAAa,CAAC,CAACV,IAAI,CAAC,KAAK,CAAC;IACnC,CAAC,CAAC;IAEF1B,EAAE,CAAC,kCAAkC,EAAE,YAAY;MACjDJ,IAAI,CACDc,MAAM,CAAChB,IAAI,CAAC,CACZkC,qBAAqB,CAAC,IAAIC,KAAK,CAAC,wBAAwB,CAAC,CAAC;MAE7D,MAAM5B,MAAM,CAAC,MACXF,OAAO,CAACsC,cAAc,CAAC,kBAAkB,EAAE,GAAG,CAChD,CAAC,CAACP,OAAO,CAACC,OAAO,CAAC,wBAAwB,CAAC;IAC7C,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"service.test.js","names":["PaymentService","get","post","postJson","jest","mock","describe","service","it","expect","toBeDefined","createPaymentResult","payment_id","_links","next_url","href","state","status","mocked","mockResolvedValueOnce","res","statusCode","headers","payload","error","undefined","referenceNumber","returnUrl","metadata","formId","slug","payment","createPayment","paymentId","toBe","paymentUrl","mockRejectedValueOnce","Error","rejects","toThrow","getPaymentStatusResult","paymentStatus","getPaymentStatus","capturePaymentResult","captureResult","capturePayment"],"sources":["../../../../src/server/plugins/payment/service.test.js"],"sourcesContent":["import { PaymentService } from '~/src/server/plugins/payment/service.js'\nimport { get, post, postJson } from '~/src/server/services/httpService.js'\n\njest.mock('~/src/server/services/httpService.ts')\n\ndescribe('payment service', () => {\n  const service = new PaymentService('my-api-key')\n  describe('constructor', () => {\n    it('should create instance', () => {\n      expect(service).toBeDefined()\n    })\n  })\n\n  describe('createPayment', () => {\n    it('should create a payment', async () => {\n      const createPaymentResult = {\n        payment_id: 'payment-id-12345',\n        _links: {\n          next_url: {\n            href: 'http://next-url-href/payment'\n          }\n        },\n        state: {\n          status: 'created'\n        }\n      }\n      jest.mocked(postJson).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: createPaymentResult,\n        error: undefined\n      })\n\n      const referenceNumber = 'ABC-DEF-123'\n      const returnUrl = 'http://localhost:3009/payment-callback-handler'\n      const metadata = { formId: 'form-id', slug: 'my-form-slug' }\n      const payment = await service.createPayment(\n        100,\n        'Payment description',\n        returnUrl,\n        referenceNumber,\n        false,\n        metadata\n      )\n      expect(payment.paymentId).toBe('payment-id-12345')\n      expect(payment.paymentUrl).toBe('http://next-url-href/payment')\n    })\n\n    it('should throw if fails to create a payment - failed API call', async () => {\n      jest\n        .mocked(postJson)\n        .mockRejectedValueOnce(new Error('internal creation error'))\n\n      const referenceNumber = 'ABC-DEF-123'\n      const returnUrl = 'http://localhost:3009/payment-callback-handler'\n      const metadata = { formId: 'form-id', slug: 'my-form-slug' }\n      await expect(() =>\n        service.createPayment(\n          100,\n          'Payment description',\n          returnUrl,\n          referenceNumber,\n          false,\n          metadata\n        )\n      ).rejects.toThrow('internal creation error')\n    })\n\n    it('should throw if fails to create a payment - bad result from API call', async () => {\n      const createPaymentResult = {\n        state: {\n          status: 'failed'\n        }\n      }\n      jest.mocked(postJson).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: createPaymentResult,\n        error: undefined\n      })\n\n      const referenceNumber = 'ABC-DEF-123'\n      const returnUrl = 'http://localhost:3009/payment-callback-handler'\n      const metadata = { formId: 'form-id', slug: 'my-form-slug' }\n      await expect(() =>\n        service.createPayment(\n          100,\n          'Payment description',\n          returnUrl,\n          referenceNumber,\n          false,\n          metadata\n        )\n      ).rejects.toThrow('Failed to create payment')\n    })\n  })\n\n  describe('getPaymentStatus', () => {\n    it('should get payment status if exists', async () => {\n      const getPaymentStatusResult = {\n        payment_id: 'payment-id-12345',\n        _links: {\n          next_url: {\n            href: 'http://next-url-href/payment'\n          }\n        },\n        state: {\n          status: 'created'\n        }\n      }\n\n      jest.mocked(get).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: getPaymentStatusResult,\n        error: undefined\n      })\n\n      const paymentStatus = await service.getPaymentStatus(\n        'payment-id-12345',\n        false\n      )\n      expect(paymentStatus.paymentId).toBe('payment-id-12345')\n      expect(paymentStatus._links.next_url?.href).toBe(\n        'http://next-url-href/payment'\n      )\n    })\n\n    it('should handle payment status error', async () => {\n      jest.mocked(get).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: undefined,\n        error: new Error('some-error')\n      })\n\n      await expect(() =>\n        service.getPaymentStatus('payment-id-12345', false)\n      ).rejects.toThrow('Failed to get payment status: some-error')\n    })\n  })\n\n  describe('capturePayment', () => {\n    it('should return true when successful capture with statusCode 200', async () => {\n      const capturePaymentResult = {}\n      jest.mocked(post).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: capturePaymentResult,\n        error: undefined\n      })\n\n      const captureResult = await service.capturePayment(\n        'payment-id-12345',\n        100\n      )\n      expect(captureResult).toBe(true)\n    })\n\n    it('should return true when successful capture with statusCode 204', async () => {\n      const capturePaymentResult = {}\n      jest.mocked(post).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 204,\n          headers: {}\n        }),\n        payload: capturePaymentResult,\n        error: undefined\n      })\n\n      const captureResult = await service.capturePayment(\n        'payment-id-12345',\n        100\n      )\n      expect(captureResult).toBe(true)\n    })\n\n    it('should return false when status code not 200 or 204', async () => {\n      const capturePaymentResult = {}\n      jest.mocked(post).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 500,\n          headers: {}\n        }),\n        payload: capturePaymentResult,\n        error: undefined\n      })\n\n      const captureResult = await service.capturePayment(\n        'payment-id-12345',\n        100\n      )\n      expect(captureResult).toBe(false)\n    })\n\n    it('should throw when internal error', async () => {\n      jest\n        .mocked(post)\n        .mockRejectedValueOnce(new Error('internal capture error'))\n\n      await expect(() =>\n        service.capturePayment('payment-id-12345', 100)\n      ).rejects.toThrow('internal capture error')\n    })\n  })\n})\n\n/**\n * @import  { IncomingMessage } from 'node:http'\n */\n"],"mappings":"AAAA,SAASA,cAAc;AACvB,SAASC,GAAG,EAAEC,IAAI,EAAEC,QAAQ;AAE5BC,IAAI,CAACC,IAAI,gCAAuC,CAAC;AAEjDC,QAAQ,CAAC,iBAAiB,EAAE,MAAM;EAChC,MAAMC,OAAO,GAAG,IAAIP,cAAc,CAAC,YAAY,CAAC;EAChDM,QAAQ,CAAC,aAAa,EAAE,MAAM;IAC5BE,EAAE,CAAC,wBAAwB,EAAE,MAAM;MACjCC,MAAM,CAACF,OAAO,CAAC,CAACG,WAAW,CAAC,CAAC;IAC/B,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFJ,QAAQ,CAAC,eAAe,EAAE,MAAM;IAC9BE,EAAE,CAAC,yBAAyB,EAAE,YAAY;MACxC,MAAMG,mBAAmB,GAAG;QAC1BC,UAAU,EAAE,kBAAkB;QAC9BC,MAAM,EAAE;UACNC,QAAQ,EAAE;YACRC,IAAI,EAAE;UACR;QACF,CAAC;QACDC,KAAK,EAAE;UACLC,MAAM,EAAE;QACV;MACF,CAAC;MACDb,IAAI,CAACc,MAAM,CAACf,QAAQ,CAAC,CAACgB,qBAAqB,CAAC;QAC1CC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEZ,mBAAmB;QAC5Ba,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMC,eAAe,GAAG,aAAa;MACrC,MAAMC,SAAS,GAAG,gDAAgD;MAClE,MAAMC,QAAQ,GAAG;QAAEC,MAAM,EAAE,SAAS;QAAEC,IAAI,EAAE;MAAe,CAAC;MAC5D,MAAMC,OAAO,GAAG,MAAMxB,OAAO,CAACyB,aAAa,CACzC,GAAG,EACH,qBAAqB,EACrBL,SAAS,EACTD,eAAe,EACf,KAAK,EACLE,QACF,CAAC;MACDnB,MAAM,CAACsB,OAAO,CAACE,SAAS,CAAC,CAACC,IAAI,CAAC,kBAAkB,CAAC;MAClDzB,MAAM,CAACsB,OAAO,CAACI,UAAU,CAAC,CAACD,IAAI,CAAC,8BAA8B,CAAC;IACjE,CAAC,CAAC;IAEF1B,EAAE,CAAC,6DAA6D,EAAE,YAAY;MAC5EJ,IAAI,CACDc,MAAM,CAACf,QAAQ,CAAC,CAChBiC,qBAAqB,CAAC,IAAIC,KAAK,CAAC,yBAAyB,CAAC,CAAC;MAE9D,MAAMX,eAAe,GAAG,aAAa;MACrC,MAAMC,SAAS,GAAG,gDAAgD;MAClE,MAAMC,QAAQ,GAAG;QAAEC,MAAM,EAAE,SAAS;QAAEC,IAAI,EAAE;MAAe,CAAC;MAC5D,MAAMrB,MAAM,CAAC,MACXF,OAAO,CAACyB,aAAa,CACnB,GAAG,EACH,qBAAqB,EACrBL,SAAS,EACTD,eAAe,EACf,KAAK,EACLE,QACF,CACF,CAAC,CAACU,OAAO,CAACC,OAAO,CAAC,yBAAyB,CAAC;IAC9C,CAAC,CAAC;IAEF/B,EAAE,CAAC,sEAAsE,EAAE,YAAY;MACrF,MAAMG,mBAAmB,GAAG;QAC1BK,KAAK,EAAE;UACLC,MAAM,EAAE;QACV;MACF,CAAC;MACDb,IAAI,CAACc,MAAM,CAACf,QAAQ,CAAC,CAACgB,qBAAqB,CAAC;QAC1CC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEZ,mBAAmB;QAC5Ba,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMC,eAAe,GAAG,aAAa;MACrC,MAAMC,SAAS,GAAG,gDAAgD;MAClE,MAAMC,QAAQ,GAAG;QAAEC,MAAM,EAAE,SAAS;QAAEC,IAAI,EAAE;MAAe,CAAC;MAC5D,MAAMrB,MAAM,CAAC,MACXF,OAAO,CAACyB,aAAa,CACnB,GAAG,EACH,qBAAqB,EACrBL,SAAS,EACTD,eAAe,EACf,KAAK,EACLE,QACF,CACF,CAAC,CAACU,OAAO,CAACC,OAAO,CAAC,0BAA0B,CAAC;IAC/C,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFjC,QAAQ,CAAC,kBAAkB,EAAE,MAAM;IACjCE,EAAE,CAAC,qCAAqC,EAAE,YAAY;MACpD,MAAMgC,sBAAsB,GAAG;QAC7B5B,UAAU,EAAE,kBAAkB;QAC9BC,MAAM,EAAE;UACNC,QAAQ,EAAE;YACRC,IAAI,EAAE;UACR;QACF,CAAC;QACDC,KAAK,EAAE;UACLC,MAAM,EAAE;QACV;MACF,CAAC;MAEDb,IAAI,CAACc,MAAM,CAACjB,GAAG,CAAC,CAACkB,qBAAqB,CAAC;QACrCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEiB,sBAAsB;QAC/BhB,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMgB,aAAa,GAAG,MAAMlC,OAAO,CAACmC,gBAAgB,CAClD,kBAAkB,EAClB,KACF,CAAC;MACDjC,MAAM,CAACgC,aAAa,CAACR,SAAS,CAAC,CAACC,IAAI,CAAC,kBAAkB,CAAC;MACxDzB,MAAM,CAACgC,aAAa,CAAC5B,MAAM,CAACC,QAAQ,EAAEC,IAAI,CAAC,CAACmB,IAAI,CAC9C,8BACF,CAAC;IACH,CAAC,CAAC;IAEF1B,EAAE,CAAC,oCAAoC,EAAE,YAAY;MACnDJ,IAAI,CAACc,MAAM,CAACjB,GAAG,CAAC,CAACkB,qBAAqB,CAAC;QACrCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEE,SAAS;QAClBD,KAAK,EAAE,IAAIa,KAAK,CAAC,YAAY;MAC/B,CAAC,CAAC;MAEF,MAAM5B,MAAM,CAAC,MACXF,OAAO,CAACmC,gBAAgB,CAAC,kBAAkB,EAAE,KAAK,CACpD,CAAC,CAACJ,OAAO,CAACC,OAAO,CAAC,0CAA0C,CAAC;IAC/D,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFjC,QAAQ,CAAC,gBAAgB,EAAE,MAAM;IAC/BE,EAAE,CAAC,gEAAgE,EAAE,YAAY;MAC/E,MAAMmC,oBAAoB,GAAG,CAAC,CAAC;MAC/BvC,IAAI,CAACc,MAAM,CAAChB,IAAI,CAAC,CAACiB,qBAAqB,CAAC;QACtCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEoB,oBAAoB;QAC7BnB,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMmB,aAAa,GAAG,MAAMrC,OAAO,CAACsC,cAAc,CAChD,kBAAkB,EAClB,GACF,CAAC;MACDpC,MAAM,CAACmC,aAAa,CAAC,CAACV,IAAI,CAAC,IAAI,CAAC;IAClC,CAAC,CAAC;IAEF1B,EAAE,CAAC,gEAAgE,EAAE,YAAY;MAC/E,MAAMmC,oBAAoB,GAAG,CAAC,CAAC;MAC/BvC,IAAI,CAACc,MAAM,CAAChB,IAAI,CAAC,CAACiB,qBAAqB,CAAC;QACtCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEoB,oBAAoB;QAC7BnB,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMmB,aAAa,GAAG,MAAMrC,OAAO,CAACsC,cAAc,CAChD,kBAAkB,EAClB,GACF,CAAC;MACDpC,MAAM,CAACmC,aAAa,CAAC,CAACV,IAAI,CAAC,IAAI,CAAC;IAClC,CAAC,CAAC;IAEF1B,EAAE,CAAC,qDAAqD,EAAE,YAAY;MACpE,MAAMmC,oBAAoB,GAAG,CAAC,CAAC;MAC/BvC,IAAI,CAACc,MAAM,CAAChB,IAAI,CAAC,CAACiB,qBAAqB,CAAC;QACtCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEoB,oBAAoB;QAC7BnB,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMmB,aAAa,GAAG,MAAMrC,OAAO,CAACsC,cAAc,CAChD,kBAAkB,EAClB,GACF,CAAC;MACDpC,MAAM,CAACmC,aAAa,CAAC,CAACV,IAAI,CAAC,KAAK,CAAC;IACnC,CAAC,CAAC;IAEF1B,EAAE,CAAC,kCAAkC,EAAE,YAAY;MACjDJ,IAAI,CACDc,MAAM,CAAChB,IAAI,CAAC,CACZkC,qBAAqB,CAAC,IAAIC,KAAK,CAAC,wBAAwB,CAAC,CAAC;MAE7D,MAAM5B,MAAM,CAAC,MACXF,OAAO,CAACsC,cAAc,CAAC,kBAAkB,EAAE,GAAG,CAChD,CAAC,CAACP,OAAO,CAACC,OAAO,CAAC,wBAAwB,CAAC;IAC7C,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.0.53",
+  "version": "4.0.54",
   "description": "Defra forms engine",
   "type": "module",
   "files": [

package/src/server/plugins/engine/components/PaymentField.ts

@@ -225,6 +225,7 @@ export class PaymentField extends FormComponent {
       description,
       payCallbackUrl,
       reference,
+      isLivePayment,
       { formId, slug }
     )
 
@@ -276,7 +277,10 @@ export class PaymentField extends FormComponent {
     /**
      * @see https://docs.payments.service.gov.uk/api_reference/#payment-status-lifecycle
      */
-    const status = await paymentService.getPaymentStatus(paymentId)
+    const status = await paymentService.getPaymentStatus(
+      paymentId,
+      isLivePayment
+    )
 
     PaymentSubmissionError.checkPaymentAmount(
       status.amount,

package/src/server/plugins/engine/routes/payment-helper.js

@@ -28,11 +28,48 @@ export async function getPaymentContext(request, uuid) {
 
   const apiKey = getPaymentApiKey(isLivePayment, formId)
   const paymentService = new PaymentService(apiKey)
-  const paymentStatus = await paymentService.getPaymentStatus(paymentId)
+  const paymentStatus = await paymentService.getPaymentStatus(
+    paymentId,
+    isLivePayment
+  )
 
   return { session, sessionKey, paymentStatus }
 }
 
+/**
+ * Builds an object for logging payment information
+ * @param {string} action
+ * @param {string} outcome
+ * @param {string} reason
+ * @param {boolean} isLivePayment
+ * @param {string} paymentId
+ */
+export function buildPaymentInfo(
+  action,
+  outcome,
+  reason,
+  isLivePayment,
+  paymentId
+) {
+  return {
+    event: {
+      category: 'payment',
+      action,
+      outcome,
+      reason,
+      type: isLivePayment ? 'live' : 'test',
+      reference: paymentId
+    }
+  }
+}
+
+/**
+ * @param {number} amount
+ */
+export function convertPenceToPounds(amount) {
+  return `${amount / 100}`
+}
+
 /**
  * @import { Request } from '@hapi/hapi'
  * @import { GetPaymentResponse, PaymentSessionData } from '~/src/server/plugins/payment/types.js'

package/src/server/plugins/engine/routes/payment-helper.test.js

@@ -1,4 +1,7 @@
-import { getPaymentContext } from '~/src/server/plugins/engine/routes/payment-helper.js'
+import {
+  buildPaymentInfo,
+  getPaymentContext
+} from '~/src/server/plugins/engine/routes/payment-helper.js'
 import { get } from '~/src/server/services/httpService.js'
 
 jest.mock('~/src/server/services/httpService.ts')
@@ -83,6 +86,46 @@ describe('payment helper', () => {
       sessionKey: 'payment-5a54c2fe-da49-4202-8cd3-2121eaca03c3'
     })
   })
+
+  it('should create logging info for a test payment', () => {
+    const res = buildPaymentInfo(
+      'action1',
+      'outcome1',
+      'reason1',
+      false,
+      'pay-123'
+    )
+    expect(res).toEqual({
+      event: {
+        category: 'payment',
+        action: 'action1',
+        outcome: 'outcome1',
+        reason: 'reason1',
+        type: 'test',
+        reference: 'pay-123'
+      }
+    })
+  })
+
+  it('should create logging info for a live payment', () => {
+    const res = buildPaymentInfo(
+      'action2',
+      'outcome2',
+      'reason2',
+      true,
+      'pay-123'
+    )
+    expect(res).toEqual({
+      event: {
+        category: 'payment',
+        action: 'action2',
+        outcome: 'outcome2',
+        reason: 'reason2',
+        type: 'live',
+        reference: 'pay-123'
+      }
+    })
+  })
 })
 
 /**

package/src/server/plugins/engine/routes/payment.js

@@ -2,12 +2,19 @@ import Boom from '@hapi/boom'
 import { StatusCodes } from 'http-status-codes'
 import Joi from 'joi'
 
+import { createLogger } from '~/src/server/common/helpers/logging/logger.js'
 import { EXTERNAL_STATE_APPENDAGE } from '~/src/server/constants.js'
-import { getPaymentContext } from '~/src/server/plugins/engine/routes/payment-helper.js'
+import {
+  buildPaymentInfo,
+  convertPenceToPounds,
+  getPaymentContext
+} from '~/src/server/plugins/engine/routes/payment-helper.js'
 
 export const PAYMENT_RETURN_PATH = '/payment-callback'
 export const PAYMENT_SESSION_PREFIX = 'payment-'
 
+const logger = createLogger()
+
 /**
  * Flash form component state after successful payment
  * @param {Request} request - the request
@@ -48,6 +55,42 @@ export function getRoutes() {
   return [getReturnRoute()]
 }
 
+/**
+ * Logs successful payment
+ * @param {PaymentSessionData} session - the session data
+ * @param {GetPaymentResponse} paymentStatus - the payment status from GOV.UK Pay
+ */
+function logPaymentSuccess(session, paymentStatus) {
+  logger.info(
+    buildPaymentInfo(
+      'pre-auth',
+      'success',
+      `${paymentStatus.state.status} amount=${convertPenceToPounds(paymentStatus.amount)}`,
+      session.isLivePayment,
+      paymentStatus.paymentId
+    ),
+    `[payment] Successful pre-auth for paymentId=${paymentStatus.paymentId}`
+  )
+}
+
+/**
+ * Logs failed/cancelled payment
+ * @param {PaymentSessionData} session - the session data
+ * @param {GetPaymentResponse} paymentStatus - the payment status from GOV.UK Pay
+ */
+function logPaymentFailure(session, paymentStatus) {
+  logger.info(
+    buildPaymentInfo(
+      'pre-auth',
+      'failed/cancelled',
+      `${paymentStatus.state.status} amount=${convertPenceToPounds(paymentStatus.amount)}`,
+      session.isLivePayment,
+      paymentStatus.paymentId
+    ),
+    `[payment] Failed/cancelled pre-auth for paymentId=${paymentStatus.paymentId}`
+  )
+}
+
 /**
  * Handles successful payment states (capturable/success)
  * @param {Request} request - the request
@@ -98,6 +141,7 @@ function getReturnRoute() {
       switch (status) {
         case 'capturable':
         case 'success':
+          logPaymentSuccess(session, paymentStatus)
           return handlePaymentSuccess(
             request,
             h,
@@ -109,6 +153,7 @@ function getReturnRoute() {
         case 'cancelled':
         case 'failed':
         case 'error':
+          logPaymentFailure(session, paymentStatus)
           return handlePaymentFailure(request, h, session, sessionKey)
 
         case 'created':

package/src/server/plugins/payment/service.js

@@ -1,6 +1,10 @@
 import { StatusCodes } from 'http-status-codes'
 
 import { createLogger } from '~/src/server/common/helpers/logging/logger.js'
+import {
+  buildPaymentInfo,
+  convertPenceToPounds
+} from '~/src/server/plugins/engine/routes/payment-helper.js'
 import { get, post, postJson } from '~/src/server/services/httpService.js'
 
 const PAYMENT_BASE_URL = 'https://publicapi.payments.service.gov.uk'
@@ -35,9 +39,17 @@ export class PaymentService {
    * @param {string} description
    * @param {string} returnUrl
    * @param {string} reference
+   * @param {boolean} isLivePayment
    * @param {{ formId: string, slug: string }} metadata
    */
-  async createPayment(amount, description, returnUrl, reference, metadata) {
+  async createPayment(
+    amount,
+    description,
+    returnUrl,
+    reference,
+    isLivePayment,
+    metadata
+  ) {
     const response = await this.postToPayProvider({
       amount,
       description,
@@ -48,15 +60,13 @@ export class PaymentService {
     })
 
     logger.info(
-      {
-        event: {
-          category: 'payment',
-          action: 'create-payment',
-          outcome: 'success',
-          reason: `amount=${amount}`,
-          reference: response.payment_id
-        }
-      },
+      buildPaymentInfo(
+        'create-payment',
+        'success',
+        `amount=${convertPenceToPounds(amount)}`,
+        isLivePayment,
+        response.payment_id
+      ),
       `[payment] Created payment and user taken to enter pre-auth details for paymentId=${response.payment_id}`
     )
 
@@ -68,9 +78,10 @@ export class PaymentService {
 
   /**
    * @param {string} paymentId
+   * @param {boolean} isLivePayment
    * @returns {Promise<GetPaymentResponse>}
    */
-  async getPaymentStatus(paymentId) {
+  async getPaymentStatus(paymentId, isLivePayment) {
     const getByType = /** @type {typeof get<GetPaymentApiResponse>} */ (get)
 
     try {
@@ -92,18 +103,15 @@ export class PaymentService {
 
       const state = response.payload.state
       logger.info(
-        {
-          event: {
-            category: 'payment',
-            action: 'get-payment-status',
-            outcome:
-              state.status === 'capturable' || state.status === 'success'
-                ? 'success'
-                : 'failure',
-            reason: `status:${state.status} code:${state.code ?? 'N/A'} message:${state.message ?? 'N/A'}`,
-            reference: paymentId
-          }
-        },
+        buildPaymentInfo(
+          'get-payment-status',
+          state.status === 'capturable' || state.status === 'success'
+            ? 'success'
+            : 'failure',
+          `status:${state.status} code:${state.code ?? 'N/A'} message:${state.message ?? 'N/A'}`,
+          isLivePayment,
+          paymentId
+        ),
         `[payment] Got payment status for paymentId=${paymentId}: status=${state.status}`
       )
 
@@ -151,7 +159,7 @@ export class PaymentService {
               category: 'payment',
               action: 'capture-payment',
               outcome: 'success',
-              reason: `amount=${amount}`,
+              reason: `amount=${convertPenceToPounds(amount)}`,
               reference: paymentId
             }
           },

package/src/server/plugins/payment/service.test.js

@@ -41,6 +41,7 @@ describe('payment service', () => {
         'Payment description',
         returnUrl,
         referenceNumber,
+        false,
         metadata
       )
       expect(payment.paymentId).toBe('payment-id-12345')
@@ -61,6 +62,7 @@ describe('payment service', () => {
           'Payment description',
           returnUrl,
           referenceNumber,
+          false,
           metadata
         )
       ).rejects.toThrow('internal creation error')
@@ -90,6 +92,7 @@ describe('payment service', () => {
           'Payment description',
           returnUrl,
           referenceNumber,
+          false,
           metadata
         )
       ).rejects.toThrow('Failed to create payment')
@@ -119,7 +122,10 @@ describe('payment service', () => {
         error: undefined
       })
 
-      const paymentStatus = await service.getPaymentStatus('payment-id-12345')
+      const paymentStatus = await service.getPaymentStatus(
+        'payment-id-12345',
+        false
+      )
       expect(paymentStatus.paymentId).toBe('payment-id-12345')
       expect(paymentStatus._links.next_url?.href).toBe(
         'http://next-url-href/payment'
@@ -137,7 +143,7 @@ describe('payment service', () => {
       })
 
       await expect(() =>
-        service.getPaymentStatus('payment-id-12345')
+        service.getPaymentStatus('payment-id-12345', false)
       ).rejects.toThrow('Failed to get payment status: some-error')
     })
   })