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

Try in API Reference ➜

Endpoint details

Endpoint URL	Method	Authentication requirements
`/v1/api/erp/svPayEnquiryService/`	POST	`clientid` `clientsecret` `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": "SV0001",
      "fromDate": "2024-06-01",
      "toDate": "2024-06-31",
      "payId": [
        "468741"
      ],
      "authId": [
        "335707985"
      ],
      "type": "payment"
    }
  ]
}
}'

Request details:

JSON Tag	Description	Data type
svPayEnquiryServiceRQ Mandatory	Payment enquiry request tag	Object
company Mandatory	Array of companies	Array
companyCode Mandatory	Unique company code	String
type Mandatory	Transaction type to be mentioned among `payment` or `statement`	String
Mandatory	Any of the following fields is mandatory: `fromDate` & `toDate` `payId` `authId`
fromDate Conditional	From Date Period YYYY-MM-DD format	String
toDate Conditional	To Date Period YYYY-MM-DD format	String
payId Conditional	Array of ERP pay IDs	Array
authId Conditional	Array of ERP Authentication IDs	Array

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

{
  "svPayEnquiryServiceRS": {
    "company": [
      {
        "companyCode": "SV0001",
        "payment": [
          {
            "payId": "468741",
            "authId": "335707985",
            "seqNum": "595562489248932",
            "svRefId": "49494622648494",
            "currency": "SAR",
            "txnDate": "2024-06-02T11:12:13Z",
            "status": 0, // completed
            "approval_status": 0,
            "type": "payment",
            "bankCharges":"Y", // Y or N
            "chargeAmount":40.00,
            "amount": 40000.00            
          }
        ]
      }
    ]
  }
}

{
  "svPayEnquiryServiceRS": {
    "company": [
      {
        "companyCode": "SV0001",
        "payment": [
          {
            "payId": "468741",
            "authId": "335707985",
            "seqNum": "595562489248932",
            "svRefId": "49494622648494",
            "currency": "SAR",
            "txnDate": "2024-06-02T11:12:13Z",
            "status": 4,
            "approval_status": 4,
            "comments": "Reject 05-Nov-25",
            "type": "payment",
            "bankCharges":"N",
            "chargeAmount":0,
            "amount": 40000.00            
          }
        ]
      }
    ]
  }
}

{
  "svPayEnquiryServiceRS": {
    "company": [
      {
        "companyCode": "SV0001",
        "payment": [
          {
            "payId": "468741",
            "authId": "335707985",
            "seqNum": "595562489248932",
            "svRefId": "49494622648494",
            "currency": "SAR",
            "txnDate": "2024-06-02T11:12:13Z",
            "status": 1,
            "approval_status": 3,
            "message": "Account not linked to user id/Customer",
            "type": "payment",
            "bankCharges":"N",
            "chargeAmount":0,
            "amount": 40000.00            
          }
        ]
      }
    ]
  }
}

Response description:

JSON Tag	Description	Data type
svPaymentServiceRS	Add payment services Response Tag	Object
company	Array of companies	Array
companyCode	Unique company code	String
payment	Array of payments	Array
payId	Unique reference id toward payment request from ERP	String
authId	SingleView Authentication ID	String
seqNum	Sequence number	String
svRefId	SingleView Reference ID	String
currency	Currency of payment	String
txnDate	Transaction date	String
status	Status of the payment	String
approval_status	Approval status of the payment request	String
comments	Appears for rejected payment and denotes the comment provided by the approver for rejecting the request	String
message	Appears for failed payment and provides the info on the reason for failure	String
type	Transaction type to be mentioned as `payment`	String
bankCharges	Status of amount charged by the bank denoted as `Y` or `N`	String
chargeAmount	Charged Amount for the transaction	Numerical
amount	Amount of the transaction	Numerical

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