Post-Payment Enquiry
Fetch updated status of the processed Payouts payments
Introduction
SingleView Post-Payment Enquiry services connect Corporate users via a secure channel and enable them to enquire about the status of their transactions quickly and easily. The key feature of the service allows the user to get immediate acknowledgment about the most recent status of their payments.
Important information
This service can be used to verify the status of the following types of payment transactions made by the user:
- Within own accounts
- Local payments (SARIE)
- International payments (SWIFT)
The client needs to initiate a Post-Payment Transaction Enquiry request via the B2B system for the following banks:
- Al Rajhi Bank
- Arab National Bank (ANB)
- Saudi Awwal Bank (SAB)
Payment enquiry not required
There is no need to initiate a post-payment transaction enquiry request, as the user will receive an instant confirmation for the following banks:
- Alinma Bank
- Banque Saudi Fransi (BSF)
- Saudi National Bank (SNB)
- Riyad Bank
🌐Domain details
- Sandbox API - https://sandboxapi.onesingleview.com
- Production/LIVE API - To be provided upon onboarding
Post-payment Enquiry
Endpoint details
| Endpoint URL | Method | Authentication requirements |
|---|---|---|
/api/v1/batch/paymentenquiry | POST | 1/. clientid (Optional)2. clientsecret (Optional)3. SVReferenceID4. Device5. DateTimeStamp6. CompanyId7. Authroization: Bearer (Token)8. Signature |
Synchronous Method
Sample request
curl --location 'https://sandboxapi.onesingleview.com/api/batch/paymentenquiry' \
--header 'clientsecret: abcdef83643f61c975'
--header 'clientid: zyxvw95cE163C03b7d1'
--header 'CompanyId: MYCOMPANY'
--header 'SVReferenceID: Enter-SV-Reference-Id'
--header 'DateTimeStamp :2025-01-02T10:20:39'
--header 'Device: Web'
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNMlZ4WGpFZmR6WFNWaTFad3B5QnlkOVpHelZXR2ZwUmFQNUV1TXl6S1Aybi94Y0lwR2V5STNNMkdPL1pqakd4ZG0yclJKUkdhRXlaWGNpWnZnOHArMWIyOGtOQTVkZ0VKajVVSEdiTmtNPSIsImlhdCI6MTczNTgwMTQ3NywiZXhwIjoxNzM1ODA1MDc3fQ.Bh7LFkvxNFrLe9dmH5rURWjGpES-u4z2EGeyrNM7z6E'
--header 'Content-Type: application/json' \
--data '{
"Message": {
"OSVPaymentMessageRequest": {
"SVReferenceID": "OSVRefFTIB0000000001",
"OSVPaymentStatusRequest": [
{
"BankCode": "ALRAJHI",
"MessageType":"SINGLEREQ",
"Transactions": [
{
"SequenceNum": "79878097",
"CompanyCode": "125001291",
"TransactionReferenceNumber": "797688999",
"BankReferenceNumber" : "",
"PaymentMessageType":"MT100-Others"
}
]
}
]
}
},
"Signature": "Enter_Signature"
}'
Request description
| JSON Tag | Description | Data type |
|---|---|---|
| Message Mandatory | Header information (client credentials) | Object & Strings |
| OSVPaymentMessageRequest Mandatory | Root node containing all the payment enquiry message | Object |
| OSVPaymentStatusRequest Mandatory | Tag carrying information on the payment enquiry request | Object |
| Transactions Mandatory | Tag carrying information of transactions to be requested for payment enquiry | Object |
| B2BUrn Mandatory | Unique B2B reference number | String |
| B2BUserId Mandatory | Unique B2B user identification details | String |
| PaymentMessageType Mandatory | Details on the payment type to be mentioned as MT100 | String |
| CompanyCode Mandatory | Sender company code or identifier provided by the bank at the time of on-boarding | Alphanumeric |
| TransactionReferenceNumber Mandatory | Transaction reference number Maximum length : 16 numeric characters | String |
| SequenceNum Mandatory | Sequence number of the transaction Length of input: 16 characters | Numeric |
| B2BAggrId Mandatory | Unique B2B aggregator identification details | String |
| BankCode Mandatory | Unique bank identification code Ex: ALRAJHI, SABB, BSF, ANB, NCB, ALINMA, GIB, RIYADH, ALBI, BJAZ, ICICI, HDFC | String |
| MessageType Mandatory | Details on the type of message request to be mentioned as SINGLEREQ | String |
| Signature Mandatory | Encrypted string generated using a Private Key/CA-Signed Certificate with SHA-256 and RSA (JCE Signature) | String |
Sample Responses
{
"OSVPaymentEnquiryResponse": [
{
"BankCode": "ALRAJHI",
"MessageType": "SINGLEREQ",
"OSVPaymentStatusResponse": [
{
"CompanyCode": "125001291",
"SequenceNum": "79878097",
"StatusCode": "SUCCESS",
"StatusDesc": "ReceiptReconSuccess-Transport Receipt Recon is successful",
"TransactionReferenceNumber": "797688999",
"FTReferenceNumber": "",
"BankReferenceNumber": "",
"TransactionType": "",
"DebitAccountNo": "",
"AccountName1": "",
"DebitCurrency": "",
"DebitTheirRef": "",
"CreditTheirRef": "",
"CreditAccountNo": "",
"AccountName2": "",
"CreditCurrency": "",
"CreditAmount": "",
"AmountDebited": "",
"CustomerRate": "",
"AmountCredited": "",
"BenCustomer1": "",
"DebitValueDate": "",
"CreditValueDate": "",
"PaymentDetails1": "",
"PaymentDetails2": "",
"UniqueId": "",
"UtrNumber": ""
}
]
}
]
}
{
"OSVPaymentEnquiryResponse": [
{
"BankCode": "ALRAJHI",
"MessageType": "SINGLEREQ",
"OSVPaymentStatusResponse": [
{
"CompanyCode": "125001291",
"SequenceNum": "77858797",
"StatusCode": "PENDING",
"StatusDesc": "Your Payment file has been accepted, Kindly attempt to do a Payment Inquiry in a few minutes to know the Final status.",
"TransactionReferenceNumber": "797647499",
"FTReferenceNumber": "",
"BankReferenceNumber": "",
"TransactionType": "",
"DebitAccountNo": "",
"AccountName1": "",
"DebitCurrency": "",
"DebitTheirRef": "",
"CreditTheirRef": "",
"CreditAccountNo": "",
"AccountName2": "",
"CreditCurrency": "",
"CreditAmount": "",
"AmountDebited": "",
"CustomerRate": "",
"AmountCredited": "",
"BenCustomer1": "",
"DebitValueDate": "",
"CreditValueDate": "",
"PaymentDetails1": "",
"PaymentDetails2": "",
"UniqueId": "",
"UtrNumber": ""
}
]
}
]
}
{
"OSVPaymentEnquiryResponse": [
{
"BankCode": "ALRAJHI",
"MessageType": "SINGLEREQ",
"OSVPaymentStatusResponse": [
{
"CompanyCode": "125001291",
"SequenceNum": "79878097",
"StatusCode": "FAILED",
"StatusDesc": "No Transaction found in the Requested Reference No.",
"TransactionReferenceNumber": "79768899",
"FTReferenceNumber": "",
"BankReferenceNumber": "",
"TransactionType": "",
"DebitAccountNo": "",
"AccountName1": "",
"DebitCurrency": "",
"DebitTheirRef": "",
"CreditTheirRef": "",
"CreditAccountNo": "",
"AccountName2": "",
"CreditCurrency": "",
"CreditAmount": "",
"AmountDebited": "",
"CustomerRate": "",
"AmountCredited": "",
"BenCustomer1": "",
"DebitValueDate": "",
"CreditValueDate": "",
"PaymentDetails1": "",
"PaymentDetails2": "",
"UniqueId": "",
"UtrNumber": ""
}
]
}
]
}
Responses description
| JSON Tag | Description | Data type |
|---|---|---|
| OSVPaymentEnquiryResponse | Root node | Object |
| MessageType | Type of message response indicated as SINGLEREQ | String |
| OSVPaymentStatusResponse | Element root containing response of every bank transaction | Object |
| CompanyCode | Sender company Code/Identifier | Alphanumeric |
| SequenceNum | Value of “SequenceNum” tag in the request message | Numerical |
| StatusCode | Status code of the response SUCCESS- For successfully settled payment PENDING- For a pending payment FAILED- For a payment failed processing | String |
| StatusDesc | Status description of the response | String |
| TransactionReferenceNumber | Unique number representing the transactions | Alphanumeric |
| FTReferenceNumber | File Reference Number | String |
| BankReferenceNumber | Bank Reference Number | String |
| TransactionType | Transaction Type | String |
| DebitAccountNo | Debit Account Number | String |
| AccountName1 | Account Name 1 | String |
| DebitCurrency | Debit Currency | String |
| DebitTheirRef | Debit Their Reference | String |
| CreditTheirRef | Credit Their Reference | String |
| CreditAccountNo | Credit Account Number | String |
| AccountName2 | Account Name 2 | String |
| CreditCurrency | Credit Currency | String |
| CreditAmount | Credit Amount | String |
| AmountDebited | Amount Debited | String |
| CustomerRate | Customer Rate | String |
| AmountCredited | Amount Credited | String |
| BenCustomer1 | Beneficiary Customer 1 | String |
| DebitValueDate | Debit Value Date | String |
| CreditValueDate | Credit Value Date | String |
| PaymentDetails1 | Payment Details 1 | String |
| PaymentDetails2 | Payment Details 2 | String |
| UniqueId | Unique identification details | String |
| UtrNumber | Unique transaction reference number | String |
Asynchronous Method
Sample request
curl --location 'https://sandboxapi.onesingleview.com/api/batch/paymentenquiry' \
--header 'clientsecret: Enter-Client-Secret' \
--header 'clientid: Enter-Client-Id' \
--header 'SVReferenceID: Enter-SV-Reference-Id' \
--header 'Device: Device-type' \
--header 'DateTimeStamp: YYYY-MM-DDTHH:MM:SS' \
--header 'CompanyId: Enter-Company-Id' \
--header 'BaseCurrency: SAR' \
--header 'Authorization: Bearer <Enter-Token>' \
--header 'Content-Type: application/json' \
--data '{
"Message":
{
"OSVPaymentMessageRequest": {
"SVReferenceID": "OSVRefFTIB0000000001",
"OSVPaymentStatusRequest": [
{
"BankCode": "ALRAJHI",
"MessageType":"SINGLEREQ",
"Transactions": [
{
"SequenceNum": "77858797",
"CompanyCode": "125001291",
"TransactionReferenceNumber": "797647499",
"BankReferenceNumber" : "",
"PaymentMessageType":"MT100-Others"
}
]
},
{
"BankCode": "RIYADH",
"MessageType": "SINGLEREQ",
"Transactions": [
{
"CompanyCode": "FIFC001",
"SequenceNum": "88371630061",
"TransactionReferenceNumber": "5410077",
"B2BUserId": "",
"BulkToSingle": true
}
]
}
]
}
},
"Signature": "Enter_Signature_String"
}
Request description
| JSON Tag | Description | Data type |
|---|---|---|
| Message Mandatory | Header information (client credentials) | Object & Strings |
| OSVPaymentenquiryRequest Mandatory | Root node containing all the payment enquiry messages | Object |
| OSVPaymentStatusRequest Mandatory | This tag contains multiple banks payment requests | Object |
| BankCode Mandatory | Unique bank identification code Ex: ALRAJHI, SABB, BSF, ANB, NCB, ALINMA, GIB, RIYADH, ALBI, BJAZ, ICICI, HDFC | Alphabet |
| Transactions Mandatory | Tag containing the payment status details | Array |
| CompanyCode Mandatory | Sender company code or identifier provided by the bank at the time of on-boarding | Alphanumeric |
| SequenceNum Mandatory | Unique sequence number of each transaction Length of input: 16 characters | String |
| TransactionReferenceNumber Mandatory | Unique reference number representing the transactions Maximum length: 16 characters | String |
| Signature Mandatory | Encrypted string obtained by processing request body with Private Key/Certificate through SHA-256 with RSA Algorithm (Crypto : JCE Sign) | String |
Sample Responses
{
"OSVPaymentEnquiryResponse": [
{
"BankCode": "ALRAJHI",
"MessageType": "SINGLEREQ",
"OSVPaymentStatusResponse": [
{
"CompanyCode": "125001291",
"SequenceNum": "79878097",
"StatusCode": "SUCCESS",
"StatusDesc": "ReceiptReconSuccess-Transport Receipt Recon is successful",
"TransactionReferenceNumber": "797688999",
"FTReferenceNumber": "",
"BankReferenceNumber": "",
"TransactionType": "",
"DebitAccountNo": "",
"AccountName1": "",
"DebitCurrency": "",
"DebitTheirRef": "",
"CreditTheirRef": "",
"CreditAccountNo": "",
"AccountName2": "",
"CreditCurrency": "",
"CreditAmount": "",
"AmountDebited": "",
"CustomerRate": "",
"AmountCredited": "",
"BenCustomer1": "",
"DebitValueDate": "",
"CreditValueDate": "",
"PaymentDetails1": "",
"PaymentDetails2": "",
"UniqueId": "",
"UtrNumber": ""
}
]
},
{
"CompanyCode": "FIFC001",
"SequenceNum": "88371630061",
"StatusCode": "SUCCESS",
"StatusDesc": "ReceiptReconSuccess-Transport Receipt Recon is successful",
"TransactionReferenceNumber": "5410077",
"FTReferenceNumber": "",
"BankReferenceNumber": "",
"TransactionType": "",
"DebitAccountNo": "",
"AccountName1": "",
"DebitCurrency": "",
"DebitTheirRef": "",
"CreditTheirRef": "",
"CreditAccountNo": "",
"AccountName2": "",
"CreditCurrency": "",
"CreditAmount": "",
"AmountDebited": "",
"CustomerRate": "",
"AmountCredited": "",
"BenCustomer1": "",
"DebitValueDate": "",
"CreditValueDate": "",
"PaymentDetails1": "",
"PaymentDetails2": "",
"UniqueId": "",
"UtrNumber": ""
}
]
}
{
"OSVPaymentEnquiryResponse": [
{
"BankCode": "ALRAJHI",
"MessageType": "SINGLEREQ",
"OSVPaymentStatusResponse": [
{
"CompanyCode": "125001291",
"SequenceNum": "77858797",
"StatusCode": "PENDING",
"StatusDesc": "Your Payment file has been accepted, Kindly attempt to do a Payment Inquiry in a few minutes to know the Final status.",
"TransactionReferenceNumber": "797647499",
"FTReferenceNumber": "",
"BankReferenceNumber": "",
"TransactionType": "",
"DebitAccountNo": "",
"AccountName1": "",
"DebitCurrency": "",
"DebitTheirRef": "",
"CreditTheirRef": "",
"CreditAccountNo": "",
"AccountName2": "",
"CreditCurrency": "",
"CreditAmount": "",
"AmountDebited": "",
"CustomerRate": "",
"AmountCredited": "",
"BenCustomer1": "",
"DebitValueDate": "",
"CreditValueDate": "",
"PaymentDetails1": "",
"PaymentDetails2": "",
"UniqueId": "",
"UtrNumber": ""
}
]
},
{
"CompanyCode": "FIFC001",
"SequenceNum": "88371630061",
"StatusCode": "PENDING",
"StatusDesc": "Your Payment file has been accepted, Kindly attempt to do a Payment Inquiry in a few minutes to know the Final status.",
"TransactionReferenceNumber": "5410077",
"FTReferenceNumber": "",
"BankReferenceNumber": "",
"TransactionType": "",
"DebitAccountNo": "",
"AccountName1": "",
"DebitCurrency": "",
"DebitTheirRef": "",
"CreditTheirRef": "",
"CreditAccountNo": "",
"AccountName2": "",
"CreditCurrency": "",
"CreditAmount": "",
"AmountDebited": "",
"CustomerRate": "",
"AmountCredited": "",
"BenCustomer1": "",
"DebitValueDate": "",
"CreditValueDate": "",
"PaymentDetails1": "",
"PaymentDetails2": "",
"UniqueId": "",
"UtrNumber": ""
}
]
}
{
"OSVPaymentEnquiryResponse": [
{
"BankCode": "ALRAJHI",
"MessageType": "SINGLEREQ",
"OSVPaymentStatusResponse": [
{
"CompanyCode": "125001291",
"SequenceNum": "79878097",
"StatusCode": "FAILED",
"StatusDesc": "No Transaction found in the Requested Reference No.",
"TransactionReferenceNumber": "79768899",
"FTReferenceNumber": "",
"BankReferenceNumber": "",
"TransactionType": "",
"DebitAccountNo": "",
"AccountName1": "",
"DebitCurrency": "",
"DebitTheirRef": "",
"CreditTheirRef": "",
"CreditAccountNo": "",
"AccountName2": "",
"CreditCurrency": "",
"CreditAmount": "",
"AmountDebited": "",
"CustomerRate": "",
"AmountCredited": "",
"BenCustomer1": "",
"DebitValueDate": "",
"CreditValueDate": "",
"PaymentDetails1": "",
"PaymentDetails2": "",
"UniqueId": "",
"UtrNumber": ""
}
]
},
{
"CompanyCode": "FIFC001",
"SequenceNum": "88371630061",
"StatusCode": "FAILED",
"StatusDesc": "No Transaction found in the Requested Reference No.",
"TransactionReferenceNumber": "5410077",
"FTReferenceNumber": "",
"BankReferenceNumber": "",
"TransactionType": "",
"DebitAccountNo": "",
"AccountName1": "",
"DebitCurrency": "",
"DebitTheirRef": "",
"CreditTheirRef": "",
"CreditAccountNo": "",
"AccountName2": "",
"CreditCurrency": "",
"CreditAmount": "",
"AmountDebited": "",
"CustomerRate": "",
"AmountCredited": "",
"BenCustomer1": "",
"DebitValueDate": "",
"CreditValueDate": "",
"PaymentDetails1": "",
"PaymentDetails2": "",
"UniqueId": "",
"UtrNumber": ""
}
]
}
Responses description
| JSON Tag | Description | Data type |
|---|---|---|
| OSVPaymentEnquiryResponse | Root node | Object |
| OSVPaymentStatusResponse | Element root containing response of every bank transaction | Object |
| BankCode | Unique bank identification code Ex: ALRAJHI, SABB, BSF, ANB, NCB, ALINMA, GIB, RIYADH, ALBI, BJAZ, ICICI, HDFC | String |
| TransactionStatus | This tag contains the status of the payments | String |
| CompanyCode | Sender company Code/Identifier | String |
| SequenceNum | Unique sequence number of the payment transaction | String |
| TransactionReferenceNumber | Unique reference number representing the transactions | String |
| FTReferenceNumber | File Reference Number | String |
| BankReferenceNumber | Bank Reference Number | String |
| TransactionType | Transaction Type | String |
| DebitAccountNo | Debit Account Number | String |
| AccountName1 | Account Name 1 | String |
| DebitCurrency | Debit Currency | String |
| DebitTheirRef | Debit Their Reference | String |
| CreditTheirRef | Credit Their Reference | String |
| CreditAccountNo | Credit Account Number | String |
| AccountName2 | Account Name 2 | String |
| CreditCurrency | Credit Currency | String |
| CreditAmount | Credit Amount | String |
| AmountDebited | Amount Debited | String |
| CustomerRate | Customer Rate | String |
| AmountCredited | Amount Credited | String |
| BenCustomer1 | Beneficiary Customer 1 | String |
| DebitValueDate | Debit Value Date | String |
| CreditValueDate | Credit Value Date | String |
| PaymentDetails1 | Payment Details 1 | String |
| PaymentDetails2 | Payment Details 2 | String |
| StatusCode | Status code of the response SUCCESS- For successfully settled payment PENDING- For a pending payment FAILED- For a payment failed processing | String |
| StatusDesc | Status description of the response | String |
Updated 2 days ago