paystack-sdk 2.5.7 → 2.5.10

package/README.md

@@ -59,7 +59,7 @@ All methods use promise meaning you can either use the `async...await` or `then.
 - [ ] Control Panel
 - [ ] Disputes
 - [ ] Refunds
-- [ ] Verification
+- [x] Verification
 - [ ] Miscellaneous
 
 ## CONTRIBUTING

package/dist/paystack.d.ts

@@ -13,6 +13,8 @@ import { SubAccount } from './subaccounts/subaccount';
 import { Subscription } from './subscription/subscription';
 import { Transaction } from './transaction/transaction';
 import { Transfer } from './transfer/transfer';
+import { BulkCharge } from './bulkcharge/bulkcharge';
+import { Verification } from './verification/verification';
 /**
  * Paystack SDK
  * @author Asaju Enitan <@tPriest>
@@ -20,6 +22,7 @@ import { Transfer } from './transfer/transfer';
 export declare class Paystack {
     private readonly key;
     private readonly http;
+    bulkcharge: BulkCharge;
     charge: Charge;
     customer: Customer;
     dedicated: DedicatedAccount;
@@ -35,5 +38,6 @@ export declare class Paystack {
     invoice: Invoice;
     settlement: Settlement;
     recipient: Recipient;
+    verification: Verification;
     constructor(key: string);
 }

package/dist/paystack.js

@@ -17,6 +17,8 @@ const subaccount_1 = require("./subaccounts/subaccount");
 const subscription_1 = require("./subscription/subscription");
 const transaction_1 = require("./transaction/transaction");
 const transfer_1 = require("./transfer/transfer");
+const bulkcharge_1 = require("./bulkcharge/bulkcharge");
+const verification_1 = require("./verification/verification");
 /**
  * Paystack SDK
  * @author Asaju Enitan <@tPriest>
@@ -32,6 +34,7 @@ class Paystack {
             },
         });
         this.http.interceptors.response.use((response) => (response.data = JSON.parse(response.data)));
+        this.bulkcharge = new bulkcharge_1.BulkCharge(this.http);
         this.charge = new charge_1.Charge(this.http);
         this.customer = new customer_1.Customer(this.http);
         this.dedicated = new dedicated_1.DedicatedAccount(this.http);
@@ -47,6 +50,7 @@ class Paystack {
         this.invoice = new invoice_1.Invoice(this.http);
         this.settlement = new settlement_1.Settlement(this.http);
         this.recipient = new recipient_1.Recipient(this.http);
+        this.verification = new verification_1.Verification(this.http);
     }
 }
 exports.Paystack = Paystack;

package/dist/verification/interface.d.ts

@@ -0,0 +1,94 @@
+export interface Response {
+    status: boolean;
+    message: string;
+}
+export interface ResolveAccount {
+    /**
+     * Account Number
+     */
+    account_number: string;
+    /**
+     * You can get the list of bank codes
+     * by calling the List Banks endpoint
+     */
+    bank_code: string;
+}
+export declare enum AccountType {
+    personal = "personal",
+    business = "business"
+}
+export declare enum DocumentType {
+    idNumber = "identityNumber",
+    passportNumber = "passportNumber",
+    businessRegNumber = "businessRegistrationNumber"
+}
+export interface AccountResolved extends Response {
+    data: {
+        /**
+         * Verified Account Number
+         */
+        account_number: string;
+        /**
+         * Verified Account Name
+         */
+        account_name: string;
+    };
+}
+export interface ValidateAccount {
+    /**
+     * The bank code of the customer’s bank.
+     * You can fetch the bank codes
+     * by using our List Banks endpoint
+     */
+    bank_code: string;
+    /**
+     * The two digit ISO code of the customer’s bank
+     */
+    country_code: string;
+    /**
+     * Customer’s account number
+     */
+    account_number: string;
+    /**
+     * Customer's first and last name registered with their bank
+     */
+    account_name: string;
+    /**
+     * This can take one of: [ personal, business ]
+     */
+    account_type: AccountType;
+    /**
+     * Customer’s mode of identity.
+     * This could be one of:
+     * [ identityNumber, passportNumber, businessRegistrationNumber ]
+     */
+    document_type: DocumentType;
+    /**
+     * Customer’s mode of identity number
+     */
+    document_number: string;
+}
+export interface AccountVerified extends Response {
+    data: {
+        /**
+         * Verification Status
+         */
+        verified: boolean;
+        /**
+         * Verification Message
+         */
+        verificationMessage: string;
+    };
+}
+export interface BinResolved extends Response {
+    data: {
+        bin: string;
+        brand: string;
+        sub_brand: string;
+        country_code: string;
+        country_name: string;
+        card_type: string;
+        bank: string;
+        linked_bank_id: number;
+    };
+}

package/dist/verification/interface.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentType = exports.AccountType = void 0;
+var AccountType;
+(function (AccountType) {
+    AccountType["personal"] = "personal";
+    AccountType["business"] = "business";
+})(AccountType = exports.AccountType || (exports.AccountType = {}));
+var DocumentType;
+(function (DocumentType) {
+    DocumentType["idNumber"] = "identityNumber";
+    DocumentType["passportNumber"] = "passportNumber";
+    DocumentType["businessRegNumber"] = "businessRegistrationNumber";
+})(DocumentType = exports.DocumentType || (exports.DocumentType = {}));

package/dist/verification/verification.d.ts

@@ -0,0 +1,36 @@
+import { Axios } from 'axios';
+import { ResolveAccount, AccountResolved, ValidateAccount, AccountVerified, BinResolved } from './interface';
+interface BadRequest {
+    status: boolean;
+    message: string;
+    data: null;
+}
+/**
+ * # Verification
+ * The Verification API allows you perform KYC processes.
+ */
+export declare class Verification {
+    private http;
+    constructor(http: Axios);
+    /**
+     * # Resolve Account
+     * Confirm an account belongs to the right customer
+     * @param {ResolveAccount} data **Query Param**
+     */
+    resolveAccount(data: ResolveAccount): Promise<AccountResolved | BadRequest>;
+    /**
+     * # Validate Account
+     * Confirm the authenticity of a customer's account number
+     * before sending money
+     * @param {ValidateAccount} data **Data Param**
+     */
+    validateAccount(data: ValidateAccount): Promise<AccountVerified | BadRequest>;
+    /**
+     * # Resolve Card BIN
+     * Get more information about a customer's card
+     * using the first 6 characters of the card
+     * @param {string} bin **Path Param**
+     */
+    resolveCard(bin: number): Promise<BinResolved | BadRequest>;
+}
+export {};

package/dist/verification/verification.js

@@ -0,0 +1,54 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Verification = void 0;
+/**
+ * # Verification
+ * The Verification API allows you perform KYC processes.
+ */
+class Verification {
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * # Resolve Account
+     * Confirm an account belongs to the right customer
+     * @param {ResolveAccount} data **Query Param**
+     */
+    resolveAccount(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get('/bank/resolve', { params: Object.assign({}, data) });
+        });
+    }
+    /**
+     * # Validate Account
+     * Confirm the authenticity of a customer's account number
+     * before sending money
+     * @param {ValidateAccount} data **Data Param**
+     */
+    validateAccount(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.post('/bank/validate', JSON.stringify(data));
+        });
+    }
+    /**
+     * # Resolve Card BIN
+     * Get more information about a customer's card
+     * using the first 6 characters of the card
+     * @param {string} bin **Path Param**
+     */
+    resolveCard(bin) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get(`/decision/bin/${bin}`);
+        });
+    }
+}
+exports.Verification = Verification;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "paystack-sdk",
-  "version": "2.5.7",
+  "version": "2.5.10",
   "description": "Paystack SDK written in Typescript",
   "main": "dist/index.js",
   "author": "Tech Priest",