resurgence-data 1.1.5 → 1.1.6

package/dist/biller/biller.dto.d.ts

@@ -1,5 +1,5 @@
 import { BaseDTO } from "../types/dto.type";
-import { BillerApiKeyDto } from "../payment";
+import { BillerApiKeyDto } from "../payment/api-key";
 /**
  * DTO for `BillerCategory`
  */
@@ -58,7 +58,7 @@ export declare class CreateBillerDto extends BaseDTO {
     updatedAt?: string;
 }
 export declare class UpdateBillerDto extends BaseDTO {
-    id?: string;
+    id: string;
     categoryId?: string;
     billerProfileId?: string;
     name?: string;

package/dist/index.d.ts

@@ -4,4 +4,4 @@ export * from "./exception";
 export * from "./user";
 export * from "./messaging";
 export * from "./biller";
-export * from "./payment";
+export * from "./payment/api-key";

package/dist/index.js

@@ -20,4 +20,4 @@ __exportStar(require("./exception"), exports);
 __exportStar(require("./user"), exports);
 __exportStar(require("./messaging"), exports);
 __exportStar(require("./biller"), exports);
-__exportStar(require("./payment"), exports);
+__exportStar(require("./payment/api-key"), exports);

package/dist/payment/api-key/api-key.data.d.ts

@@ -0,0 +1,21 @@
+export declare class BillerApiKeyDto {
+    billerId: string;
+    active: boolean;
+    apiKey: string;
+    environment?: string;
+}
+export declare class UpdateBillerApiKeyDto {
+    id: string;
+    billerId: string;
+    active?: boolean;
+    apiKey?: string;
+    environment?: string;
+}
+export declare class BillerKeyResponseDTO {
+    production: string;
+    test: string;
+}
+export declare class BillerEnvironmentKeyResponseDTO {
+    environment: string;
+    key: string;
+}

package/dist/payment/api-key/api-key.data.js

@@ -0,0 +1,41 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillerEnvironmentKeyResponseDTO = exports.BillerKeyResponseDTO = exports.UpdateBillerApiKeyDto = exports.BillerApiKeyDto = void 0;
+const swagger_1 = require("@nestjs/swagger");
+class BillerApiKeyDto {
+}
+exports.BillerApiKeyDto = BillerApiKeyDto;
+class UpdateBillerApiKeyDto {
+}
+exports.UpdateBillerApiKeyDto = UpdateBillerApiKeyDto;
+class BillerKeyResponseDTO {
+}
+exports.BillerKeyResponseDTO = BillerKeyResponseDTO;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "production key" }),
+    __metadata("design:type", String)
+], BillerKeyResponseDTO.prototype, "production", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "test key" }),
+    __metadata("design:type", String)
+], BillerKeyResponseDTO.prototype, "test", void 0);
+class BillerEnvironmentKeyResponseDTO {
+}
+exports.BillerEnvironmentKeyResponseDTO = BillerEnvironmentKeyResponseDTO;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "environment" }),
+    __metadata("design:type", String)
+], BillerEnvironmentKeyResponseDTO.prototype, "environment", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "key" }),
+    __metadata("design:type", String)
+], BillerEnvironmentKeyResponseDTO.prototype, "key", void 0);

package/dist/payment/api-key/api-key.dto.d.ts

@@ -0,0 +1,4 @@
+export declare class BillerKeyUpdateDto {
+    billerId: string;
+    environment: string;
+}

package/dist/payment/api-key/api-key.dto.js

@@ -0,0 +1,30 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillerKeyUpdateDto = void 0;
+const swagger_1 = require("@nestjs/swagger");
+const class_validator_1 = require("class-validator");
+const biller_type_1 = require("../../types/biller.type");
+class BillerKeyUpdateDto {
+}
+exports.BillerKeyUpdateDto = BillerKeyUpdateDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Biller id" }),
+    (0, class_validator_1.IsUUID)(4, { message: "Please select a valid biller id" }),
+    (0, class_validator_1.IsNotEmpty)({ message: "Please provide a valid biller id" }),
+    __metadata("design:type", String)
+], BillerKeyUpdateDto.prototype, "billerId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Environment" }),
+    (0, class_validator_1.IsIn)(biller_type_1.environments, { message: "Please select a valid environment" }),
+    (0, class_validator_1.IsNotEmpty)({ message: "Please provide an environment for the key update" }),
+    __metadata("design:type", String)
+], BillerKeyUpdateDto.prototype, "environment", void 0);

