feat(point-of-sale): allow refunding incoming payments

Author: njlie

packages/point-of-sale/src/app.ts

@@ -9,7 +9,8 @@ import cors from '@koa/cors'
 import {
   GetPaymentsContext,
   PaymentContext,
-  PaymentRoutes
+  PaymentRoutes,
+  RefundContext
 } from './payments/routes'
 import {
   HandleWebhookContext,
@@ -93,6 +94,13 @@ export class App {
     // Initiate a payment
     router.post<DefaultState, PaymentContext>('/payment', paymentRoutes.payment)
 
+    // POST /refund
+    // Refund a payment
+    router.post<DefaultState, RefundContext>(
+      '/refund',
+      paymentRoutes.refundPayment
+    )
+
     // POST /webhook-events
     // Handle webhook
     // Currently only handles incoming_payment.completed webhooks

packages/point-of-sale/src/graphql/generated/graphql.ts

@@ -0,0 +1,15 @@
+import { gql } from '@apollo/client'
+
+export const CREATE_OUTGOING_PAYMENT_FROM_INCOMING_PAYMENT = gql`
+  mutation CreateOutgoingPaymentFromIncomingPayment(
+    $input: CreateOutgoingPaymentFromIncomingPaymentInput!
+  ) {
+    createOutgoingPaymentFromIncomingPayment(input: $input) {
+      payment {
+        id
+        walletAddressId
+        createdAt
+      }
+    }
+  }
+`

packages/point-of-sale/src/graphql/mutations/createOutgoingPaymentFromIncomingPayment.ts

@@ -0,0 +1,17 @@
+import { gql } from '@apollo/client'
+
+export const CREATE_RECEIVER = gql`
+  mutation CreateReceiver($input: CreateReceiverInput!) {
+    createReceiver(input: $input) {
+      receiver {
+        id
+        metadata
+        incomingAmount {
+          value
+          assetCode
+          assetScale
+        }
+      }
+    }
+  }
+`

packages/point-of-sale/src/graphql/mutations/createReceiver.ts

@@ -0,0 +1,15 @@
+import { gql } from '@apollo/client'
+
+export const GET_INCOMING_PAYMENT = gql`
+  query GetIncomingPaymentSenderAndAmount($id: String!) {
+    incomingPayment(id: $id) {
+      id
+      senderWalletAddress
+      incomingAmount {
+        value
+        assetCode
+        assetScale
+      }
+    }
+  }
+`

packages/point-of-sale/src/graphql/queries/getIncomingPayment.ts

@@ -376,6 +376,32 @@ describe('Payment Routes', () => {
       })
     })
   })
+
+  describe('refund payment', () => {
+    test('returns 200 when refunding incoming payment', async (): Promise<void> => {
+      const ctx = createRefundContext()
+      jest
+        .spyOn(paymentService, 'refundIncomingPayment')
+        .mockResolvedValueOnce({
+          id: v4()
+        })
+
+      await paymentRoutes.refundPayment(ctx)
+      expect(ctx.status).toEqual(200)
+    })
+
+    test('returns 400 if incoming payment refund fails', async (): Promise<void> => {
+      const ctx = createRefundContext()
+      const refundError = new Error('Failed to refund incoming payment')
+      jest
+        .spyOn(paymentService, 'refundIncomingPayment')
+        .mockRejectedValueOnce(refundError)
+
+      await paymentRoutes.refundPayment(ctx)
+      expect(ctx.status).toEqual(400)
+      expect(ctx.body).toEqual(refundError.message)
+    })
+  })
 })
 
 function createPaymentContext(bodyOverrides?: Record<string, unknown>) {
@@ -416,3 +442,15 @@ function createGetPaymentsContext(
     query
   })
 }
+
+function createRefundContext() {
+  return createContext<RefundContext>({
+    headers: { Accept: 'application/json' },
+    method: 'POST',
+    url: '/refund',
+    body: {
+      incomingPaymentId: v4(),
+      posWalletAddress: faker.internet.url()
+    }
+  })
+}

packages/point-of-sale/src/payments/routes.test.ts

@@ -68,9 +68,23 @@ export type GetPaymentsContext = Exclude<AppContext, 'request'> & {
   request: GetPaymentsRequest
 }
 
+export interface RefundRequestBody {
+  incomingPaymentId: string
+  posWalletAddress: string
+}
+
+export type RefundRequest = Exclude<AppContext['request'], 'body'> & {
+  body: RefundRequestBody
+}
+
+export type RefundContext = Exclude<AppContext, ['request']> & {
+  request: RefundRequest
+}
+
 export interface PaymentRoutes {
   getPayments(ctx: GetPaymentsContext): Promise<void>
   payment(ctx: PaymentContext): Promise<void>
+  refundPayment(ctx: RefundContext): Promise<void>
 }
 
 export function createPaymentRoutes(deps_: ServiceDependencies): PaymentRoutes {
@@ -85,7 +99,8 @@ export function createPaymentRoutes(deps_: ServiceDependencies): PaymentRoutes {
 
   return {
     payment: (ctx: PaymentContext) => payment(deps, ctx),
-    getPayments: (ctx: GetPaymentsContext) => getPayments(deps, ctx)
+    getPayments: (ctx: GetPaymentsContext) => getPayments(deps, ctx),
+    refundPayment: (ctx: RefundContext) => refundPayment(deps, ctx)
   }
 }
 
@@ -184,6 +199,24 @@ async function payment(
   }
 }
 
+async function refundPayment(
+  deps: ServiceDependencies,
+  ctx: RefundContext
+): Promise<void> {
+  const { incomingPaymentId, posWalletAddress } = ctx.request.body
+  try {
+    await deps.paymentService.refundIncomingPayment(
+      incomingPaymentId,
+      posWalletAddress
+    )
+    return
+  } catch (err) {
+    ctx.status = 400
+    ctx.body = (err as Error).message
+    return
+  }
+}
+
 async function waitForIncomingPaymentEvent(
   config: IAppConfig,
   deferred: Deferred<WebhookBody>