feat: Add customer validation feature

Author: Ahdeyyy

lib/customer.test.ts

@@ -54,4 +54,24 @@ test("update customer", async () => {
             expect(response.data.first_name).toBe("updated")
         }
     }
+})
+
+// { 
+//   "country": "NG",
+//   "type": "bank_account",
+//   "account_number": "0123456789",
+//   "bvn": "20012345677",
+//   "bank_code": "007",
+//   "first_name": "Asta",
+//   "last_name": "Lavista"
+// }
+
+test("validate customer", async () => {
+    let cust = (await customer())
+    expect(cust.status).toBe(true)
+    if (cust.status) {
+        let response = await paystack().customer.validate(cust.data.customer_code, { country: "NG", type: "bank_account", account_number: "0123456789", bvn: "20012345677", bank_code: "007", first_name: "Asta", last_name: "Lavista" })
+        expect(response.status).toBe(true)
+
+    }
 })

lib/customer.ts

@@ -1,4 +1,4 @@
-import type { CreateCustomerData, CreateCustomerResponse, FetchCustomerResponse, ListCustomerData, ListCustomerResponse, UpdateCustomerData, UpdateCustomerResponse } from "./types";
+import type { CreateCustomerData, CreateCustomerResponse, FetchCustomerResponse, ListCustomerData, ListCustomerResponse, UpdateCustomerData, UpdateCustomerResponse, ValidateCustomerData, ValidateCustomerResponse } from "./types";
 
 export class Customer {
     private secret_key: string;
@@ -92,4 +92,18 @@ export class Customer {
         return response_data;
     }
 
+    /** Validate a customer's identity */
+    async validate(code: string, data: ValidateCustomerData): Promise<ValidateCustomerResponse> {
+        const headers = this.get_headers();
+        const response = await fetch(`${this.endpoint}/${code}/identification`, {
+            headers: headers,
+            method: "POST",
+            body: JSON.stringify(data)
+        })
+
+        const response_data = await response.json() as ValidateCustomerResponse;
+
+        return response_data;
+    }
+
 } 

lib/types.ts

@@ -669,4 +669,48 @@ export type UpdateCustomerResponse = { message: string } & ({
         createdAt: string;
         updatedAt: string;
     }
-} | PaymentRequestError)
+} | PaymentRequestError)
+
+export type ValidateCustomerData = {
+
+    /** Customer's first name */
+    first_name: string;
+
+    /** Customer's last name */
+    last_name: string;
+
+    /** 
+     * Predefined types of identification. 
+     * Only bank_account is supported at the moment 
+     * */
+    type: string;
+
+    /** Customer's identification number */
+    value?: string
+
+    /** 2 letter country code of identification issuer */
+    country: string;
+
+    /** Customer's Bank Verification Number */
+    bvn: string;
+
+    /** 
+     * You can get the list of Bank Codes by calling the List Banks endpoint.
+     *  (required if type is bank_account) 
+     * */
+    bank_code: string;
+
+    /**
+     *  Customer's bank account number.
+     *  (required if type is bank_account)
+     * */
+    account_number: string;
+
+    /** customer's middle name */
+    middle_name?: string;
+}
+
+export type ValidateCustomerResponse = {
+    status: boolean;
+    message: string;
+}