package/dist/payment/api-key/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./api-key.data";
+export * from "./api-key.dto";

package/dist/payment/api-key/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api-key.data"), exports);
+__exportStar(require("./api-key.dto"), exports);

package/dist/payment/bank-account/bank-account.dto.d.ts

@@ -0,0 +1,14 @@
+export declare class BankAccountResolutionDto {
+    accountNumber: string;
+    bankCode: string;
+}
+export declare class BankValidResponseDto {
+    accountNumber: string;
+    bankCode: string;
+    accountName: string;
+}
+export declare class BankAccountResponseDto {
+    valid: boolean;
+    message: string;
+    account: BankValidResponseDto;
+}

package/dist/payment/bank-account/bank-account.dto.js

@@ -0,0 +1,83 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BankAccountResponseDto = exports.BankValidResponseDto = exports.BankAccountResolutionDto = void 0;
+const class_validator_1 = require("class-validator");
+const swagger_1 = require("@nestjs/swagger");
+class BankAccountResolutionDto {
+}
+exports.BankAccountResolutionDto = BankAccountResolutionDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: "Account number",
+        example: "0027338339",
+    }),
+    (0, class_validator_1.IsString)({ message: "Please enter a valid account number" }),
+    (0, class_validator_1.IsNotEmpty)({ message: "Account number cannot be empty" }),
+    (0, class_validator_1.Matches)(/^\d{1,10}$/, { message: "Account number must be a string of 1 to 10 digits" }),
+    __metadata("design:type", String)
+], BankAccountResolutionDto.prototype, "accountNumber", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: "Code of the bank",
+        example: "044",
+    }),
+    (0, class_validator_1.IsString)({ message: "Please enter a valid bank code" }),
+    (0, class_validator_1.IsNotEmpty)({ message: "Bank code cannot be empty" }),
+    __metadata("design:type", String)
+], BankAccountResolutionDto.prototype, "bankCode", void 0);
+class BankValidResponseDto {
+}
+exports.BankValidResponseDto = BankValidResponseDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: "Account number",
+        example: "123456789",
+    }),
+    __metadata("design:type", String)
+], BankValidResponseDto.prototype, "accountNumber", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: "Bank code",
+        example: "BOA123",
+    }),
+    __metadata("design:type", String)
+], BankValidResponseDto.prototype, "bankCode", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: "Account name",
+        example: "John Doe",
+    }),
+    __metadata("design:type", String)
+], BankValidResponseDto.prototype, "accountName", void 0);
+class BankAccountResponseDto {
+}
+exports.BankAccountResponseDto = BankAccountResponseDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: "Indicates if the response is valid",
+        example: true,
+    }),
+    __metadata("design:type", Boolean)
+], BankAccountResponseDto.prototype, "valid", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: "Response message",
+        example: "Bank account details are valid",
+    }),
+    __metadata("design:type", String)
+], BankAccountResponseDto.prototype, "message", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: "Bank account details",
+    }),
+    __metadata("design:type", BankValidResponseDto)
+], BankAccountResponseDto.prototype, "account", void 0);

package/dist/payment/bank-account/index.d.ts

@@ -0,0 +1 @@
+export * from "./bank-account.dto";

package/dist/payment/bank-account/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./bank-account.dto"), exports);

package/dist/payment/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./api-key.data";
-export * from "./api-key.dto";
+export * from "./api-key";
+export * from "./payment-request";

package/dist/payment/index.js

@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./api-key.data"), exports);
-__exportStar(require("./api-key.dto"), exports);
+__exportStar(require("./api-key"), exports);
+__exportStar(require("./payment-request"), exports);

package/dist/payment/payment-request/index.d.ts

@@ -0,0 +1 @@
+export * from "./payment-request.dto";

package/dist/payment/payment-request/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./payment-request.dto"), exports);

package/dist/payment/payment-request/payment-request.dto.d.ts

