0.0.5 • Published 11 months ago

hydrogenpay-angular v0.0.5

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

Hydrogen Angular SDK

Hydrogen Angular SDK allows you to accept payment using in your Angular application

Installation

Register for a merchant account on Hydrogen Merchant Dashboard to get started.

npm install --save hydrogenpay-angular
yarn add hydrogenpay-angular
pnpm add hydrogenpay-angular

Support

If you have any problems, questions or suggestions, create an issue here or send your inquiry to support@hydrogenpay.com

Features

  • Integrate as a Component
  • Integrate as a Directive

Requirements

Angular 17 and higher

API Documentation

https://docs.hydrogenpay.com

Implementation

You should already have your apiKey, If not, go to https://dashboard.hydrogenpay.com.

Injecting the library

Import the NgHydrogenModule into your checkout module

import { BrowserModule } from "@angular/platform-browser";
import { NgModule } from "@angular/core";
import { NgHydrogenModule } from "hydrogen-angular";

import { AppComponent } from "./app.component";

@NgModule({
  declarations: [AppComponent],
  imports: [BrowserModule, NgHydrogenModule],
  providers: [],
  bootstrap: [AppComponent],
})
export class AppModule {}

Implementation in your Application

import { Component } from "@angular/core";

@Component({
  selector: "app-root",
  templateUrl: "./app.component.html",
  styleUrl: "./app.component.css",
})
export class AppComponent {
  title = "hydrogenpay-angular-example";

  options = {
    currency: "NGN", // REQUIRED
    description: "TEST", // OPTIONAL
    email: "test@emaildomain.com", // REQUIRED
    customerName: "test test", // REQUIRED
    amount: 500, // REQUIRED
    apiKey: "E2E411B102072296C73F76339497FB8529FF552F0D6817E0F3B46A243961CA21", // REQUIRED
    mode: "TEST", // REQUIRED
    isRecurring: false, // OPTIONAL
    frequency: 1, // OPTIONAL
    endDate: "2025-11-01", // OPTIONAL but (REQUIRED if isRecurring === true)
    meta: "test", // OPTIONAL
  };

  PaymentComplete(res: any) {
    const { response, closeModal } = res;
    console.log("response", response);

    setTimeout(() => {
      closeModal();
    }, 4000);
  }
  PaymentClose(response: any) {
    console.log("cancel");
    console.log(response);
  }
}

Implementation in your Component Template

As a Component

<hydrogen-ng class="custom-class" (onSuccess)="PaymentDone($event)" (onClose)="PaymentCancel($event)" [options]="options"> Payment Modal as a Component </hydrogen-ng>

As a Directive

<button class="custom-class" hydrogen-ng (onSuccess)="PaymentDone($event)" (onClose)="PaymentCancel($event)" [options]="options">Payment Modal as a Component</button>

Options Type

NameTypeRequiredDesc
currencyStringRequiredThe currency for the transaction e.g NGN, USD
emailStringRequiredThe email of the user to be charged
descriptionStringOptionalThe transaction description
customerNameStringRequiredThe fullname of the user to be charged
amountNumberRequiredThe transaction amount
apiKeyStringRequiredYour apiKey or see above step to get yours
onSuccessFunctionRequiredCallback when transaction is successful
onCloseFunctionRequiredCallback when transaction is closed of cancel
isRecurringbooleanOptionalRecurring Payment
frequencyStringOptionalRecurring Payment frequency
modeStringRequiredPayment Mode e.g LIVE, TEST (default: TEST)
endDateStringOptionalRecurring Payment End Date. OPTIONAL but (REQUIRED when isRecurring = true)
0.0.5

11 months ago

0.0.4

11 months ago

0.0.1

11 months ago