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 informationThis 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 requiredThere 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
Environment Domain Rate/Limit Sandbox sandboxapi.onesingleview.com 10 Calls per Minute Production/LIVE To be provided upon onboarding Based on contract
Post-payment Enquiry
Endpoint details
Endpoint URL | Method | Authentication requirements |
---|---|---|
| POST | 1. |
Synchronous Method
Sample request
curl --location 'https://sandboxapi.onesingleview.com/api/v1/payment/enquiry' \
--header 'CompanyId: MYCOMPANY'
--header 'SVReferenceID: SV150619940615'
--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": {
"OSVPaymentStatusRequest": [
{
"Transactions": [
{
"BulkToSingle": true,
"CompanyCode": "SingleView",
"TransactionReferenceNumber": "977777364313151",
"SequenceNum": "977777285422521"
},
{
"BulkToSingle": true,
"CompanyCode": "SingleView",
"TransactionReferenceNumber": "977777364313151",
"SequenceNum": "977777222462551"
}
],
"BankCode": "ANB",
"MessageType": "SINGLEREQ"
}
]
}
},
"Signature": "MMRrtws4rKuJASNxYL+MAzEZp1B1XpuBXjd/tjNoOl3N4JLhZ+2dVQ9Xxyxx3WsfGr4T786jhhLEFdqu4oQXEeedd/8u0n3rSuKahBTWeHLiMksU5Wx/0jCp8WlwzmrPyDObwt3ecqzEYEkG9SfFEEwlqbMKli+EVzQmKm8nGFvkXnY1aSWZTsfp628XE0zrOQsHA3//8xjKN2PXsetAZuUCmef7b0Xi219sNTvIi2eByY/i7zyF9UHHMkzeSlsE6gr6DDQrs/k+wJl+3w7+IZQ7vPweuAON8qVOSl75Q0Vvr+7PXS+drYmWGLa2iJ44t9ErCL70vnuzfqCv0Q5NCA=="
}'
Request description
JSON Tag | Description | Data type |
---|---|---|
OSVPaymentMessageRequest Mandatory | Root node containing all the payment enquiry message | Object |
OSVPaymentStatusRequest | Tag carrying information on the payment enquiry request | Object |
BankCode | Unique bank identification code | String |
MessageType | Details on the type of message request to be mentioned as | String |
Transactions | Tag carrying information of transactions to be requested for payment enquiry | Object |
BulkToSingle | Boolean indication of payment type (Bulk/Single) | Boolean (True/False) |
CompanyCode | Sender company code or identifier provided by the bank at the time of on-boarding | Alphanumeric |
TransactionReferenceNumber | Transaction reference number | String |
SequenceNum | Sequence number of the transaction | String |
Signature | Encrypted string generated using a Private Key/CA-Signed Certificate with SHA-256 and RSA (JCE Signature) | String |
Sample Responses
{
"OSVPaymentEnquiryResponse": [
{
"BankCode": "ANB",
"MessageType": "SINGLEREQ",
"OSVPaymentStatusResponse": [
{
"CompanyCode": "SingleView",
"SequenceNum": "977777285422521",
"StatusCode": "SUCCESS",
"StatusDesc": "Transaction successful",
"TransactionReferenceNumber": "977777222462551",
"FTReferenceNumber": "",
"BankReferenceNumber": "9f417032-d9a0-4a7a-aaeb-4fbc6291ae94",
"TransactionType": ""
},
{
"CompanyCode": "SingleView",
"SequenceNum": "977777222462551",
"StatusCode": "SUCCESS",
"StatusDesc": "Transaction successful",
"TransactionReferenceNumber": "977777222462551",
"FTReferenceNumber": "",
"BankReferenceNumber": "fc1e02e9-5890-462e-a6e3-c9fed388d4aa",
"TransactionType": ""
}
]
}
]
}
{
"OSVPaymentEnquiryResponse": [
{
"BankCode": "ANB",
"MessageType": "SINGLEREQ",
"OSVPaymentStatusResponse": [
{
"CompanyCode": "SingleView",
"SequenceNum": "977777285422521",
"StatusCode": "PENDING",
"StatusDesc": "Transaction successfully executed and is kept on hold by bank",
"TransactionReferenceNumber": "977777222462551",
"FTReferenceNumber": "",
"BankReferenceNumber": "",
"TransactionType": "",
"DebitAccountNo": "",
"AccountName1": "",
"DebitCurrency": "",
"DebitTheirRef": "",
"CreditTheirRef": "",
"CreditAccountNo": "",
"CreditCurrency": "",
"CreditAmount": "",
"AmountDebited": "",
"CustomerRate": "",
"AmountCredited": "",
"DebitValueDate": "",
"CreditValueDate": "",
"UTIReference": ""
},
{
"CompanyCode": "SingleView",
"SequenceNum": "977777222462551",
"StatusCode": "PENDING",
"StatusDesc": "Transaction successfully executed and is kept on hold by bank",
"TransactionReferenceNumber": "977777222462551",
"FTReferenceNumber": "",
"BankReferenceNumber": "",
"TransactionType": "",
"DebitAccountNo": "",
"AccountName1": "",
"DebitCurrency": "",
"DebitTheirRef": "",
"CreditTheirRef": "",
"CreditAccountNo": "",
"CreditCurrency": "",
"CreditAmount": "",
"AmountDebited": "",
"CustomerRate": "",
"AmountCredited": "",
"DebitValueDate": "",
"CreditValueDate": "",
"UTIReference": ""
}
]
}
]
}
{
"OSVPaymentEnquiryResponse": [
{
"BankCode": "ANB",
"MessageType": "SINGLEREQ",
"OSVPaymentStatusResponse": [
{
"CompanyCode": "SingleView",
"SequenceNum": "977777285422521",
"StatusCode": "FAILED",
"StatusDesc": "Transaction failed at the bank",
"TransactionReferenceNumber": "977777222462551",
"FTReferenceNumber": "",
"BankReferenceNumber": "",
"TransactionType": "",
"DebitAccountNo": "",
"AccountName1": "",
"DebitCurrency": "",
"DebitTheirRef": "",
"CreditTheirRef": "",
"CreditAccountNo": "",
"CreditCurrency": "",
"CreditAmount": "",
"AmountDebited": "",
"CustomerRate": "",
"AmountCredited": "",
"DebitValueDate": "",
"CreditValueDate": "",
"UTIReference": ""
},
{
"CompanyCode": "SingleView",
"SequenceNum": "977777222462551",
"StatusCode": "FAILED",
"StatusDesc": "Transaction failed at the bank",
"TransactionReferenceNumber": "977777222462551",
"FTReferenceNumber": "",
"BankReferenceNumber": "",
"TransactionType": "",
"DebitAccountNo": "",
"AccountName1": "",
"DebitCurrency": "",
"DebitTheirRef": "",
"CreditTheirRef": "",
"CreditAccountNo": "",
"CreditCurrency": "",
"CreditAmount": "",
"AmountDebited": "",
"CustomerRate": "",
"AmountCredited": "",
"DebitValueDate": "",
"CreditValueDate": "",
"UTIReference": ""
}
]
}
]
}
Responses description
JSON Tag | Description | Data type |
---|---|---|
OSVPaymentEnquiryResponse | Root node | Object |
MessageType | Type of message response indicated as | 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
| 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 used for the transaction | String |
DebitCurrency | Debit Currency shown as | String |
DebitTheirRef | Debit Reference Number (same as Transaction Reference) | String |
CreditTheirRef | Bank Reference number generated when this payment processed by Bank financial system | String |
CreditAccountNo | Credit Account number or IBAN number | String |
CreditCurrency | Credit Currency shown as | String |
CreditAmount | Credit Amount | String |
AmountDebited | Amount Debited | String |
CustomerRate | Customer Rate | String |
AmountCredited | Amount Credited | String |
DebitValueDate | Debit Value Date | String |
CreditValueDate | Credit Value Date | String |
UTIReference | Unique reference number | String |
Asynchronous Method
Sample Responses
{
"OSVPaymentEnquiryResponse": [
{
"BankCode": "ANB",
"MessageType": "SINGLEREQ",
"OSVPaymentStatusResponse": [
{
"CompanyCode": "SingleView",
"SequenceNum": "977777285422521",
"StatusCode": "SUCCESS",
"StatusDesc": "Transaction successful",
"TransactionReferenceNumber": "977777222462551",
"FTReferenceNumber": "",
"BankReferenceNumber": "fc1e02e9-5890-462e-a6e3-c9fed388d4aa",
"TransactionType": "",
},
{
"CompanyCode": "SingleView",
"SequenceNum": "977777222462551",
"StatusCode": "SUCCESS",
"StatusDesc": "Transaction successful",
"TransactionReferenceNumber": "977777222462551",
"FTReferenceNumber": "",
"BankReferenceNumber": "9f417032-d9a0-4a7a-aaeb-4fbc6291ae94",
"TransactionType": "",
}
]
}
]
}
{
"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": "",
"CreditCurrency": "",
"CreditAmount": "",
"AmountDebited": "",
"CustomerRate": "",
"AmountCredited": "",
"DebitValueDate": "",
"CreditValueDate": "",
"UTIReference": ""
}
]
},
{
"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 |
MessageType | Type of message response indicated as | 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
| 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 used for the transaction | String |
DebitCurrency | Debit Currency shown as | String |
DebitTheirRef | Debit Reference Number (same as Transaction Reference) | String |
CreditTheirRef | Bank Reference number generated when this payment processed by Bank financial system | String |
CreditAccountNo | Credit Account number or IBAN number | String |
CreditCurrency | Credit Currency shown as | String |
CreditAmount | Credit Amount | String |
AmountDebited | Amount Debited | String |
CustomerRate | Customer Rate | String |
AmountCredited | Amount Credited | String |
DebitValueDate | Debit Value Date | String |
CreditValueDate | Credit Value Date | String |
UTIReference | Unique reference number | String |
Updated 3 days ago