@@ -0,0 +1,37 @@
+export declare class TransactionSplitDto {
+    accountId: string;
+    splitType: string;
+    splitValue: string;
+    transactionTotal: number;
+    splitAmount?: number;
+}
+export declare class PaymentRequestDto {
+    billerId: string;
+    customerId?: string;
+    invoiceId?: string;
+    paymentPageId?: string;
+    transactionTotal: number;
+    requestChannel: string;
+    processorId: string;
+    ipAddress?: string;
+    requestUrl?: string;
+    redirectUrl?: string;
+    customerName?: string;
+    customerEmailAddress?: string;
+    customerPhoneNumber?: string;
+    transactionSplits?: TransactionSplitDto[];
+}
+export declare class APIPaymentRequestDto {
+    billerId?: string;
+    customerId?: string;
+    invoiceId?: string;
+    paymentPageId?: string;
+    ipAddress?: string;
+    transactionTotal: number;
+    requestUrl?: string;
+    redirectUrl?: string;
+    customerName?: string;
+    customerEmailAddress?: string;
+    customerPhoneNumber?: string;
+    transactionSplits?: TransactionSplitDto[];
+}

package/dist/payment/payment-request/payment-request.dto.js

@@ -0,0 +1,216 @@
+"use strict";
+// * @apiParam {String} transactionReference Merchants generated unique transaction reference.
+// * @apiParam {String} clientId Merchants client ID.
+// * @apiParam {Integer} amount Transaction amount (In lowrst denomination)
+// * @apiParam {String} [customerEmailAddress] Customer's email address.
+// * @apiParam {String} [customerPhoneNumber] Customer's phone number.
+// * @apiParam {String} [customerName] Customer's name
+// * @apiParam {String} customerId Merchant's preffered customer identifier (eg. email or phone number etc)
+// * @apiParam {String} currencyCode Account holder's email address.
+// * @apiParam {Object} [splitDetails] Transaction split details.
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIPaymentRequestDto = exports.PaymentRequestDto = exports.TransactionSplitDto = void 0;
+const swagger_1 = require("@nestjs/swagger");
+const class_validator_1 = require("class-validator");
+const class_validator_2 = require("class-validator");
+class TransactionSplitDto {
+}
+exports.TransactionSplitDto = TransactionSplitDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Unique identifier for the account" }),
+    (0, class_validator_2.IsUUID)("4", { message: "Account ID must be a valid UUID" }),
+    (0, class_validator_1.IsNotEmpty)({ message: "Account ID is required" }),
+    __metadata("design:type", String)
+], TransactionSplitDto.prototype, "accountId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Type of the transaction split" }),
+    (0, class_validator_1.IsIn)(["FIXED", "PERCENTAGE", "RATIO"], { message: "Split Type must be a valid enum value" }),
+    (0, class_validator_1.IsNotEmpty)({ message: "Split Type is required" }),
+    __metadata("design:type", String)
+], TransactionSplitDto.prototype, "splitType", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Value of the transaction split" }),
+    (0, class_validator_1.IsString)({ message: "Split Value must be a string" }),
+    (0, class_validator_1.IsNotEmpty)({ message: "Split Value is required" }),
+    __metadata("design:type", String)
+], TransactionSplitDto.prototype, "splitValue", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Total amount of the transaction" }),
+    (0, class_validator_1.IsNotEmpty)({ message: "Transaction Total is required" }),
+    (0, class_validator_1.IsInt)({ message: "Transaction Total must be the lowest currency denomination" }),
+    __metadata("design:type", Number)
+], TransactionSplitDto.prototype, "transactionTotal", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Amount of the transaction split" }),
+    (0, class_validator_2.IsOptional)(),
+    __metadata("design:type", Number)
+], TransactionSplitDto.prototype, "splitAmount", void 0);
+class PaymentRequestDto {
+}
+exports.PaymentRequestDto = PaymentRequestDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Unique identifier for the biller" }),
+    (0, class_validator_2.IsUUID)("4", { message: "Biller ID must be a valid UUID" }),
+    (0, class_validator_1.IsNotEmpty)({ message: "Biller ID is required" }),
+    __metadata("design:type", String)
+], PaymentRequestDto.prototype, "billerId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Unique identifier for the customer", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_2.IsUUID)("4", { message: "Customer ID must be a valid UUID" }),
+    __metadata("design:type", String)
+], PaymentRequestDto.prototype, "customerId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Unique identifier for the invoice", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_2.IsUUID)("4", { message: "Invoice ID must be a valid UUID" }),
+    __metadata("design:type", String)
+], PaymentRequestDto.prototype, "invoiceId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Unique identifier for the payment page", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_2.IsUUID)("4", { message: "Payment Page ID must be a valid UUID" }),
+    __metadata("design:type", String)
+], PaymentRequestDto.prototype, "paymentPageId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Total amount of the transaction" }),
+    (0, class_validator_1.IsNotEmpty)({ message: "Transaction Total is required" }),
+    (0, class_validator_1.IsInt)({ message: "Transaction Total must be the lowest currency denomination" }),
+    __metadata("design:type", Number)
+], PaymentRequestDto.prototype, "transactionTotal", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Channel through which the request was made" }),
+    (0, class_validator_1.IsIn)(["WEB", "MOBILE", "POS"], { message: "Request channel must be one of 'WEB', 'MOBILE', 'POS'" }),
+    (0, class_validator_1.IsNotEmpty)({ message: "Request channel is required" }),
+    __metadata("design:type", String)
+], PaymentRequestDto.prototype, "requestChannel", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Unique identifier for the processor" }),
+    (0, class_validator_2.IsUUID)("4", { message: "Processor ID must be a valid UUID" }),
+    (0, class_validator_1.IsNotEmpty)({ message: "Processor ID is required" }),
+    __metadata("design:type", String)
+], PaymentRequestDto.prototype, "processorId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "IP address of the customer", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_2.IsIP)("4", { message: "IP address must be a valid IP address" }),
+    __metadata("design:type", String)
+], PaymentRequestDto.prototype, "ipAddress", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "URL of the request", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_2.IsUrl)({}, { message: "Request URL must be a valid URL" }),
+    __metadata("design:type", String)
+], PaymentRequestDto.prototype, "requestUrl", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Redirect URL after payment", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_2.IsUrl)({}, { message: "Redirect URL must be a valid URL" }),
+    __metadata("design:type", String)
+], PaymentRequestDto.prototype, "redirectUrl", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Name of the customer", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_1.IsString)({ message: "Customer name must be a string" }),
+    __metadata("design:type", String)
+], PaymentRequestDto.prototype, "customerName", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Email address of the customer", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_2.IsEmail)({}, { message: "Customer email address must be a valid email address" }),
+    __metadata("design:type", String)
+], PaymentRequestDto.prototype, "customerEmailAddress", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Phone number of the customer", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_1.IsString)({ message: "Customer phone number must be a string" }),
+    __metadata("design:type", String)
+], PaymentRequestDto.prototype, "customerPhoneNumber", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Array of transaction splits", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    __metadata("design:type", Array)
+], PaymentRequestDto.prototype, "transactionSplits", void 0);
+class APIPaymentRequestDto {
+}
+exports.APIPaymentRequestDto = APIPaymentRequestDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Unique identifier for the biller" }),
+    (0, class_validator_2.IsUUID)("4", { message: "Biller ID must be a valid UUID" }),
+    (0, class_validator_2.IsOptional)(),
+    __metadata("design:type", String)
+], APIPaymentRequestDto.prototype, "billerId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Unique identifier for the customer", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_2.IsUUID)("4", { message: "Customer ID must be a valid UUID" }),
+    __metadata("design:type", String)
+], APIPaymentRequestDto.prototype, "customerId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Unique identifier for the invoice", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_2.IsUUID)("4", { message: "Invoice ID must be a valid UUID" }),
+    __metadata("design:type", String)
+], APIPaymentRequestDto.prototype, "invoiceId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Unique identifier for the payment page", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_2.IsUUID)("4", { message: "Payment Page ID must be a valid UUID" }),
+    __metadata("design:type", String)
+], APIPaymentRequestDto.prototype, "paymentPageId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "IP address of the customer", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_2.IsIP)("4", { message: "IP address must be a valid IP address" }),
+    __metadata("design:type", String)
+], APIPaymentRequestDto.prototype, "ipAddress", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Total amount of the transaction" }),
+    (0, class_validator_1.IsNotEmpty)({ message: "Transaction Total is required" }),
+    (0, class_validator_1.IsInt)({ message: "Transaction Total must be the lowest currency denomination" }),
+    __metadata("design:type", Number)
+], APIPaymentRequestDto.prototype, "transactionTotal", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "URL of the request", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_2.IsUrl)({}, { message: "Request URL must be a valid URL" }),
+    __metadata("design:type", String)
+], APIPaymentRequestDto.prototype, "requestUrl", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Redirect URL after payment", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_2.IsUrl)({}, { message: "Redirect URL must be a valid URL" }),
+    __metadata("design:type", String)
+], APIPaymentRequestDto.prototype, "redirectUrl", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Name of the customer", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_1.IsString)({ message: "Customer name must be a string" }),
+    __metadata("design:type", String)
+], APIPaymentRequestDto.prototype, "customerName", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Email address of the customer", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_2.IsEmail)({}, { message: "Customer email address must be a valid email address" }),
+    __metadata("design:type", String)
+], APIPaymentRequestDto.prototype, "customerEmailAddress", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Phone number of the customer", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    (0, class_validator_1.IsString)({ message: "Customer phone number must be a string" }),
+    __metadata("design:type", String)
+], APIPaymentRequestDto.prototype, "customerPhoneNumber", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: "Array of transaction splits", required: false }),
+    (0, class_validator_2.IsOptional)(),
+    __metadata("design:type", Array)
+], APIPaymentRequestDto.prototype, "transactionSplits", void 0);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "resurgence-data",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "DTOs and shareable resources",
   "module": "dist/index.js",
   "main": "dist/index.js",

