feat: CreateRecurringDebitAchPayment (#372)

* CreateRecurringDebitAchPaymentRequest

* lint-fix

---------

Co-authored-by: Ilya Merman <[email protected]>

Author: axshani

tests/recurringPayments.spec.ts

@@ -1,18 +1,17 @@
 import { Unit } from "../unit"
-import { createIndividualAccount } from "./testHelpers"
+import { createCounterparty, createIndividualAccount } from "./testHelpers"
 
 import dotenv from "dotenv"
-import { CreateRecurringCreditAchPaymentRequest, CreateRecurringCreditBookPaymentRequest, CreateRecurringPaymentRequest, RecurringCreditAchPayment, RecurringCreditBookPayment } from "../types/recurringPayment"
-import { createCounterpartyForTest } from "./counterparties.spec"
+import { CreateRecurringCreditAchPaymentRequest, CreateRecurringCreditBookPaymentRequest, CreateRecurringDebitAchPaymentRequest, RecurringCreditAchPayment, RecurringCreditBookPayment } from "../types/recurringPayment"
 dotenv.config()
 const unit = new Unit(process.env.UNIT_TOKEN || "test", process.env.UNIT_API_URL || "test")
 
 describe("Create", () => {
     test("create CreateRecurringCreditAchPayment", async () => {
         const createDepositAccountRes = await createIndividualAccount(unit)
-        const createCounterpartRes = await createCounterpartyForTest("22603")
+        const counterpartyId = await createCounterparty(unit)
 
-        const req: CreateRecurringPaymentRequest = {
+        const req: CreateRecurringCreditAchPaymentRequest = {
             "type": "recurringCreditAchPayment",
             "attributes": {
                 "schedule": {
@@ -32,7 +31,7 @@ describe("Create", () => {
                 "counterparty": {
                     "data": {
                         "type": "counterparty",
-                        "id": createCounterpartRes.data.id
+                        "id": counterpartyId
                     }
                 }
             }
@@ -224,3 +223,40 @@ describe("Request recurringCreditAchPayment", () => {
         expect(req.type).toBe("recurringCreditAchPayment")
     })
 })
+
+describe("Create RecurringDebitAchPayment Test", () => {
+    test("Create CreateRecurringDebitAchPayment", async () => {
+        const accountId = (await createIndividualAccount(unit)).data.id
+        const counterpartyId = await createCounterparty(unit)
+
+        const req: CreateRecurringDebitAchPaymentRequest = {
+            "type": "recurringDebitAchPayment",
+            "attributes": {
+                "schedule": {
+                    "interval": "Monthly",
+                    "dayOfMonth": 16,
+                    "totalNumberOfPayments": 12
+                },
+                "amount": 1000,
+                "description": "Rent-Apt15"
+            },
+            "relationships": {
+                "account": {
+                    "data": {
+                        "type": "depositAccount",
+                        "id": accountId
+                    }
+                },
+                "counterparty": {
+                    "data": {
+                        "type": "counterparty",
+                        "id": counterpartyId
+                    }
+                }
+            }
+        }
+
+        const res = await unit.recurringPayments.create(req)
+        expect(res.data.type).toBe("recurringDebitAchPayment")
+    })
+})

types/recurringPayment.ts

@@ -5,7 +5,7 @@ export type RecurringPaymentStatus = "Active" | "Completed" | "Disabled"
 
 export type Interval = "Monthly"
 
-export type RecurringPayment = RecurringCreditAchPayment | RecurringCreditBookPayment
+export type RecurringPayment = RecurringCreditAchPayment | RecurringCreditBookPayment | RecurringDebitAchPayment
 
 interface RecurringPaymentAttributes {
     /**
@@ -53,7 +53,7 @@ interface RecurringPaymentAttributes {
 
 interface RecurringPaymentRelationships {
     /**
-     * The Deposit Account originating the recurring payment.
+     * The [Deposit Account](https://docs.unit.co/deposit-accounts/) originating the recurring payment.
      */
     account: Relationship
 
@@ -63,7 +63,7 @@ interface RecurringPaymentRelationships {
     org: Relationship
 
     /**
-     * The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
+     * The [Customer](https://docs.unit.co/customers/) the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
      */
     customer?: Relationship
 }
@@ -132,6 +132,38 @@ export interface RecurringCreditBookPayment {
     } & RecurringPaymentRelationships
 }
 
+export interface RecurringDebitAchPayment {
+    /**
+     * Identifier of the recurring credit book payment resource.
+     */
+    id: string
+
+    /**
+     * Type of the payment resource. The value is always recurringDebitAchPayment.
+     */
+    type: "recurringDebitAchPayment"
+
+    /**
+     * JSON object representing the recurring payment resource.
+     */
+    attributes: {
+        /**
+         * Optional, additional payment description (maximum of 80 characters), not all institutions present that.
+         */
+        addenda?: string
+    } & RecurringPaymentAttributes
+
+    /**
+     * Describes relationships between the Recurring Debit ACH payment and the originating deposit account and org.
+     */
+    relationships: {
+        /**
+         * The [Counterparty](https://docs.unit.co/payments-counterparties) the payment to be made to.
+         */
+        counterparty: Relationship
+    } & RecurringPaymentRelationships
+}
+
 interface BaseSchedule {
     /**
      * RFC3339 format. For more information: https://en.wikipedia.org/wiki/ISO_8601#RFCs
@@ -172,7 +204,7 @@ export interface Schedule extends BaseSchedule {
     nextScheduledAction: string
 }
 
-export type CreateRecurringPaymentRequest = CreateRecurringCreditAchPaymentRequest | CreateRecurringCreditBookPaymentRequest
+export type CreateRecurringPaymentRequest = CreateRecurringCreditAchPaymentRequest | CreateRecurringCreditBookPaymentRequest | CreateRecurringDebitAchPaymentRequest
 
 interface CreateRecurringRequestAttributes {
     /**
@@ -201,6 +233,18 @@ interface CreateRecurringRequestAttributes {
     tags?: object
 }
 
+interface CreateRecurringRequestRelationships {
+    /**
+     * The Deposit Account originating the recurring payment.
+     */
+    account: Relationship
+
+    /**
+     * The Counterparty account to which the payment will be made.
+     */
+    counterparty: Relationship
+}
+
 export interface CreateRecurringCreditAchPaymentRequest {
     type: "recurringCreditAchPayment"
 
@@ -217,17 +261,7 @@ export interface CreateRecurringCreditAchPaymentRequest {
     /**
      * JSON:API Relationships. Describes relationships between the Recurring Credit ACH payment and the originating deposit account and org.
      */
-    relationships: {
-        /**
-         * The Deposit Account originating the recurring payment.
-         */
-        account: Relationship
-
-        /**
-         * The Counterparty the payment to be made to.
-         */
-        counterparty: Relationship
-    }
+    relationships: CreateRecurringRequestRelationships
 }
 
 export interface CreateRecurringCreditBookPaymentRequest {
@@ -259,3 +293,29 @@ export interface CreateRecurringCreditBookPaymentRequest {
     }
 }
 
+export interface CreateRecurringDebitAchPaymentRequest {
+    type: "recurringDebitAchPayment"
+
+    /**
+     * JSON object representing the recurring payment resource.
+     */
+    attributes: {
+        /**
+         * Optional, additional payment description (maximum of 50 characters), not all institutions present that.
+         */
+        addenda?: string
+
+        /**
+         * Optional, default is false. Verify the counterparty balance, if balance verification fails the payment will be rejected with reason set to CounterpartyInsufficientFunds.
+         */
+        verifyCounterpartyBalance?: boolean
+
+        /**
+         * Optional, default is false. See Same Day ACH.
+         */
+        sameDay?: boolean
+    } & CreateRecurringRequestAttributes
+
+    relationships: CreateRecurringRequestRelationships
+}
+