System Integrator (SI) ToolkitSystem Integrator (SI) Toolkit
Introduction
Management
Business Operations
Technical Integration Guide
Deployment
Technical Reference
Scheme Designs
Introduction
Management
Business Operations
Technical Integration Guide
Deployment
Technical Reference
Scheme Designs
  • Introduction

    • System Integrator (SI) Toolkit
    • DFSP Onboarding Guide and Roadmap
    • Customer Journey
  • Management
  • Business Operations
  • Technical Integration Guide

    • Technical Integration
    • Inclusive Instant Payment System (IIPS) Integration
    • Development guide for building core-connectors
    • Core Connector Testing Harness
    • Core Connector Template
    • ISO20022 and Merchant Payments.
  • Deployment

    • Overview
    • Docker Compose

      • Payment Manager Deployment Guide
      • Core Connector Guide
      • Deploying Payment Manager
      • Configuring the core connectors
      • Connecting to a Hub
      • Securing the Docker Daemon
      • Firewall Configuration in Ubuntu and AWS EC2 (t2.large)
      • Test Transfer Process
  • Technical Reference

    • API Service
    • Routing and API Specifications
    • Networking
    • Core Banking Solution (CBS) Client
    • Mojaloop Connector Client (SDK Client)
    • Configuration.
    • Core Connector Aggregate (Business Logic)
    • Error Handling
    • Integration Accounts
    • Request Handling Lifecycle
  • Scheme Designs

    • Foreign Exchange - Currency Conversion
    • Interscheme

Mojaloop Connector Client (SDK Client)

The SDK Client is responsible for all communication between the core connector and the mojalooop connector's SDK Scheme Adapter Service. The SDK client is used to call the mojaloop connectors's outbound api.

Usage

To use the SDK Client, make sure the SDK_BASE_URL environment variable is set in the .env (PROD) or .env.example(DEV)

Instantiating

import { SDKClientFactory } from '../domain/SDKClient';

const sdkClient = SDKClientFactory.getSDKClientInstance(
        logger,
        httpClient,
        config.get('sdkSchemeAdapter.SDK_BASE_URL'),
    ); // creating an instance of the class

POST /transfers

To execute this api call using the SDK Client , refer to this example

const res =  await sdkClient.initiateTransfer(transferRequest);

This method call will make a POST /transfers request to the SDK Scheme Adapter to trigger an outbound transfer.

PUT /transfers/{transferId}

To execute this api call using the SDK Client, refer to this example.

const res = await sdkClient.updateTransfer({ acceptQuote: true }, crypto.randomUUID());

This method call will make a PUT /transfers/{transferId} request to the SDK Scheme Adapter to update an outbound transfer with quote acceptance status.

Last Updated:
Contributors: Paul Baker
Prev
Core Banking Solution (CBS) Client
Next
Configuration.