https://github.com/peoray/bloc-nodejs

Last synced: 10 months ago
JSON representation
Host: GitHub
URL: https://github.com/peoray/bloc-nodejs
Owner: peoray
License: mit
Created: 2024-01-07T22:40:48.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-01-30T10:14:20.000Z (almost 2 years ago)
Last Synced: 2025-02-26T06:06:25.354Z (11 months ago)
Language: TypeScript
Size: 194 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

          # Bloc Nodejs SDK

![npm (scoped)](https://img.shields.io/npm/v/bloc-nodejs?color=%23FF7B37&style=flat-square) ![npm](https://img.shields.io/npm/dm/bloc-nodejs?style=flat-square)

A Nodejs API wrapper for [Bloc](https://www.blochq.io/) banking services written in typescript

## Table of content

- [Prerequisites](#prerequisites)

- [Getting started](#getting-started)

- [Installation](#installation)

- [Usage](#usage)

- [Available Methods exposed by the SDK](#available-methods-exposed-by-the-sdk)

  - [Accounts API](#accounts-api)

    - [Create Fixed Account](#create-fixed-account)

    - [Create Collection Account](#create-collection-account)

    - [Get accounts](#get-accounts)

    - [Get Account By ID](#get-account-by-id)

    - [Get Collection Account](#get-collection-account)

    - [Get Account by Account Number](#get-account-by-account-number)

    - [Get Customer Accounts](#get-customer-accounts)

    - [Get Organisation Default Accounts](#get-organisation-default-accounts)

    - [Freeze Account](#freeze-account)

    - [Unfreeze Account](#unfreeze-account)

    - [Close Account](#close-account)

    - [Reopen Account](#reopen-account)

  - [Wallets API](#wallets-api)

    - [Create Wallet](#create-wallet)

    - [Get Wallets](#get-wallets)

    - [Get Wallet by id](#get-wallet-by-id)

    - [Get Customer Wallets](#get-customer-wallets)

    - [Debit Wallet](#debit-wallet)

  - [Bills Payments API](#bills-payments-api)

    - [Get Supported Bills](#get-supported-bills)

    - [Get Supported Operators](#get-supported-operators)

    - [Get Operator Products](#get-operator-products)

    - [Customer Device Validation](#customer-device-validation)

    - [Make Payment](#make-payment)

  - [Disputes API](#disputes-api)

    - [Get Card Dispute Reasons](#get-card-dispute-reasons)

    - [Create Card Dispute](#create-card-dispute)

    - [Get Card Disputes](#get-card-disputes)

    - [Get Card Dispute](#get-card-dispute)

    - [Update Card Dispute](#update-card-dispute)

  - [Cards API](#cards-api)

    - [Issue Card](#issue-card)

    - [Get Cards](#get-cards)

    - [Get Card By ID](#get-card-by-id)

    - [Get Customer Cards](#get-customer-cards)

    - [Get Card Secure Data](#get-card-secure-data)

    - [Change Card PIN](#change-card-pin)

    - [Freeze Card](#freeze-card)

    - [Unfreeze Card](#unfreeze-card)

    - [Block Card](#block-card)

    - [Link Card with Fixed Account](#link-card-with-fixed-account)

    - [Unlink Card From Fixed Account](#unlink-card-from-fixed-account)

    - [Fund Card](#fund-card)

    - [Withdraw From Card](#withdraw-from-card)

  - [Checkout API](#checkout-api)

    - [Create Checkout](#create-checkout)

  - [Customers API](#customers-api)

    - [Create Customer](#create-customer)

    - [Get Customers](#get-customers)

    - [Upgrade Customer to KYC T1](#upgrade-customer-to-kyc-t1)

    - [Upgrade Customer to KYC T2](#upgrade-customer-to-kyc-t2)

    - [Upgrade Customer to KYC T3](#upgrade-customer-to-kyc-t3)

    - [Update Customer](#update-customer)

    - [Get Customer By ID](#get-customer-by-id)

    - [Means of Identification](#means-of-identification)

    - [Revalidate Customer KYC](#revalidate-customer-kyc)

  - [Miscellaneous API](#miscellaneous-api)

    - [Get List of Banks](#get-list-of-banks)

    - [Resolve Account](#resolve-account)

    - [Get Exchange Rate](#get-exchange-rate)

  - [Simulation API](#simulation-api)

    - [Credit Account](#credit-account)

    - [Debit Account](#debit-account)

  - [Transactions API](#transactions-api)

    - [Get All Transactions](#get-all-transactions)

    - [Get Transaction by Reference](#get-transaction-by-reference)

  - [Transfers API](#transfers-api)

    - [Transfer From A Fixed Account](#transfer-from-a-fixed-account)

    - [Transfer From Organization Balance](#transfer-from-organization-balance)

    - [Internal transfer](#internal-transfer)

    - [Bulk transfer](#bulk-transfer)

  - [Webhook API](#webhook-api)

    - [Set Webhook](#set-webhook)

    - [Get Webhook](#get-webhook)

  - [Payment Links API](#payment-links-api)

    - [Create Payment Link](#create-payment-link)

    - [Get Payment Links](#get-payment-links)

    - [Get Payment Link By id](#get-payment-link-by-id)

    - [Edit Payment Link](#edit-payment-link)

    - [Delete Payment Link](#delete-payment-link)

  - [Beneficiaries API](#beneficiaries-api)

    - [Create Beneficiary](#create-beneficiary)

    - [Get Beneficiary by ID](#get-beneficiary-by-id)

    - [Update Beneficiary](#update-beneficiary)

    - [Delete beneficiary](#delete-beneficiary)

- [License](#license)

## Prerequisites

Node v16 and higher is required. To make sure you have them available on your machine, try running the following command.

```sh

 node -v

```

## Getting Started

To get started with this SDK, create an account on [Bloc](https://app.blochq.io/auth/sign-up) if you haven't already.

You can then retrieve your API keys from your [Bloc dashboard](https://docs.blochq.io/docs/quick-start).

## Installation

This SDK can be installed with npm or yarn or pnpm.

```sh

# using npm

npm install bloc-nodejs

# using yarn

yarn install bloc-nodejs

# using pnpm

pnpm add bloc-nodejs

```

## Usage

Import and Initialize the library

```ts

// use modules

import { Bloc } from 'bloc-nodejs';

// use cjs

const { Bloc } = require('bloc-nodejs')

// Instantiate the bloc class

const bloc = new Bloc('SECRET_KEY, PUBLIC_KEY');

```

## Available Methods exposed by the SDK

### Accounts API

Accounts API operations

#### Create Fixed Account

```ts

// import the accounts interfaces from the sdk

import type { ICreateFixedAccountRequest, IAccountResponse } from 'bloc-nodejs';

const payload: ICreateFixedAccountRequest = {

  // payload data

}

const response = await bloc.createFixedAccount(payload)

console.log(response) // IAccountResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/createfixedaccount)

#### Create Collection Account

```ts

// import the accounts interfaces from the sdk

import type { ICreateCollectionAccountRequest, ICreateCollectionAccountResponse } from 'bloc-nodejs';

const payload: ICreateCollectionAccountRequest = {

  // payload data

}

const response = await bloc.createCollectionAccount(payload)

console.log(response) // ICreateCollectionAccountResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/createcollectionaccount)

#### Get Accounts

```ts

// import the accounts interfaces from the sdk

import type { IGetAccountsResponse } from 'bloc-nodejs';

const response = await bloc.getAccounts(payload)

console.log(response) // IGetAccountsResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getaccounts)

#### Get Account By ID

```ts

// import the accounts interfaces from the sdk

import type { IAccountResponse } from 'bloc-nodejs';

const response = await bloc.getAccountById('account-id')

console.log(response) // IAccountResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getaccountbyid)

#### Get Collection Account

```ts

// import the accounts interfaces from the sdk

import type { IGetCollectionAccountResponse } from 'bloc-nodejs';

const response = await bloc.getCollectionAccount()

console.log(response) // IGetCollectionAccountResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getcollectionaccount)

#### Get Account by Account Number

```ts

// import the accounts interfaces from the sdk

import type { IAccountResponse } from 'bloc-nodejs';

const response = await bloc.getAccountByAccountNumber('account-number')

console.log(response) // IAccountResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getaccountbyaccountnumber)

#### Get Customer Accounts

```ts

// import the accounts interfaces from the sdk

import type { IGetAccountsResponse } from 'bloc-nodejs';

const response = await bloc.getCustomerAccounts('customer-id')

console.log(response) // IGetAccountsResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getcustomeraccounts)

#### Get Organisation Default Accounts

```ts

// import the accounts interfaces from the sdk

import type { IGetOrganisationDefaultAccountsResponse } from 'bloc-nodejs';

const response = await bloc.getOrganisationDefaultAccounts()

console.log(response) // IGetOrganisationDefaultAccountsResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getorganisationdefaultaccounts)

#### Freeze Account

```ts

// import the accounts interfaces from the sdk

import type { IUpdateAccountRequest, IUpdateAccountResponse } from 'bloc-nodejs';

const payload: IUpdateAccountRequest = {

  // payload data

}

const response = await bloc.freezeAccount('account-id', data)

console.log(response) // IUpdateAccountResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/freezeaccount)

#### Unfreeze Account

```ts

// import the accounts interfaces from the sdk

import type { IUpdateAccountRequest, IUpdateAccountResponse } from 'bloc-nodejs';

const payload: IUpdateAccountRequest = {

  // payload data

}

const response = await bloc.unfreezeAccount('account-id', data)

console.log(response) // IUpdateAccountResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/unfreezeaccount-1)

#### Close Account

```ts

// import the accounts interfaces from the sdk

import type { IUpdateAccountRequest, IUpdateAccountResponse } from 'bloc-nodejs';

const payload: IUpdateAccountRequest = {

  // payload data

}

const response = await bloc.closeAccount('account-id', data)

console.log(response) // IUpdateAccountResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/closeaccount)

#### Reopen Account

```ts

// import the accounts interfaces from the sdk

import type { IUpdateAccountRequest, IUpdateAccountResponse } from 'bloc-nodejs';

const payload: IUpdateAccountRequest = {

  // payload data

}

const response = await bloc.reopenAccount('account-id', data)

console.log(response) // IUpdateAccountResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/reopenaccount)

### Wallets API

Wallets API operations

#### Create Wallet

```ts

// import the wallet interfaces from the sdk

import type { IWallet, IWalletResponse } from 'bloc-nodejs';

const payload: IWallet = {

  // payload to create wallet

}

const response = await bloc.createWallet(payload)

console.log(response) // IWalletResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/createwallet)

#### Get Wallets

```ts

// import the wallet interfaces from the sdk

import type { IGetWalletResponse } from 'bloc-nodejs';

const response = await bloc.getWallets()

console.log(response) // IGetWalletResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getwallets)

#### Get Wallet By ID

```ts

// import the wallet interfaces from the sdk

import type { IWalletResponse } from 'bloc-nodejs';

const response = await bloc.getWalletById('wallet-id')

console.log(response) // IWalletResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getwalletbyid)

#### Get Customer Wallets

```ts

// import the wallet interfaces from the sdk

import type { IGetCustomerWalletResponse } from 'bloc-nodejs';

const response = await bloc.getCustomerWallets('customer-id')

console.log(response) // IGetCustomerWalletResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getcustomerwallets)

#### Debit Wallet

```ts

// import the wallet interfaces from the sdk

import type { IDebitWallet, IGetCustomerWalletResponse } from 'bloc-nodejs';

const payload: IDebitWallet = {

  // payload to debit wallet

}

const response = await bloc.debitWallet(payload)

console.log(response) // IGetCustomerWalletResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/debitwallet)

### Bills Payments API

Bills Payments API operations

#### Get Supported Bills

```ts

// import the bills-payments interfaces from the sdk

import type { ISupportedBillsResponse } from 'bloc-nodejs';

const response = await bloc.getSupportedBills()

console.log(response) // ISupportedBillsResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getsupportedbills)

#### Get Supported Operators

```ts

// import the bills-payments interfaces from the sdk

import type { ISupportedOperatorsResponse } from 'bloc-nodejs';

const response = await bloc.getSupportedOperators()

console.log(response) // ISupportedOperatorsResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getsupportedoperators)

#### Get Operator Products

```ts

// import the bills-payments interfaces from the sdk

import type { IOperatorProductsResponse } from 'bloc-nodejs';

const response = await bloc.getOperatorProducts('operator-id')

console.log(response) // IOperatorProductsResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getoperatorproducts)

#### Customer Device Validation

```ts

// import the bills-payments interfaces from the sdk

import type { IGetCustomerWalletResponse } from 'bloc-nodejs';

const response = await bloc.customerDeviceValidation('operator-id')

console.log(response) // IGetCustomerWalletResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/customerdevicevalidation)

#### Make Payment

```ts

// import the bills-payment interfaces from the sdk

import type { IMakePaymentResponse, IMakePaymentResponse } from 'bloc-nodejs';

const payload: IMakePaymentResponse = {

  // payload to make payment

}

const response = await bloc.makePayment(payload)

console.log(response) // IMakePaymentResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/debitwallet)

### Disputes API

Disputes API operations

#### Get Card Dispute Reasons

```ts

// import the disputes interfaces from the sdk

import type { IGetCardDisputeReasonsResponse } from 'bloc-nodejs';

const response = await bloc.getCardDisputeReasons()

console.log(response) // IGetCardDisputeReasonsResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getcarddisputereasons)

#### Create Card Dispute

```ts

// import the disputes interfaces from the sdk

import type { ICreateCardDisputeRequest, ICardDisputeResponse } from 'bloc-nodejs';

const payload: ICreateCardDisputeRequest = {

  // payload to create card dispute

}

const response = await bloc.createCardDispute(payload)

console.log(response) // ICardDisputeResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/createcarddispute)

#### Get Card Disputes

```ts

// import the disputes interfaces from the sdk

import type { IGetCardDisputesResponse } from 'bloc-nodejs';

const response = await bloc.getCardDisputes()

console.log(response) // IGetCardDisputesResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getcarddisputes)

#### Get Card Dispute

```ts

// import the disputes interfaces from the sdk

import type { ICardDisputeResponse } from 'bloc-nodejs';

const response = await bloc.getCardDisputeById('dispute-id')

console.log(response) // ICardDisputeResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getcarddispute)

#### Update Card Dispute

```ts

// import the disputes interfaces from the sdk

import type { IUpdateCardDisputeRequest, ICardDisputeResponse } from 'bloc-nodejs';

const payload: IUpdateCardDisputeRequest = {

  // payload to update card dispute

}

const response = await bloc.updateCardDispute('dispute-id', payload)

console.log(response) // ICardDisputeResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/updatecarddispute)

### Cards API

Cards API operations

#### Issue Card

```ts

// import the cards interfaces from the sdk

import type { IIssueCardRequest, ICardResponse } from 'bloc-nodejs';

const payload: IIssueCardRequest = {

  // payload to issue card

}

const response = await bloc.issueCard(payload)

console.log(response) // ICardResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/issuecard)

#### Get Cards

```ts

// import the cards interfaces from the sdk

import type { IGetCardsResponse } from 'bloc-nodejs';

const response = await bloc.getCards()

console.log(response) // IGetCardsResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getcards)

#### Get Card by Id

```ts

// import the cards interfaces from the sdk

import type { ICardResponse } from 'bloc-nodejs';

const response = await bloc.getCardById('card-id')

console.log(response) // ICardResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getcardbyid)

#### Get Customer Cards

```ts

// import the cards interfaces from the sdk

import type { IGetCardsResponse } from 'bloc-nodejs';

const response = await bloc.getCustomerCards('customer-id')

console.log(response) // IGetCardsResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getcustomercards)

#### Get Card Secure Data

```ts

// import the cards interfaces from the sdk

import type { ICardSecureDataResponse } from 'bloc-nodejs';

const response = await bloc.getCardSecureData('card-id')

console.log(response) // ICardSecureDataResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getcardsecuredata)

#### Change Card PIN

```ts

// import the cards interfaces from the sdk

import type { IChangeCardPinRequest, ICardResponse } from 'bloc-nodejs';

const payload: IChangeCardPinRequest = {

  // payload to change card pin

}

const response = await bloc.changeCardPIN('card-id', payload)

console.log(response) // ICardResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/changecardpin)

#### Freeze Card

```ts

// import the cards interfaces from the sdk

import type { ICardResponse } from 'bloc-nodejs';

const response = await bloc.freezeCard('card-id')

console.log(response) // ICardResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/freezecard)

#### Unfreeze Card

```ts

// import the cards interfaces from the sdk

import type { ICardResponse } from 'bloc-nodejs';

const response = await bloc.unfreezeCard('card-id')

console.log(response) // ICardResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/unfreezecard)

#### Block Card

```ts

// import the cards interfaces from the sdk

import type { IBlockCardRequest, ICardResponse } from 'bloc-nodejs';

const payload: IBlockCardRequest = {

  // payload to block card

}

const response = await bloc.blockCard('card-id', payload)

console.log(response) // ICardResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/blockcard)

#### Link Card with Fixed Account

```ts

// import the cards interfaces from the sdk

import type { ILinkCardwithFixedAccountRequest, ICardResponse } from 'bloc-nodejs';

const payload: ILinkCardwithFixedAccountRequest = {

  // payload to link card with fixed account

}

const response = await bloc.linkCardwithFixedAccount(payload)

console.log(response) // ICardResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/linkcardwithfixedaccount)

#### Unlink Card From Fixed Account

```ts

// import the cards interfaces from the sdk

import type { ICardResponse } from 'bloc-nodejs';

const response = await bloc.unlinkCardwithFixedAccount('card-id')

console.log(response) // ICardResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/unlinkcardfromfixedaccount)

#### Fund Card

```ts

// import the cards interfaces from the sdk

import type { IFundCardRequest, ICardResponse } from 'bloc-nodejs';

const payload: IFundCardRequest = {

  // payload to fund card

}

const response = await bloc.fundCard('card-id', payload)

console.log(response) // ICardResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/fundcard)

#### Withdraw From Card

```ts

// import the cards interfaces from the sdk

import type { IWithdrawFromCardRequest, ICardResponse } from 'bloc-nodejs';

const payload: IWithdrawFromCardRequest = {

  // payload to withdraw from card

}

const response = await bloc.withdrawFromCard('card-id', payload)

console.log(response) // ICardResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/withdrawfromcard)

### Checkout API

Checkout API operations

#### Create Checkout

```ts

// import the create checkout interfaces from the sdk

import type { ICreateCheckout, ICheckoutResponse } from 'bloc-nodejs';

const payload: ICreateCheckout = {

  // payload to create checkout

}

const response = await bloc.createCheckout(payload)

console.log(response) // ICheckoutResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/createcheckout)

### Customers API

Customer API operations

#### Create Customer

```ts

// import the customer interfaces from the sdk

import type { ICreateCustomer, ICreateCustomerResponse } from 'bloc-nodejs';

const payload: ICreateCustomer = {

  // payload to create checkout   

}

const response = await bloc.createCustomer(payload)

console.log(response) // ICreateCustomerResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/createcustomers)

#### Get Customers

```ts

// import the message interfaces from the sdk

import type { IGetCustomerResponse } from 'bloc-nodejs';

const response = await bloc.getCustomers()

console.log(response) // IGetCustomerResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getcustomers)

#### Upgrade Customer to KYC T1

```ts

// import the customer interfaces from the sdk

import type { IUpgradeCustomerToKYCT1, IUpgradeCustomerToKYCTierResponse } from 'bloc-nodejs';

const payload: IUpgradeCustomerToKYCT1 = {

  // payload data  

}

const response = await bloc.upgradeCustomerToKYCT1('customer-id', payload)

console.log(response) // IUpgradeCustomerToKYCTierResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/upgradecustomertokyct1)

#### Upgrade Customer to KYC T2

```ts

// import the customer interfaces from the sdk

import type { IUpgradeCustomerToKYCT2, IUpgradeCustomerToKYCTierResponse } from 'bloc-nodejs';

const payload: IUpgradeCustomerToKYCT2 = {

  // payload data  

}

const response = await bloc.upgradeCustomerToKYCT2('customer-id', payload)

console.log(response) // IUpgradeCustomerToKYCTierResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/upgradecustomertokyct2)

#### Upgrade Customer to KYC T3

```ts

// import the customer interfaces from the sdk

import type { IUpgradeCustomerToKYCT3, IUpgradeCustomerToKYCTierResponse } from 'bloc-nodejs';

const payload: IUpgradeCustomerToKYCT3 = {

  // payload data  

}

const response = await bloc.upgradeCustomerToKYCT3('customer-id', payload)

console.log(response) // IUpgradeCustomerToKYCTierResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/upgradecustomertokyct3)

#### Update Customer

```ts

// import the customer interfaces from the sdk

import type { IUpdateCustomer, IUpdateCustomerResponse } from 'bloc-nodejs';

const payload: IUpdateCustomer = {

  // payload data  

}

const response = await bloc.updateCustomer('customer-id', payload)

console.log(response) // IUpdateCustomerResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/updatecustomer)

#### Get Customer By ID

```ts

// import the customer interfaces from the sdk

import type { IGetCustomerByIdResponse } from 'bloc-nodejs';

const response = await bloc.getCustomerById('customer-id')

console.log(response) // IGetCustomerByIdResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getcustomerbyid)

#### Means of Identification

```ts

// import the customer interfaces from the sdk

import type { IMeansOfIdentification } from 'bloc-nodejs';

const response = await bloc.meansOfIdentification()

console.log(response) // IMeansOfIdentification

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/meansofidentification)

#### Revalidate Customer KYC

```ts

// import the customer interfaces from the sdk

import type { IRevalidateCustomerKYCResponse } from 'bloc-nodejs';

const response = await bloc.revalidateCustomerKYC('customer-id')

console.log(response) // IRevalidateCustomerKYCResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/revalidatecustomerkyc)

### Miscellaneous API

Miscellaneous API operations

#### Get List of Banks

```ts

// import the miscellaneous interfaces from the sdk

import type { IListOfBanksResponse } from 'bloc-nodejs';

const response = await bloc.getListOfBanks()

console.log(response) // IListOfBanksResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getlistofbanks)

#### Resolve Account

```ts

// import the miscellaneous interfaces from the sdk

import type { IResolveAccountResponse } from 'bloc-nodejs';

const response = await bloc.resolveAccount()

console.log(response) // IResolveAccountResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/resolveaccount)

#### Get Exchange Rate

```ts

// import the miscellaneous interfaces from the sdk

import type { IGetExchangeRateResponse } from 'bloc-nodejs';

const response = await bloc.getExchangeRate('NGN-USD')

console.log(response) // IGetExchangeRateResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getexchangerate)

### Simulation API

Simulation API operations

#### Credit Account

```ts

// import the simulation interfaces from the sdk

import type { ISimulationAccount, ICreditAccountResponse } from 'bloc-nodejs';

const payload: ISimulationAccount = {

  // payload data

}

const response = await bloc.creditAccount(payload)

console.log(response) // ICreditAccountResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/creditaccount)

#### Debit Account

```ts

// import the simulation interfaces from the sdk

import type { ISimulationAccount, IDebitAccountResponse } from 'bloc-nodejs';

const payload: ISimulationAccount = {

  // payload data

}

const response = await bloc.debitAccount(payload)

console.log(response) // IDebitAccountResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/debitaccount)

### Transactions API

Transactions API operations

#### Get All Transactions

```ts

// import the transactions interfaces from the sdk

import type { ITransactionResponse } from 'bloc-nodejs';

const response = await bloc.getAllTransactions()

console.log(response) // ITransactionResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getalltransactions)

#### Get Transaction by Reference

```ts

// import the transactions interfaces from the sdk

import type { ITransactionByReferenceResponse } from 'bloc-nodejs';

const response = await bloc.getTransactionByReference('ref_num')

console.log(response) // ITransactionByReferenceResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getalltransactions)

### Transfers API

Transfers API operations

#### Transfer From A Fixed Account

```ts

// import the transfers interfaces from the sdk

import type { ITransferFromAFixedAccountRequest, ITransferResponse } from 'bloc-nodejs';

const payload: ITransferFromAFixedAccountRequest = {

  // payload data  

}

const response = await bloc.transferFromAFixedAccount(payload)

console.log(response) // ITransferResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/transferfromafixedaccount)

#### Transfer From Organization Balance

```ts

// import the transfers interfaces from the sdk

import type { ITransferFromOrganizationBalance, ITransferResponse } from 'bloc-nodejs';

const payload: ITransferFromOrganizationBalance = {

  // payload data  

}

const response = await bloc.transferFromOrganizationBalance(payload)

console.log(response) // ITransferResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/transferfromorganizationbalance)

#### Internal Transfer

```ts

// import the transfers interfaces from the sdk

import type { IInternalTransferRequest, ITransferResponse } from 'bloc-nodejs';

const payload: IInternalTransferRequest = {

  // payload data  

}

const response = await bloc.internalTransfer(payload)

console.log(response) // ITransferResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/internaltransfer)

#### Bulk Transfer

```ts

// import the transfers interfaces from the sdk

import type { IBulkTransferRequest, ITransferResponse } from 'bloc-nodejs';

const payload: IBulkTransferRequest = {

  // payload data  

}

const response = await bloc.bulkTransfer(payload)

console.log(response) // ITransferResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/bulktransfer)

### Webhook API

Webhook API operations

#### Set Webhook

```ts

// import the webhook interfaces from the sdk

import type { ISetWebhook, IWebhookResponse } from 'bloc-nodejs';

const payload: ISetWebhook = {

  // payload data  

}

const response = await bloc.setWebhook(payload)

console.log(response) // IWebhookResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/setwebhook)

#### Get Webhook

```ts

// import the webhook interfaces from the sdk

import type { IWebhookResponse } from 'bloc-nodejs';

const response = await bloc.getWebhook()

console.log(response) // IWebhookResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getwebhook)

### Payment Links API

Payment Link API operations

#### Create Payment Link

```ts

// import the payment-links interfaces from the sdk

import type { ICreatePaymentLinkRequest, IPaymentLinkResponse } from 'bloc-nodejs';

const payload: ICreatePaymentLinkRequest = {

  // payload data  

}

const response = await bloc.createPaymentLink(payload)

console.log(response) // IPaymentLinkResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/createpaymentlink)

#### Get Payment Links

```ts

// import the payment-links interfaces from the sdk

import type { IGetPaymentLinksResponse } from 'bloc-nodejs';

const response = await bloc.getPaymentLinks()

console.log(response) // IGetPaymentLinksResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getpaymentlinks)

#### Get Payment Link By id

```ts

// import the payment-links interfaces from the sdk

import type { IPaymentLinkResponse } from 'bloc-nodejs';

const response = await bloc.getPaymentLinkById('link-id')

console.log(response) // IPaymentLinkResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getpaymentlinkbyid)

#### Edit Payment Link

```ts

// import the payment-links interfaces from the sdk

import type { IEditPaymentLinkRequest, IPaymentLinkResponse } from 'bloc-nodejs';

const payload: IEditPaymentLinkRequest = {

  // payload data  

}

const response = await bloc.editPaymentLink('link-id', payload)

console.log(response) // IPaymentLinkResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/editpaymentlink)

#### Delete Payment Link

```ts

// import the payment-links interfaces from the sdk

import type { IDeletePaymentLinksRequest, IPaymentLinkResponse } from 'bloc-nodejs';

const payload: IDeletePaymentLinksRequest = {

  // payload data  

}

const response = await bloc.deletePaymentLink(payload)

console.log(response) // IPaymentLinkResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/deletepaymentlink)

### Beneficiaries API

Beneficiaries API operations

#### Create Beneficiary

```ts

// import the beneficiary interfaces from the sdk

import type { ICreateBeneficiary, IBeneficiaryResponse } from 'bloc-nodejs';

const payload: ICreateBeneficiary = {

  // payload data  

}

const response = await bloc.createBeneficiary(payload)

console.log(response) // IBeneficiaryResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/createbeneficiary)

#### Get Beneficiary by ID

```ts

// import the beneficiary interfaces from the sdk

import type { IBeneficiaryResponse } from 'bloc-nodejs';

const response = await bloc.getBeneficiaryById('beneficiary-id')

console.log(response) // IBeneficiaryResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/getbeneficiarybyid)

#### Update Beneficiary

```ts

// import the beneficiary interfaces from the sdk

import type { IUpdateBeneficiary, IBeneficiaryResponse } from 'bloc-nodejs';

const payload: ICreateBeneficiary = {

  // payload data  

}

const response = await bloc.updateBeneficiary('beneficiary-id', payload)

console.log(response) // IBeneficiaryResponse

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/updatebeneficiary)

#### Delete Beneficiary

```ts

const response = await bloc.deleteBeneficiary('beneficiary-id')

console.log(response) // any

```

Find more details about the parameters and response for the above method [here](https://docs.blochq.io/reference/deletebeneficiary)

## License

[MIT](./LICENSE)

[Back to Top](#table-of-content)
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/peoray/bloc-nodejs

Awesome Lists containing this project

README
