Getting Started with Gd.Bos.V1

Introduction

Green Dot BaaS Partner API

Install the Package

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

| Parameter | Type | Description | | --- | --- | --- | | defaultHost | string | Default: 'www.example.com' | | environment | Environment | The API environment. Default: Environment.Production | | timeout | number | Timeout for API calls.Default: 0 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | logging | PartialLoggingOptions | Logging Configuration to enable logging | | customHeaderAuthenticationCredentials | CustomHeaderAuthenticationCredentials | The credential object for customHeaderAuthentication |

The API client can be initialized as follows:

Code-Based Client Initialization

import { Client, Environment, LogLevel } from 'apimatic-greendot-sdk';

const client = new Client({
  customHeaderAuthenticationCredentials: {
    'Authorization': 'Authorization'
  },
  timeout: 0,
  environment: Environment.Production,
  logging: {
    logLevel: LogLevel.Info,
    logRequest: {
      logBody: true
    },
    logResponse: {
      logHeaders: true
    }
  },
  defaultHost: 'www.example.com',
});

Configuration-Based Client Initialization

import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'apimatic-greendot-sdk';

// Provide absolute path for the configuration file
const absolutePath = path.resolve('./config.json');

// Read the configuration file content
const fileContent = fs.readFileSync(absolutePath, 'utf-8');

// Initialize client from JSON configuration content
const client = Client.fromJsonConfig(fileContent);

See the Configuration-Based Client Initialization section for details.

Environment-Based Client Initialization

import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'apimatic-greendot-sdk';

// Optional - Provide absolute path for the .env file
const absolutePath = path.resolve('./.env');

if (fs.existsSync(absolutePath)) {
  // Load environment variables from .env file
  dotenv.config({ path: absolutePath, override: true });
}

// Initialize client using environment variables
const client = Client.fromEnvironment(process.env);

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

| Name | Description | | --- | --- | | Production | Default |

Authorization

This API uses the following authentication schemes.

• Bearer (Custom Header Signature)

List of APIs

• Health Checks
• AB Testing Admin
• Account
• Adjustment
• Affiliate
• AMM Rule
• Authentication
• Bill Pay
• Business Profile
• Card Option
• Care Case
• Cashback Reward
• Categorize Transaction
• Contact Verification
• Credit Builder
• Custom Card
• Device Verification
• Direct Deposit
• Disbursement
• Dispute Automation
• E Cash
• E Gift
• Enrollments
• Event
• Experian
• External Account
• External Cards
• Feature Eligibility
• Fee
• Guest Verification
• Health Check
• Hosted User Experience
• Interest Rate
• Kyc
• Locator
• Notification
• Order
• Paper Check
• Payment
• Payment Instrument
• Payment Instrument Token
• Payment Instrument Vgs
• Product Feature Limits
• Products
• Program
• Purse
• Scc
• Scc Eligibilities
• Token Management
• Transaction Event
• Transactions
• Transfers
• Users
• VIP Feature

SDK Infrastructure

Configuration

• HttpClientOptions
• RetryConfiguration
• ProxySettings
• Configuration-Based Client Initialization
• Environment-Based Client Initialization
• PartialLoggingOptions
• PartialRequestLoggingOptions
• PartialResponseLoggingOptions
• LoggerInterface

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError