Merge pull request #12 from devfresher/feature-refund

New Feature: Refund

Author: tekpriest

README.md

@@ -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
 

src/interface.ts

@@ -37,3 +37,13 @@ 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 type Currency = 'NGN' | 'USD' | 'GHS' | 'ZAR' | 'KES';

src/paystack.ts

@@ -16,6 +16,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
@@ -40,6 +41,7 @@ export class Paystack {
   public invoice: Invoice;
   public settlement: Settlement;
   public recipient: Recipient;
+  public refund: Refund;
   public verification: Verification;
   constructor(private readonly key: string) {
     this.http = new Axios({
@@ -69,6 +71,7 @@ export class Paystack {
     this.invoice = new Invoice(this.http);
     this.settlement = new Settlement(this.http);
     this.recipient = new Recipient(this.http);
+    this.refund = new Refund(this.http);
     this.verification = new Verification(this.http);
   }
 }

src/refund/interface.ts

@@ -0,0 +1,77 @@
+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;
+}

src/refund/refund.ts

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

src/transfer/transfer.ts

@@ -18,7 +18,7 @@ interface BadRequest {
 }
 
 export class Transfer {
-  http: Axios;
+  private http: Axios;
   public control: Control;
   constructor(http: Axios) {
     this.http = http;

src/verification/interface.ts

@@ -1,7 +1,4 @@
-export interface Response {
-  status: boolean;
-  message: string;
-}
+import { Response } from '../interface';
 
 export interface ResolveAccount {
   /**
@@ -16,16 +13,12 @@ export interface ResolveAccount {
   bank_code: string;
 }
 
-export enum AccountType {
-  personal = 'personal',
-  business = 'business',
-}
+export type AccountType = 'personal' | 'business';
 
-export enum DocumentType {
-  idNumber = 'identityNumber',
-  passportNumber = 'passportNumber',
-  businessRegNumber = 'businessRegistrationNumber',
-}
+export type DocumentType =
+  | 'identityNumber'
+  | 'passportNumber'
+  | 'businessRegistrationNumber';
 
 export interface AccountResolved extends Response {
   data: {
@@ -82,7 +75,7 @@ export interface ValidateAccount {
   document_number: string;
 }
 
-export interface AccountVerified extends Response {
+export interface AccountVerifiedResponse extends Response {
   data: {
     /**
      * Verification Status
@@ -96,7 +89,7 @@ export interface AccountVerified extends Response {
   };
 }
 
-export interface BinResolved extends Response {
+export interface BinResolvedResponse extends Response {
   data: {
     bin: string;
     brand: string;

src/verification/verification.ts

@@ -3,18 +3,13 @@ import {
   ResolveAccount,
   AccountResolved,
   ValidateAccount,
-  AccountVerified,
-  BinResolved,
+  AccountVerifiedResponse,
+  BinResolvedResponse,
 } from './interface';
-
-interface BadRequest {
-  status: boolean;
-  message: string;
-  data: null;
-}
+import { BadRequest } from '../interface';
 
 /**
- * # Verification
+ * ## Verification
  * The Verification API allows you perform KYC processes.
  */
 export class Verification {
@@ -24,7 +19,7 @@ export class Verification {
   }
 
   /**
-   * # Resolve Account
+   * #### Resolve Account
    * Confirm an account belongs to the right customer
    * @param {ResolveAccount} data **Query Param**
    */
@@ -35,24 +30,24 @@ export class Verification {
   }
 
   /**
-   * # Validate Account
+   * #### Validate Account
    * Confirm the authenticity of a customer's account number
    * before sending money
    * @param {ValidateAccount} data **Data Param**
    */
   async validateAccount(
     data: ValidateAccount,
-  ): Promise<AccountVerified | BadRequest> {
+  ): Promise<AccountVerifiedResponse | BadRequest> {
     return await this.http.post('/bank/validate', JSON.stringify(data));
   }
 
   /**
-   * # 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**
    */
-  async resolveCard(bin: number): Promise<BinResolved | BadRequest> {
+  async resolveCard(bin: number): Promise<BinResolvedResponse | BadRequest> {
     return await this.http.get(`/decision/bin/${bin}`);
   }
 }