Payment Enquiry
Know Payment details with SingleView Payments API
Overview
SingleView Payment API retrieves payment details by using the Payment Enquiry option. The Transaction number and other information must be included in the request body. The system processes these details, and the payment details will be provided based on the validity of the requested information.
Users can request payment enquiries for both single payments and bulk payments.
Important information
- To request single payment details, mention "SINGLEREQ" in "messageType" of the request body
- To request bulk payment details, mention "BULKREQ" in "messageType" of the request body
Get Payment Enquiry
Endpoint details
| Endpoint URL | Method | Authentication requirements |
|---|---|---|
/v1/api/osvPlatform/paymentEnquiry | POST | 1. clientId 2. clientCode 3. signature 4. sid 5. Authorization: Bearer |
Sample request
A Payment Enquiry request in the following format should be posted to the URL https://servicesuat.onesingleview.com/v1/api/osvPlatform/paymentEnquiry.
curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/osvPlatform/paymentEnquiry' \
--header 'clientId: Enter_Client_ID' \
--header 'clientCode: Enter_Client_Code' \
--header 'Content-Type: application/json' \
--header 'Cookie: _redisPractice=s%3Ay4kF1GA_ibdpeffd7FkfQuOqTXeToD9a.Y5zI1Y3FPImLmHSIy2dUpPrJ47vFGBD7tj7Vv0ndYo4' \
--data-raw '{
"osvPlatformPaymentEnquiryRQ": {
"userName":"Enter_Username",
"osvPlatformBanks": [
{
"bankCode": "Enter_Bank_Code",
"messageType": "SINGLEREQ",
"osvPlatformTransactions": [
{
"companyCode": "Enter_Company_Code",
"sequenceNum": "Enter_Sequence_Number",
"transactionReferenceNumber": "Enter_Transaction_Reference_Number",
"b2bIdentifier": "Enter_B2B_Identifier",
"b2bUserId": "Enter_B2B_User_ID",
"b2bUrn": "Enter_B2B_URN",
"b2bAggrId":"Enter_B2B_Aggregate_ID"
},
{
"companyCode": "Enter_Company_Code",
"sequenceNum": "Enter_Sequence_Number",
"transactionReferenceNumber": "Enter_Transaction_Reference_Number",
"b2bIdentifier": "Enter_B2B_Identifier",
"b2bUserId": "Enter_B2B_User_ID",
"b2bUrn": "Enter_B2B_URN",
"b2bAggrId":"Enter_B2B_Aggregate_ID"
}
]
},
{
"bankCode": "Enter_Bank_Code",
"messageType": "BULKREQ",
"osvPlatformTransactions": [
{
"companyCode": "Enter_Company_Code",
"sequenceNum": "Enter_Sequence_Number",
"transactionReferenceNumber": "Enter_Transaction_Reference_Number",
"b2bIdentifier": "Enter_B2B_Identifier",
"b2bUserId": "Enter_B2B_User_ID",
"b2bUrn": "Enter_B2B_URN",
"b2bAggrId":"Enter_B2B_Aggregate_ID"
},
{
"companyCode": "Enter_Company_Code",
"sequenceNum": "Enter_Sequence_Number",
"transactionReferenceNumber": "Enter_Transaction_Reference_Number",
"b2bIdentifier": "Enter_B2B_Identifier",
"b2bUserId": "Enter_B2B_User_ID",
"b2bUrn": "Enter_B2B_URN",
"b2bAggrId":"Enter_B2B_Aggregate_ID"
}
]
}
]
}
}'
Request description:
| JSON Tag | Description | Data type |
|---|---|---|
| clientId Mandatory | Client ID | String |
| clientCode Mandatory | Client Code | String |
| osvPlatformPaymentEnquiryRQ Mandatory | Payment Enquiry Request Tag | Object |
| userName Mandatory | Account Username | String |
| osvPlatformBanks Mandatory | Array of Banks | Array |
| bankCode Mandatory | Bank Code as per Bank Name | String |
| messageType Mandatory | Type of payment | String |
| osvPlatformTransactions Mandatory | Array of Transactions | Array |
| companyCode Mandatory | Company Code | String |
| sequenceNum Mandatory | Sequence Number | String |
| transactionReferenceNumber Mandatory | Transaction Reference Number of the payment | String |
| b2bIdentifier Mandatory | B2B Identifier with respect to Bank | String |
| b2bUserId Mandatory | B2B User ID with respect to Bank | String |
| b2bUrn Mandatory | B2B URN with respect to Bank | String |
| b2bAggrId Mandatory | B2B Aggregate ID with respect to Bank | String |
| SINGLEREQ Mandatory | Request Tag for Single Payments | String |
| BULKREQ Mandatory | Request Tag for Bulk Payments | Object |
Sample responses
Valid/Successful response
✔️ If Valid information in the header and body of a request is processed successfully
{
"osvPlatformPaymentEnquiryRS":{
"osvPlatformBanks": [
{
"bankCode": "Bank_Code",
"messageType": "SINGLEREQ",
"osvPlatformTransactions": [
{
"companyCode": "Company_Code",
"sequenceNum": "Sequence_Number",
"transactionReferenceNumber": "Transaction_Reference_Number",
"ftReferenceNumber": "FT_Reference_Number",
"bankReferenceNumber": "Bank_Reference_Number",
"transactionType": "Type_of_Transaction",
"debitAccountNo": "Debit_Account_Number",
"accountName1": "Name_of_the_Account_Holder",
"debitCurrency": "Currency",
"debitTheirRef": "Debit_Their_Reference",
"creditTheirRef": "Credit_Their_Reference",
"creditAccountNo": "Credit_Account-Number",
"accountName2": "Name_of_the_Account_Holder",
"creditCurrency": "Currency",
"creditAmount": 00.00,
"amountDebited": 00.00,
"customerRate": "Customer_Rate",
"amountCredited": 00.00,
"benCustomer1": "",
"debitValueDate": "Date_Debited",
"creditValueDate": "Date_Credited",
"paymentDetails1": "Payment_Details",
"paymentDetails2": "Payment_Details",
"statusCode": "Status_Code",
"statusDesc": "Status_Description"
},
{
"companyCode": "Company_Code",
"sequenceNum": "Sequence_Number",
"transactionReferenceNumber": "Transaction_Reference_Number",
"ftReferenceNumber": "FT_Reference_Number",
"bankReferenceNumber": "Bank_Reference_Number",
"transactionType": "Type_of_Transaction",
"debitAccountNo": "Debit_Account_Number",
"accountName1": "Name_of_the_Account_Holder",
"debitCurrency": "Currency",
"debitTheirRef": "Debit_Their_Reference",
"creditTheirRef": "Credit_Their_Reference",
"creditAccountNo": "Credit_Account-Number",
"accountName2": "Name_of_the_Account_Holder",
"creditCurrency": "Currency",
"creditAmount": 00.00,
"amountDebited": 00.00,
"customerRate": "Customer_Rate",
"amountCredited": 00.00,
"benCustomer1": "",
"debitValueDate": "Date_Debited",
"creditValueDate": "Date_Credited",
"paymentDetails1": "Payment_Details",
"paymentDetails2": "Payment_Details",
"statusCode": "Status_Code",
"statusDesc": "Status_Description"
}
]
},
{
"BankCode": "Bank_Code",
"messageType": "BULKREQ",
"osvPlatformTransactions": [
{
"companyCode": "Company_Code",
"sequenceNum": "Sequence_Number",
"transactionReferenceNumber": "Transaction_Reference_Number",
"ftReferenceNumber": "FT_Reference_Number",
"bankReferenceNumber": "Bank_Reference_Number",
"transactionType": "Type_of_Transaction",
"debitAccountNo": "Debit_Account_Number",
"accountName1": "Name_of_the_Account_Holder",
"debitCurrency": "Currency",
"debitTheirRef": "Debit_Their_Reference",
"creditTheirRef": "Credit_Their_Reference",
"creditAccountNo": "Credit_Account-Number",
"accountName2": "Name_of_the_Account_Holder",
"creditCurrency": "Currency",
"creditAmount": 00.00,
"amountDebited": 00.00,
"customerRate": "Customer_Rate",
"amountCredited": 00.00,
"benCustomer1": "",
"debitValueDate": "Date_Debited",
"creditValueDate": "Date_Credited",
"paymentDetails1": "Payment_Details",
"paymentDetails2": "Payment_Details",
"statusCode": "Status_Code",
"statusDesc": "Status_Description"
},
{
"companyCode": "Company_Code",
"sequenceNum": "Sequence_Number",
"transactionReferenceNumber": "Transaction_Reference_Number",
"ftReferenceNumber": "FT_Reference_Number",
"bankReferenceNumber": "Bank_Reference_Number",
"transactionType": "Type_of_Transaction",
"debitAccountNo": "Debit_Account_Number",
"accountName1": "Name_of_the_Account_Holder",
"debitCurrency": "Currency",
"debitTheirRef": "Debit_Their_Reference",
"creditTheirRef": "Credit_Their_Reference",
"creditAccountNo": "Credit_Account-Number",
"accountName2": "Name_of_the_Account_Holder",
"creditCurrency": "Currency",
"creditAmount": 00.00,
"amountDebited": 00.00,
"customerRate": "Customer_Rate",
"amountCredited": 00.00,
"benCustomer1": "",
"debitValueDate": "Date_Debited",
"creditValueDate": "Date_Credited",
"paymentDetails1": "Payment_Details",
"paymentDetails2": "Payment_Details",
"statusCode": "Status_Code",
"statusDesc": "Status_Description"
},
{
"companyCode": "Company_Code",
"sequenceNum": "Sequence_Number",
"transactionReferenceNumber": "Transaction_Reference_Number",
"ftReferenceNumber": "FT_Reference_Number",
"bankReferenceNumber": "Bank_Reference_Number",
"transactionType": "Type_of_Transaction",
"debitAccountNo": "Debit_Account_Number",
"accountName1": "Name_of_the_Account_Holder",
"debitCurrency": "Currency",
"debitTheirRef": "Debit_Their_Reference",
"creditTheirRef": "Credit_Their_Reference",
"creditAccountNo": "Credit_Account-Number",
"accountName2": "Name_of_the_Account_Holder",
"creditCurrency": "Currency",
"creditAmount": 00.00,
"amountDebited": 00.00,
"customerRate": "Customer_Rate",
"amountCredited": 00.00,
"benCustomer1": "",
"debitValueDate": "Date_Debited",
"creditValueDate": "Date_Credited",
"paymentDetails1": "Payment_Details",
"paymentDetails2": "Payment_Details",
"statusCode": "Status_Code",
"statusDesc": "Status_Description"
},
{
"companyCode": "Company_Code",
"sequenceNum": "Sequence_Number",
"transactionReferenceNumber": "Transaction_Reference_Number",
"ftReferenceNumber": "FT_Reference_Number",
"bankReferenceNumber": "Bank_Reference_Number",
"transactionType": "Type_of_Transaction",
"debitAccountNo": "Debit_Account_Number",
"accountName1": "Name_of_the_Account_Holder",
"debitCurrency": "Currency",
"debitTheirRef": "Debit_Their_Reference",
"creditTheirRef": "Credit_Their_Reference",
"creditAccountNo": "Credit_Account-Number",
"accountName2": "Name_of_the_Account_Holder",
"creditCurrency": "Currency",
"creditAmount": 00.00,
"amountDebited": 00.00,
"customerRate": "Customer_Rate",
"amountCredited": 00.00,
"benCustomer1": "",
"debitValueDate": "Date_Debited",
"creditValueDate": "Date_Credited",
"paymentDetails1": "Payment_Details",
"paymentDetails2": "Payment_Details",
"statusCode": "Status_Code",
"statusDesc": "Status_Description"
}
]
}
]
}
Valid/Successful response description:
| JSON Tag | Description | Data type |
|---|---|---|
| osvPlatformPaymentRS | Payment Response Tag | Object |
| status | Status of the process | String |
| transactionReferenceNumber | Transaction Reference Number by SV | String |
| osvPlatformBanks | Array of Banks | Array |
| bankCode | Bank Code | String |
| messageType | Requested Payment Type - Bulk or Single | String |
| osvPlatformTransactions | Array of transactions for enquiry | Array |
| companyCode | Company Code | String |
| sequenceNum | Sequence Number | String |
| transactionReferenceNumber | Transaction Reference Number | String |
| ftReferenceNumber | FT Reference Number | String |
| bankReferenceNumber | Bank Reference Number | String |
| transferType | Type of transfer | String |
| debitAccountNo | Debiting account number | String |
| accountName1 | Name of the debited account holder | String |
| debitCurrency | Currency in which the amount is debited | String |
| debitTheirRef | Debit Their Reference | String |
| creditTheirRef | Credit Their Reference | String |
| creditAccountNo | Name of the credited account holder | String |
| accountName2 | Rate provided to the customer | String |
| creditCurrency | Currency in which the amount is credited | String |
| creditAmount | Amount credited | String |
| amountDebited | Amount debited | String |
| benCustomer1 | Beneficiary details | String |
| debitValueDate | Amount debited date | String |
| creditValueDate | Amount credited date | String |
| paymentDetails1 paymentDetails2 | Payment details/comments | String |
| statusCode | Status Code | String |
| statusDesc | Status Description | String |
Invalid/Failed response
❌ If Invalid information in the header of a request is processed successfully
{
status: "FAILURE",
errorCode: "Failed_Code",
message: "Failed_Message"
}
Invalid/failed response description:
| JSON Tag | Description | Data type |
|---|---|---|
| status | Status of the Process | String |
| errorCode | Error Code | String |
| message | Response Message | String |
Response in case of a Technical error is encountered
⚠️ When the process encounters a technical error
{
status: "TECHERROR",
errorCode: "Error_Code",
message: "Error_Message"
}
Error response description:
| JSON Tag | Description | Data type |
|---|---|---|
| status | Status of the Process | String |
| errorCode | Error Code | String |
| message | Response Message | String |
Updated 5 months ago