Spotflow Angular Library

The Spotflow Angular SDK enables users to make payments seamlessly. It integrates smoothly into your Angular application, providing a streamlined checkout experience.

Available Features:

• Collections: Card, Bank Transfers.
• Recurring Payments: Tokenization and Subscriptions.

Table of Contents

1. Requirements
2. Installation
3. Usage
4. Parameters
5. License
6. Contribution Guidelines
7. Contributors

Requirements

1. Spoflow Encryption keys
2. Spotflow API keys
3. Node versions >= 16.x.x npm >=7.x.x

Demo

Installation

  $ npm install @spot-flow/ng-spotflow-checkout
# or 
  $ yarn add @spot-flow/ng-spotflow-checkout
# or 
  pnpm add @spot-flow/ng-spotflow-checkout

Usage

As a component

app.module.ts

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';

import { AppComponent } from './app.component';
import { SpotflowAngularCheckoutModule } from '@spot-flow/ng-spotflow-checkout';

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

app.component.ts

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

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css'],
})

export class AppComponent {
  title = 'spotflow-ng-demo';
  currency = 'NGN' // This is not required for subscription payments
  amount = 400; // This is not required for subscription payments
  email = '[email protected]';
  merchantKey = "sk_test_fXXXXedhXXXXXXXXXXXXXXXX";
  planId = '9e0808304-344d-XXXXXXXXX-XXXXX834034'; // This is not required for one time payments
  encryptionKey = 'SKKXXXXXXXXXXXXXXXXX';
}

app.component.html

  <spotflow-make-payment
    text="Pay"
    [secret_key]="merchantKey"
    [plan_id]="planId"   <!-- This is not required for one time payments -->
    [email]="email"
    [amount]="amount"   <!--This is not required for subscription payments -->
    [currency]="currency" <!--This is not required for subscription payments -->
    [encryption_key]="encryptionKey"
    [style]="{ 'background-color': 'black', color: 'white' }"
  >
  </spotflow-make-payment>

Parameters

Read more about our parameters and how they can be used here.

| Parameter | Required |Description | | ------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | merchantKey | True | Your API secret | | reference | False | Your transaction reference. This MUST be unique for every transaction | | amount | False | Amount to charge the customer. This is not required when making a subscription payment | | currency | False | Currency to charge in. This is not required when a making subscription payment | | encryptionKey | True | This is the encryption key for the merchant | | planId | True | This is the plan id being paid for. This is not required when making one time payments | | firstname | False | This is the Customer First Name | | lastname | False | This is the Customer Last Name | | regionId (optional) | False | This is the merchant's region where the customer is subscribed to | | phone (optional) | False | This is the phone number of the customer |

Contribution Guidelines

We welcome contributions from the community. Read more about our community contribution guidelines here.

License

By contributing to this library, you agree that your contributions will be licensed under its MIT license.

Copyright (c) Spotflow Inc.

Contributors

• Olukayode Ogunnowo
• Oluwatomisin Jimoh