feat(backend): Update handling of OutgoingPaymentCardDetails

packages/backend/migrations/20250919105030_update_outgoing_payment_card_details_data.js

@@ -0,0 +1,29 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function (knex) {
+  return knex.schema.alterTable('outgoingPaymentCardDetails', function (table) {
+    table.dropColumn('expiry')
+    table.dropColumn('signature')
+
+    table.uuid('requestId').notNullable()
+    table.jsonb('data').notNullable()
+    table.timestamp('initiatedAt').notNullable()
+  })
+}
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function (knex) {
+  return knex.schema.alterTable('outgoingPaymentCardDetails', function (table) {
+    table.dropColumn('requestId')
+    table.dropColumn('data')
+    table.dropColumn('initiatedAt')
+
+    table.string('signature').notNullable()
+    table.string('expiry').notNullable()
+  })
+}

packages/backend/src/graphql/schema.graphql

@@ -1248,8 +1248,9 @@ input CreateOutgoingPaymentInput {
 }
 
 input CardDetailsInput {
-  "Signature"
-  signature: String!
+  data: JSONObject!
+  requestId: String!
+  initiatedAt: String!
 }
 
 input CancelOutgoingPaymentInput {

packages/backend/src/open_payments/payment/outgoing/card/model.ts

@@ -8,8 +8,9 @@ export const outgoingPaymentCardDetailsRelation: OutgoingPaymentIdRelation =
   'outgoingPaymentCardDetails.outgoingPaymentId'
 
 type OutgoingPaymentCardDetailsType = {
-  expiry: string
-  signature: string
+  requestId: string
+  data: Record<string, unknown>
+  initiatedAt: Date
 } & {
   [key in OutgoingPaymentIdColumnName]: string
 }
@@ -22,7 +23,8 @@ export class OutgoingPaymentCardDetails
     return 'outgoingPaymentCardDetails'
   }
 
-  public expiry!: string
   public readonly outgoingPaymentId!: string
-  public signature!: string
+  public requestId!: string
+  public data!: Record<string, unknown>
+  public initiatedAt!: Date
 }

packages/backend/src/open_payments/payment/outgoing/model.ts

@@ -209,6 +209,13 @@ export class OutgoingPayment
     if (this.grantId) {
       data.grantId = this.grantId
     }
+    if (this.cardDetails) {
+      data.cardDetails = {
+        requestId: this.cardDetails.requestId,
+        data: this.cardDetails.data,
+        initiatedAt: this.cardDetails.initiatedAt
+      }
+    }
     return data
   }
 
@@ -296,6 +303,10 @@ export type PaymentData = Omit<OutgoingPaymentResponse, 'failed'> & {
   stateAttempts: number
   balance: string
   grantId?: string
+  cardDetails?: Pick<
+    OutgoingPaymentCardDetails,
+    'requestId' | 'data' | 'initiatedAt'
+  >
 }
 
 export const isOutgoingPaymentEventType = (

packages/backend/src/open_payments/payment/outgoing/service.test.ts

@@ -67,6 +67,7 @@ import {
 } from '../../../tests/tenantSettings'
 import { OpenPaymentsPaymentMethod } from '../../../payment-method/provider/service'
 import { IlpAddress } from 'ilp-packet'
+import { OutgoingPaymentCardDetails } from './card/model'
 
 describe('OutgoingPaymentService', (): void => {
   let deps: IocContract<AppServices>
@@ -1493,7 +1494,8 @@ describe('OutgoingPaymentService', (): void => {
         }
       )
     })
-    test('failed to create when expiry is not valid', async () => {
+
+    test('stores card details when card payment', async () => {
       const paymentMethods: OpenPaymentsPaymentMethod[] = [
         {
           type: 'ilp',
@@ -1512,19 +1514,28 @@ describe('OutgoingPaymentService', (): void => {
         incomingPayment: incomingPayment.toOpenPaymentsTypeWithMethods(
           config.openPaymentsUrl,
           receiverWalletAddress,
-
           paymentMethods
         ).id,
         tenantId,
         cardDetails: {
-          expiry: 'invalid',
-          signature: 'test'
+          requestId: crypto.randomUUID(),
+          initiatedAt: new Date(),
+          data: {
+            signature: 'signature',
+            payload: 'payload'
+          }
         }
       }
 
-      const payment = await outgoingPaymentService.create(options)
-      expect(isOutgoingPaymentError(payment)).toBeTruthy()
-      expect(payment).toBe(OutgoingPaymentError.InvalidCardExpiry)
+      const outgoingPayment = await outgoingPaymentService.create(options)
+
+      assert(outgoingPayment instanceof OutgoingPayment)
+
+      const cardDetails = await OutgoingPaymentCardDetails.query(knex).where({
+        outgoingPaymentId: outgoingPayment.id
+      })
+
+      expect(cardDetails).toHaveLength(1)
     })
   })
 

packages/backend/src/open_payments/payment/outgoing/service.ts

@@ -202,8 +202,9 @@ export interface CreateFromIncomingPayment extends BaseOptions {
 
 export interface CreateFromCardPayment extends CreateFromIncomingPayment {
   cardDetails: {
-    expiry: string
-    signature: string
+    requestId: string
+    data: Record<string, unknown>
+    initiatedAt: Date
   }
 }
 
@@ -221,11 +222,7 @@ export type CreateOutgoingPaymentOptions =
 export function isCreateFromCardPayment(
   options: CreateOutgoingPaymentOptions
 ): options is CreateFromCardPayment {
-  return (
-    'cardDetails' in options &&
-    'expiry' in options.cardDetails &&
-    'signature' in options.cardDetails
-  )
+  return 'cardDetails' in options && 'requestId' in options.cardDetails
 }
 
 export function isCreateFromIncomingPayment(
@@ -399,17 +396,15 @@ async function createOutgoingPayment(
           })
 
           if (isCreateFromCardPayment(options)) {
-            const { expiry, signature } = options.cardDetails
-
-            if (!isExpiryFormat(expiry))
-              throw OutgoingPaymentError.InvalidCardExpiry
+            const { data, requestId, initiatedAt } = options.cardDetails
 
             payment.cardDetails = await OutgoingPaymentCardDetails.query(
               trx
             ).insertAndFetch({
               outgoingPaymentId: payment.id,
-              expiry,
-              signature
+              requestId,
+              data,
+              initiatedAt
             })
           }
 
@@ -823,7 +818,3 @@ function validateSentAmount(
   )
   throw new Error(errorMessage)
 }
-
-function isExpiryFormat(expiry: string): boolean {
-  return !!expiry.match(/^(0[1-9]|1[0-2])\/(\d{2})$/)
-}

packages/backend/src/openapi/specs/webhooks.yaml

@@ -242,6 +242,16 @@ components:
             grantId:
               type: string
               format: uuid
+            cardDetails:
+              type: object
+              properties:
+                data:
+                  type: object
+                requestId:
+                  type: string
+                initiatedAt:
+                  type: string
+                  format: date-time
       additionalProperties: false
     walletAddressNotFound:
       required: