Payment Enquiry

Know Payment details with Singleview Payments API

Overview

Singleview Payments API can be used to retrieve payment details by using the Payment Enquiry option. Transaction number along with other information need to be included in the request body. These details are processed by the system and the payment details will be provided based on the validity of the request information.

Users can request the payment enquiry for both single payments as well as bulk payment.

📘

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

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 TagDescriptionData type
clientId
Mandatory
Client IDString
clientCode
Mandatory
Client CodeString
osvPlatformPaymentEnquiryRQ
Mandatory
Payment Enquiry Request TagObject
userName
Mandatory
Account UsernameString
osvPlatformBanks
Mandatory
Array of BanksArray
bankCode
Mandatory
Bank Code as per Bank NameString
messageType
Mandatory
Type of paymentString
osvPlatformTransactions
Mandatory
Array of TransactionsArray
companyCode
Mandatory
Company CodeString
sequenceNum
Mandatory
Sequence NumberString
transactionReferenceNumber
Mandatory
Transaction Reference Number of the paymentString
b2bIdentifier
Mandatory
B2B Identifier with respect to BankString
b2bUserId
Mandatory
B2B User ID with respect to BankString
b2bUrn
Mandatory
B2B URN with respect to BankString
b2bAggrId
Mandatory
B2B Aggregate ID with respect to BankString
SINGLEREQ
Mandatory
Request Tag for Single PaymentsString
BULKREQ
Mandatory
Request Tag for Bulk PaymentsObject

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 TagDescriptionData type
osvPlatformPaymentRSPayment Response TagObject
statusStatus of the processString
transactionReferenceNumberTransaction Reference Number by SVString
osvPlatformBanksArray of BanksArray
bankCodeBank CodeString
messageTypeRequested Payment Type - Bulk or SingleString
osvPlatformTransactionsArray of transactions for enquiryArray
companyCodeCompany CodeString
sequenceNumSequence NumberString
transactionReferenceNumberTransaction Reference NumberString
ftReferenceNumberFT Reference NumberString
bankReferenceNumberBank Reference NumberString
transferTypeType of transferString
debitAccountNoDebiting account numberString
accountName1Name of the debited account holderString
debitCurrencyCurrency in which the amount is debitedString
debitTheirRefDebit Their ReferenceString
creditTheirRefCredit Their ReferenceString
creditAccountNoName of the credited account holderString
accountName2Rate provided to the customerString
creditCurrencyCurrency in which the amount is creditedString
creditAmountAmount creditedString
amountDebitedAmount debitedString
benCustomer1Beneficiary detailsString
debitValueDateAmount debited dateString
creditValueDateAmount credited dateString
paymentDetails1
paymentDetails2
Payment details/commentsString
statusCodeStatus CodeString
statusDescStatus DescriptionString

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 TagDescriptionData type
statusStatus of the ProcessString
errorCodeError CodeString
messageResponse MessageString

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 TagDescriptionData type
statusStatus of the ProcessString
errorCodeError CodeString
messageResponse MessageString