package/src/biller/biller.dto.ts

@@ -17,7 +17,7 @@ import {
   IsArray,
 } from "class-validator";
 import { BaseDTO } from "../types/dto.type";
-import { BillerApiKeyDto } from "../payment";
+import { BillerApiKeyDto } from "../payment/api-key";
 
 /**
  * DTO for `BillerCategory`
@@ -208,7 +208,7 @@ export class UpdateBillerDto extends BaseDTO {
   @ApiProperty({ description: "The unique ID of the biller.", example: "uuid-value" })
   @IsOptional()
   @IsString({ message: "ID must be a string." })
-  id?: string;
+  id: string;
 
   @ApiProperty({ description: "The ID of the category associated with the biller.", example: "uuid-value" })
   @IsString({ message: "Category ID must be a string." })

package/src/index.ts

@@ -4,4 +4,4 @@ export * from "./exception";
 export * from "./user";
 export * from "./messaging";
 export * from "./biller";
-export * from "./payment";
+export * from "./payment/api-key";

package/src/payment/{api-key.dto.ts → api-key/api-key.dto.ts}

@@ -1,6 +1,6 @@
 import { ApiProperty } from "@nestjs/swagger";
 import { IsIn, IsNotEmpty, IsUUID } from "class-validator";
-import { environments } from "../types/biller.type";
+import { environments } from "../../types/biller.type";
 
 export class BillerKeyUpdateDto {
   @ApiProperty({ description: "Biller id" })

package/src/payment/api-key/index.ts

@@ -0,0 +1,2 @@
+export * from "./api-key.data";
+export * from "./api-key.dto";

package/src/payment/bank-account/bank-account.dto.ts

@@ -0,0 +1,60 @@
+import { IsString, IsNotEmpty, Matches } from "class-validator";
+import { ApiProperty } from "@nestjs/swagger";
+
+export class BankAccountResolutionDto {
+  @ApiProperty({
+    description: "Account number",
+    example: "0027338339",
+  })
+  @IsString({ message: "Please enter a valid account number" })
+  @IsNotEmpty({ message: "Account number cannot be empty" })
+  @Matches(/^\d{1,10}$/, { message: "Account number must be a string of 1 to 10 digits" })
+  accountNumber: string;
+
+  @ApiProperty({
+    description: "Code of the bank",
+    example: "044",
+  })
+  @IsString({ message: "Please enter a valid bank code" })
+  @IsNotEmpty({ message: "Bank code cannot be empty" })
+  bankCode: string;
+}
+
+export class BankValidResponseDto {
+  @ApiProperty({
+    description: "Account number",
+    example: "123456789",
+  })
+  accountNumber: string;
+
+  @ApiProperty({
+    description: "Bank code",
+    example: "BOA123",
+  })
+  bankCode: string;
+
+  @ApiProperty({
+    description: "Account name",
+    example: "John Doe",
+  })
+  accountName: string;
+}
+
+export class BankAccountResponseDto {
+  @ApiProperty({
+    description: "Indicates if the response is valid",
+    example: true,
+  })
+  valid: boolean;
+
+  @ApiProperty({
+    description: "Response message",
+    example: "Bank account details are valid",
+  })
+  message: string;
+
+  @ApiProperty({
+    description: "Bank account details",
+  })
+  account: BankValidResponseDto;
+}

package/src/payment/bank-account/index.ts

@@ -0,0 +1 @@
+export * from "./bank-account.dto"

package/src/payment/index.ts

@@ -1,2 +1,2 @@
-export * from "./api-key.data";
-export * from "./api-key.dto";
+export * from "./api-key";
+export * from "./payment-request";

package/src/payment/payment-request/index.ts

@@ -0,0 +1 @@
+export * from "./payment-request.dto";

package/src/payment/payment-request/payment-request.dto.ts

@@ -0,0 +1,170 @@
+// * @apiParam {String} transactionReference Merchants generated unique transaction reference.
+// * @apiParam {String} clientId Merchants client ID.
+// * @apiParam {Integer} amount Transaction amount (In lowrst denomination)
+// * @apiParam {String} [customerEmailAddress] Customer's email address.
+// * @apiParam {String} [customerPhoneNumber] Customer's phone number.
+// * @apiParam {String} [customerName] Customer's name
+// * @apiParam {String} customerId Merchant's preffered customer identifier (eg. email or phone number etc)
+// * @apiParam {String} currencyCode Account holder's email address.
+// * @apiParam {Object} [splitDetails] Transaction split details.
+
+import { ApiProperty } from "@nestjs/swagger";
+import { IsIn, IsInt, IsNotEmpty, IsNumber, IsString } from "class-validator";
+import { IsOptional, IsUUID, IsEnum, IsIP, IsUrl, IsEmail } from "class-validator";
+
+export class TransactionSplitDto {
+  @ApiProperty({ description: "Unique identifier for the account" })
+  @IsUUID("4", { message: "Account ID must be a valid UUID" })
+  @IsNotEmpty({ message: "Account ID is required" })
+  accountId: string;
+
+  @ApiProperty({ description: "Type of the transaction split" })
+  @IsIn(["FIXED", "PERCENTAGE", "RATIO"], { message: "Split Type must be a valid enum value" })
+  @IsNotEmpty({ message: "Split Type is required" })
+  splitType: string;
+
+  @ApiProperty({ description: "Value of the transaction split" })
+  @IsString({ message: "Split Value must be a string" })
+  @IsNotEmpty({ message: "Split Value is required" })
+  splitValue: string;
+
+  @ApiProperty({ description: "Total amount of the transaction" })
+  @IsNotEmpty({ message: "Transaction Total is required" })
+  @IsInt({ message: "Transaction Total must be the lowest currency denomination" })
+  transactionTotal: number;
+
+  @ApiProperty({ description: "Amount of the transaction split" })
+  @IsOptional()
+  splitAmount?: number;
+}
+export class PaymentRequestDto {
+  @ApiProperty({ description: "Unique identifier for the biller" })
+  @IsUUID("4", { message: "Biller ID must be a valid UUID" })
+  @IsNotEmpty({ message: "Biller ID is required" })
+  billerId: string;
+
+  @ApiProperty({ description: "Unique identifier for the customer", required: false })
+  @IsOptional()
+  @IsUUID("4", { message: "Customer ID must be a valid UUID" })
+  customerId?: string;
+
+  @ApiProperty({ description: "Unique identifier for the invoice", required: false })
+  @IsOptional()
+  @IsUUID("4", { message: "Invoice ID must be a valid UUID" })
+  invoiceId?: string;
+
+  @ApiProperty({ description: "Unique identifier for the payment page", required: false })
+  @IsOptional()
+  @IsUUID("4", { message: "Payment Page ID must be a valid UUID" })
+  paymentPageId?: string;
+
+  @ApiProperty({ description: "Total amount of the transaction" })
+  @IsNotEmpty({ message: "Transaction Total is required" })
+  @IsInt({ message: "Transaction Total must be the lowest currency denomination" })
+  transactionTotal: number;
+
+  @ApiProperty({ description: "Channel through which the request was made" })
+  @IsIn(["WEB", "MOBILE", "POS"], { message: "Request channel must be one of 'WEB', 'MOBILE', 'POS'" })
+  @IsNotEmpty({ message: "Request channel is required" })
+  requestChannel: string;
+
+  @ApiProperty({ description: "Unique identifier for the processor" })
+  @IsUUID("4", { message: "Processor ID must be a valid UUID" })
+  @IsNotEmpty({ message: "Processor ID is required" })
+  processorId: string;
+
+  @ApiProperty({ description: "IP address of the customer", required: false })
+  @IsOptional()
+  @IsIP("4", { message: "IP address must be a valid IP address" })
+  ipAddress?: string;
+
+  @ApiProperty({ description: "URL of the request", required: false })
+  @IsOptional()
+  @IsUrl({}, { message: "Request URL must be a valid URL" })
+  requestUrl?: string;
+
+  @ApiProperty({ description: "Redirect URL after payment", required: false })
+  @IsOptional()
+  @IsUrl({}, { message: "Redirect URL must be a valid URL" })
+  redirectUrl?: string;
+
+  @ApiProperty({ description: "Name of the customer", required: false })
+  @IsOptional()
+  @IsString({ message: "Customer name must be a string" })
+  customerName?: string;
+
+  @ApiProperty({ description: "Email address of the customer", required: false })
+  @IsOptional()
+  @IsEmail({}, { message: "Customer email address must be a valid email address" })
+  customerEmailAddress?: string;
+
+  @ApiProperty({ description: "Phone number of the customer", required: false })
+  @IsOptional()
+  @IsString({ message: "Customer phone number must be a string" })
+  customerPhoneNumber?: string;
+
+  @ApiProperty({ description: "Array of transaction splits", required: false })
+  @IsOptional()
+  transactionSplits?: TransactionSplitDto[];
+}
+
+export class APIPaymentRequestDto {
+  @ApiProperty({ description: "Unique identifier for the biller" })
+  @IsUUID("4", { message: "Biller ID must be a valid UUID" })
+  @IsOptional()
+  billerId?: string;
+
+  @ApiProperty({ description: "Unique identifier for the customer", required: false })
+  @IsOptional()
+  @IsUUID("4", { message: "Customer ID must be a valid UUID" })
+  customerId?: string;
+
+  @ApiProperty({ description: "Unique identifier for the invoice", required: false })
+  @IsOptional()
+  @IsUUID("4", { message: "Invoice ID must be a valid UUID" })
+  invoiceId?: string;
+
+  @ApiProperty({ description: "Unique identifier for the payment page", required: false })
+  @IsOptional()
+  @IsUUID("4", { message: "Payment Page ID must be a valid UUID" })
+  paymentPageId?: string;
+
+  @ApiProperty({ description: "IP address of the customer", required: false })
+  @IsOptional()
+  @IsIP("4", { message: "IP address must be a valid IP address" })
+  ipAddress?: string;
+
+  @ApiProperty({ description: "Total amount of the transaction" })
+  @IsNotEmpty({ message: "Transaction Total is required" })
+  @IsInt({ message: "Transaction Total must be the lowest currency denomination" })
+  transactionTotal: number;
+
+  @ApiProperty({ description: "URL of the request", required: false })
+  @IsOptional()
+  @IsUrl({}, { message: "Request URL must be a valid URL" })
+  requestUrl?: string;
+
+  @ApiProperty({ description: "Redirect URL after payment", required: false })
+  @IsOptional()
+  @IsUrl({}, { message: "Redirect URL must be a valid URL" })
+  redirectUrl?: string;
+
+  @ApiProperty({ description: "Name of the customer", required: false })
+  @IsOptional()
+  @IsString({ message: "Customer name must be a string" })
+  customerName?: string;
+
+  @ApiProperty({ description: "Email address of the customer", required: false })
+  @IsOptional()
+  @IsEmail({}, { message: "Customer email address must be a valid email address" })
+  customerEmailAddress?: string;
+
+  @ApiProperty({ description: "Phone number of the customer", required: false })
+  @IsOptional()
+  @IsString({ message: "Customer phone number must be a string" })
+  customerPhoneNumber?: string;
+
+  @ApiProperty({ description: "Array of transaction splits", required: false })
+  @IsOptional()
+  transactionSplits?: TransactionSplitDto[];
+}