Reference & Glossary
Handy information! Know about the commonly used terms in the documentation.
Reference
Client
A registered user of SingleView Payments API. A client has the right to access the SingleView Payments API services integrated into their application.
Client credentials
Client credentials refer to the login details of the client's SingleView Payments API user account. These are mainly 3:
- Client ID & Client Code
In the header of every request, Client ID and Client Code are the details used to verify, authenticate, and authorize any activities.
- Signature Key
A signature Key is used to generate the Signature Code. The signature key can be located in the user's SingleView Payments API profile. Signature Code generated through a valid Signature Key holds the validity and authority of a request processing. Refer
User credentials
Credentials or login information of a 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 Payments 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 to 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 a 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
Payments API
SingleView Payments API refers to an integrated platform to perform payment operations
Payment Enquiry
Get the transaction details of a particular payment by providing a reference in the request
Process payment
Process payment or payment processing refers to 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
Transaction Enquiry
Details of all the financial activities made in a specific time frame
O
openingBalance
The amount, negative or positive, available at the start of an accounting period in a particular bank account
Updated 5 months ago