paystack-sdk 2.5.11 → 2.5.12

package/README.md

@@ -19,7 +19,7 @@ For Typescript
 ```typescript
 import {Paystack} from 'paystack-sdk';
 
-const paystack = new Paystack("secret_key);
+const paystack = new Paystack("secret_key");
 ```
 
 For Javscript
@@ -58,7 +58,7 @@ All methods use promise meaning you can either use the `async...await` or `then.
 - [x] Bulk Charges
 - [ ] Control Panel
 - [ ] Disputes
-- [ ] Refunds
+- [x] Refunds
 - [x] Verification
 - [ ] Miscellaneous
 

package/dist/interface.d.ts

@@ -34,3 +34,12 @@ export interface QueryParams {
      */
     to?: Date;
 }
+/**
+ * Paystack makes use of the ISO 4217 format for currency codes.
+ * When sending an amount, it must be sent in the subunit of that currency.
+ *
+ * Sending an amount in subunits simply means multiplying the base amount by 100.
+ * For example, if a customer is supposed to make a payment of NGN 100,
+ * you would send 10000 = 100 * 100 in your request.
+ */
+export declare type Currency = 'NGN' | 'USD' | 'GHS' | 'ZAR' | 'KES';

package/dist/paystack.d.ts

@@ -15,6 +15,7 @@ import { Transaction } from './transaction/transaction';
 import { Transfer } from './transfer/transfer';
 import { BulkCharge } from './bulkcharge/bulkcharge';
 import { Verification } from './verification/verification';
+import { Refund } from './refund/refund';
 /**
  * Paystack SDK
  * @author Asaju Enitan <@tPriest>
@@ -38,6 +39,7 @@ export declare class Paystack {
     invoice: Invoice;
     settlement: Settlement;
     recipient: Recipient;
+    refund: Refund;
     verification: Verification;
     constructor(key: string);
 }

package/dist/paystack.js

@@ -19,6 +19,7 @@ const transaction_1 = require("./transaction/transaction");
 const transfer_1 = require("./transfer/transfer");
 const bulkcharge_1 = require("./bulkcharge/bulkcharge");
 const verification_1 = require("./verification/verification");
+const refund_1 = require("./refund/refund");
 /**
  * Paystack SDK
  * @author Asaju Enitan <@tPriest>
@@ -50,6 +51,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.refund = new refund_1.Refund(this.http);
         this.verification = new verification_1.Verification(this.http);
     }
 }

package/dist/refund/interface.d.ts

@@ -0,0 +1,66 @@
+import { Currency, QueryParams, Response } from '../interface';
+import { Transaction } from '../transaction/interface';
+export interface CreateRefund {
+    /**
+     * Transaction reference or id
+     */
+    transaction: string;
+    /**
+     * Amount to be refunded to the customer.
+     * Amount is optional(defaults to original transaction amount)
+     * and cannot be more than the original transaction amount.
+     */
+    amount?: number;
+    /**
+     * Any of the supported currency
+     */
+    currency?: Currency;
+    /**
+     * Customer reason
+     */
+    customer_note?: string;
+    /**
+     * Merchant reason
+     */
+    merchant_note?: string;
+}
+export interface ListRefundQueryParams extends QueryParams {
+    /**
+     * Identifier for transaction to be refunded
+     */
+    reference: string;
+    /**
+     * Any of the supported currency
+     */
+    currency: Currency;
+}
+export interface ListRefundsResponse extends Response {
+    data: Refund[];
+}
+export interface RefundCreatedResponse extends Response {
+    data: Refund;
+}
+export interface FetchRefundResponse extends Response {
+    data: Refund;
+}
+export interface Refund {
+    id: number;
+    integration: number;
+    domain: string;
+    transaction: number | Transaction;
+    dispute: number;
+    amount: number;
+    deducted_amount: number;
+    currency: string;
+    channel: string;
+    fully_deducted: boolean;
+    refunded_by: string;
+    refunded_at?: string;
+    expected_at: string;
+    settlement: number;
+    customer_note: string;
+    merchant_note: string;
+    createdAt: string;
+    updatedAt: string;
+    status: string;
+}

package/dist/refund/interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/refund/refund.d.ts

@@ -0,0 +1,22 @@
+import { Axios } from 'axios';
+import { FetchRefundResponse, CreateRefund, ListRefundQueryParams, ListRefundsResponse, RefundCreatedResponse } from './interface';
+import { BadRequest } from '../interface';
+export declare class Refund {
+    private http;
+    constructor(http: Axios);
+    /**
+     * #### Create Refund
+     * Initiate a refund on your integration
+     */
+    create(data: CreateRefund): Promise<RefundCreatedResponse | BadRequest>;
+    /**
+     * #### List Refunds
+     * List refunds available on your integration
+     */
+    list(queryParams?: ListRefundQueryParams): Promise<ListRefundsResponse | BadRequest>;
+    /**
+     * #### Fetch Refund
+     * Get details of a refund on your integration
+     */
+    fetch(reference: string): Promise<FetchRefundResponse | BadRequest>;
+}

package/dist/refund/refund.js

@@ -0,0 +1,47 @@
+"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.Refund = void 0;
+class Refund {
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * #### Create Refund
+     * Initiate a refund on your integration
+     */
+    create(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.post('/refund', JSON.stringify(data));
+        });
+    }
+    /**
+     * #### List Refunds
+     * List refunds available on your integration
+     */
+    list(queryParams) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get('/refund', {
+                params: Object.assign({}, queryParams),
+            });
+        });
+    }
+    /**
+     * #### Fetch Refund
+     * Get details of a refund on your integration
+     */
+    fetch(reference) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.http.get(`/refund/${reference}`);
+        });
+    }
+}
+exports.Refund = Refund;

package/dist/transfer/transfer.d.ts

@@ -6,7 +6,7 @@ interface BadRequest {
     message: string;
 }
 export declare class Transfer {
-    http: Axios;
+    private http;
     control: Control;
     constructor(http: Axios);
     /**

package/dist/verification/interface.d.ts

@@ -1,7 +1,4 @@
-export interface Response {
-    status: boolean;
-    message: string;
-}
+import { Response } from '../interface';
 export interface ResolveAccount {
     /**
      * Account Number
@@ -13,15 +10,8 @@ export interface ResolveAccount {
      */
     bank_code: string;
 }
-export declare enum AccountType {
-    personal = "personal",
-    business = "business"
-}
-export declare enum DocumentType {
-    idNumber = "identityNumber",
-    passportNumber = "passportNumber",
-    businessRegNumber = "businessRegistrationNumber"
-}
+export declare type AccountType = 'personal' | 'business';
+export declare type DocumentType = 'identityNumber' | 'passportNumber' | 'businessRegistrationNumber';
 export interface AccountResolved extends Response {
     data: {
         /**
@@ -68,7 +58,7 @@ export interface ValidateAccount {
      */
     document_number: string;
 }
-export interface AccountVerified extends Response {
+export interface AccountVerifiedResponse extends Response {
     data: {
         /**
          * Verification Status
@@ -80,7 +70,7 @@ export interface AccountVerified extends Response {
         verificationMessage: string;
     };
 }
-export interface BinResolved extends Response {
+export interface BinResolvedResponse extends Response {
     data: {
         bin: string;
         brand: string;

package/dist/verification/interface.js

@@ -1,14 +1,2 @@
 "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

@@ -1,36 +1,31 @@
 import { Axios } from 'axios';
-import { ResolveAccount, AccountResolved, ValidateAccount, AccountVerified, BinResolved } from './interface';
-interface BadRequest {
-    status: boolean;
-    message: string;
-    data: null;
-}
+import { ResolveAccount, AccountResolved, ValidateAccount, AccountVerifiedResponse, BinResolvedResponse } from './interface';
+import { BadRequest } from '../interface';
 /**
- * # Verification
+ * ## Verification
  * The Verification API allows you perform KYC processes.
  */
 export declare class Verification {
     private http;
     constructor(http: Axios);
     /**
-     * # Resolve Account
+     * #### Resolve Account
      * Confirm an account belongs to the right customer
      * @param {ResolveAccount} data **Query Param**
      */
     resolveAccount(data: ResolveAccount): Promise<AccountResolved | BadRequest>;
     /**
-     * # Validate Account
+     * #### 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>;
+    validateAccount(data: ValidateAccount): Promise<AccountVerifiedResponse | BadRequest>;
     /**
-     * # Resolve Card BIN
+     * #### 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>;
+    resolveCard(bin: number): Promise<BinResolvedResponse | BadRequest>;
 }
-export {};

package/dist/verification/verification.js

@@ -11,7 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Verification = void 0;
 /**
- * # Verification
+ * ## Verification
  * The Verification API allows you perform KYC processes.
  */
 class Verification {
@@ -19,7 +19,7 @@ class Verification {
         this.http = http;
     }
     /**
-     * # Resolve Account
+     * #### Resolve Account
      * Confirm an account belongs to the right customer
      * @param {ResolveAccount} data **Query Param**
      */
@@ -29,7 +29,7 @@ class Verification {
         });
     }
     /**
-     * # Validate Account
+     * #### Validate Account
      * Confirm the authenticity of a customer's account number
      * before sending money
      * @param {ValidateAccount} data **Data Param**
@@ -40,7 +40,7 @@ class Verification {
         });
     }
     /**
-     * # Resolve Card BIN
+     * #### Resolve Card BIN
      * Get more information about a customer's card
      * using the first 6 characters of the card
      * @param {string} bin **Path Param**

package/package.json

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