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 URL | Method | Authentication requirements |
---|---|---|
/v1/api/erp/svPayEnquiryService/ | POST | 1. 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 Tag | Description | Data type |
---|---|---|
clientid Mandatory | Client ID | String |
clientsecret Mandatory | Client Code | String |
signature Mandatory | Signature | String |
svPayEnquiryServiceRQ Mandatory | Payment enquiry request tag | Object |
company Mandatory | Array of companies | Array |
companyCode Mandatory | Unique company code | String |
fromDate Mandatory | From Date Period | String |
toDate Mandatory | To Date Period | String |
payId Mandatory | Array of ERP pay IDs | Array |
authId Mandatory | Array of ERP Authentication IDs | Array |
type Mandatory | Transaction type to be mentioned among payment or statement | String |
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 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 |
authId | SingleView Authentication ID | String |
payId | Unique reference id toward payment request from ERP | String |
seqNum | Sequence number | String |
svRefId | SingleView Reference ID | String |
amount | Amount | 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 |
bankCharges | Status of amount charged by the bank denoted as Y or N | String |
chargeAmount | Charged Amount | String |
Note
Refer
Types & Statuses
for more info on payment status update codes.
Updated about 2 months ago