Payment Enquiry

Get payment request details and status

Payment Enquiry API services allows you to know the payment information that has been processed. This allows you to track and get the payment status in real-time.

Get Payment Enquiry

Endpoint details

Endpoint URLMethodAuthentication requirements
/v1/api/erp/svPayEnquiryService/POST1. clientid 2. clientsecret 3. signature

A request in the following format should be posted to the above-mentioned endpoint to fetch the payment status and details:

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svPayEnquiryService' \
--header 'clientid: Enter_Client_ID' \
--header 'clientsecret: Enter_Client_Secret' \
--header 'signature: Enter_Signature' \
--header 'Content-Type: application/json' \
--data-raw '{
"svPayEnquiryServiceRQ": {
  "company": [
    {
      "companyCode": "INV01",
      "fromDate": "2024-06-01",
      "toDate": "2024-06-31",
      "payId": [
        "468741"
      ],
      "authId": [
        "Authentication_ID"
      ],
      "type": "Type" //payment or statement
    }
  ]
}
}'

Request details:

JSON TagDescriptionData type
clientid
Mandatory
Client IDString
clientsecret
Mandatory
Client CodeString
signature
Mandatory
SignatureString
svPayEnquiryServiceRQ
Mandatory
Payment enquiry request tagObject
company
Mandatory
Array of companiesArray
companyCode
Mandatory
Unique company codeString
fromDate
Mandatory
From Date PeriodString
toDate
Mandatory
To Date PeriodString
payId
Mandatory
Array of ERP pay IDsArray
authId
Mandatory
Array of ERP Authentication IDsArray
type
Mandatory
Transaction type to be mentioned among payment or statementString

If the details are found to be valid, the following successful response will be displayed:

{
  "svPayEnquiryServiceRS": {
    "company": [
      {
        "companyCode": "Company_Code",
        "payment": [
          {
            "payId": "Payment_ID",
            "authId": "Authentication_ID",
            "seqNum": "Sequence_Number",
            "svRefId": "SV_Reference_ID",
            "amount": 00.00,
            "currency": "Currency",
            "txnDate": "YYYY-MM-DDTHH:MM:SSZ",
            "status": Status, // completed
            "approval_status": Approval_Status,
            "bankCharges":"Y or N",
            "chargeAmount":00.00
          },
          {
            "payId": "Payment_ID",
            "authId": "Authentication_ID",
            "seqNum": "Sequence_Number",
            "svRefId": "SV_Reference_ID",
            "amount": 00.00,
            "currency": "Currency",
            "txnDate": "YYYY-MM-DDTHH:MM:SSZ",
            "status": Status, // completed
            "approval_status": Approval_Status,
            "bankCharges":"Y or N",
            "chargeAmount":00.00
          }
        ]
      }
    ]
  }
}

Response description:

JSON TagDescriptionData type
svPaymentServiceRSAdd payment services Response TagObject
companyArray of companiesArray
companyCodeUnique company codeString
paymentArray of paymentsArray
authIdSingleView Authentication IDString
payIdUnique reference id toward payment request from ERPString
seqNumSequence numberString
svRefIdSingleView Reference IDString
amountAmountString
currencyCurrency of paymentString
txnDateTransaction dateString
statusStatus of the paymentString
approval_statusApproval status of the payment requestString
bankChargesStatus of amount charged by the bank denoted as Y or NString
chargeAmountCharged AmountString

📘

Note

Refer Types & Statuses for more info on payment status update codes.