Reference & Glossary

Handy information! Know about the commonly used terms in the documentation.

Reference

Client

A registered user of SingleView ERP Integration API. Client has the right to access the SingleView ERP Integration API services integrated into their application.

Client credentials

Client credentials refer to the login details of the client's SingleView ERP Integration API user account. These are mainly 3:

  • Client ID & Client Code

Required in the header of every request, Client ID and Client Code are the details that are used to verify, authenticate and authorize any activities.

  • Signature Key

Signature Key is used to generate Signature Code. The Signature Key can be located in the SingleView ERP Integration API profile of the user. Signature Code generated through a valid Signature Key holds the validity and authority of a request processing.

User credentials

Credentials or login information of an user authorized to access the Client's application. The user is created or approved by the client. As the system is integrated, the user is paired to SingleView ERP Integration API. The user credentials refer to a valid combination of username/user id and password for a specific user account.

Glossary

A

Account

  • Client Account or Client-end User (Client User) Account
  • An account with a Bank or Financial Institution

Account Balance

Amounts belonging or held in a bank account

accountNumber

Bank account number (IBAN)

accountStatus

The status of the account, either active or inactive

API

Application Programming Interface

Authentication

Process to verify the user and authorize to perform operations at the platform

availableBalance

The current available balance in a specific bank account

B

b2bAggrId

Business Aggregator Identification

b2bIdentifier

Business Identifier

b2bUrn

Business Uniform Resource Name

b2bUserId

Business User Identification

bankCode

Bank Code (SWIFT, IFSC, etc.)

bankAvailableBalance

The current available balance in the listed accounts belonging to a particular bank

bankClosingBalance

The amount at the end of an accounting period in the listed accounts belonging to a particular bank

bankOpeningBalance

The amount, negative or positive, available at the start of the accounting period in the listed accounts belonging to a particular bank

C

closingBalance

The amount available at the end of an accounting period in a specific bank account

H

Header

The top portion of a request

HTTP-based platform

A platform that runs on web server and is accessed through the Internet

J

JSON Request

A request in JSON (JavaScript Object Notation) recommended format to access SingleView API Services

P

Payment Enquiry

Get the transaction details of a particular payment by providing reference in the request

Process payment

Process payment or payment processing refers as a request to initiate a payment(s)

R

Response

System output to the user/client regarding a specific request

Request

An instruction to access or perform an operation using SingleView API Services

S

sid

Session ID

T

Transaction

A financial activity