Introduction

With Singleview Post-Payment Enquiry services connects the Corporate users via a secure channel and enables them to enquire the status of their posted 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 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 B2B system for the following banks:

Al Rajhi Bank
ANB Bank
SABB Bank

❗️
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

BSF Bank

NCB Bank

Riyadh Bank

🌐Domain details

Sandbox API - https://sandboxapi.onesingleview.com

Production/LIVE API - To be provided upon onboarding

End-point details

Endpoint	HTTP Operation	Grant Type	Service Validation
`/api/v1/batch/paymentenquiry`	POST	The header should include: 1. `clientId` 2. `clientCode` 3. `Access Token` 4. `SVReferenceID` 5. `CompanyId`	- Signature verification - IPs Whitelisting - Token Validation - Valid/Active B2B company code

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":
  {
	"OSVPaymentenquiryRequest": {
		"OSVPaymentStatusRequest": [
      {
				"BankCode": "Enter_Bank_Code",
				"Transactions": [
					{
						"CompanyCode": "Enter_Company_Code",
						"SequenceNum": "Enter_Sequence_Number",
						"TransactionReferenceNumber": "Enter_Transaction_Reference_Number"
					}
				]
			},
			{
				"BankCode": "Enter_Bank_Code",
				"Transactions": [
          {
					"CompanyCode": "Enter_Company_Code",
					"SequenceNum": "Enter_Sequence_Number",
					"TransactionReferenceNumber": "Enter_Transaction_Reference_Number"

				}
        ]
			}
		]
	}
},
  "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	Code of the bank. Ex: “ALRAJHI”, “SABB”	String
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	String
SequenceNum Mandatory	Unique number representing each transaction	String
TransactionReferenceNumber Mandatory	Unique number representing the transactions	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": {
		"OSVPaymentStatusResponse": [
      {
				"BankCode": "Bank_Code",
				"TransactionStatus": [
          {
					"CompanyCode": "Company_Code",
					"SequenceNum": "Sequence_Number",
					"TransactionReferenceNumber": "Transaction_Reference_Number",
					"FTReferenceNumber": "FT_Reference_Number",
					"BankReferenceNumber": "Bank_Reference_Number",
					"TransactionType": "Transaction_Type",
					"DebitAccountNo": "Debit_Account_Number",
					"AccountName1": "Account_Name_1",
					"DebitCurrency": "SAR",
					"DebitTheirRef": "Debit_Their_Ref",
					"CreditTheirRef": "Credit_Their_Ref",
					"CreditAccountNo": "Credit_Account_Number",
					"AccountName2": "Account_Name_2",
					"CreditCurrency": "SAR",
					"CreditAmount": "Credit_Amount",
					"AmountDebited": "Debit_Amount",
					"CustomerRate": "Customer_Rate",
					"AmountCredited": "Amount_Credited",
					"BenCustomer1": "Beneficiary_Customer_1",
					"DebitValueDate": "YYYY-MM-DD",
					"CreditValueDate": "YYYY-MM-DD",
					"PaymentDetails1": "Payment details",
					"PaymentDetails2": "payment details",
					"StatusCode": "SUCCESS",
					"StatusDesc": "Payment Posted Successfully"
				}
       ]
			},
			{
				"BankCode": "Bank_Code",
				"TransactionStatus": [
          {
					"CompanyCode": "Company_Code",
					"SequenceNum": "Sequence_Number",
					"TransactionReferenceNumber": "Transaction_Reference_Number",
					"FTReferenceNumber": "FT_Reference_Number",
					"BankReferenceNumber": "Bank_Reference_Number",
					"TransactionType": "Transaction_Type",
					"DebitAccountNo": "Debit_Account_Number",
					"AccountName1": "Account_Name_1",
					"DebitCurrency": "SAR",
					"DebitTheirRef": "Debit_Their_Ref",
					"CreditTheirRef": "Credit_Their_Ref",
					"CreditAccountNo": "Credit_Account_Number",
					"AccountName2": "Account_Name_2",
					"CreditCurrency": "SAR",
					"CreditAmount": "Credit_Amount",
					"AmountDebited": "Debit_Amount",
					"CustomerRate": "Customer_Rate",
					"AmountCredited": "Amount_Credited",
					"BenCustomer1": "Beneficiary_Customer_1",
					"DebitValueDate": "YYYY-MM-DD",
					"CreditValueDate": "YYYY-MM-DD",
					"PaymentDetails1": "Payment details",
					"PaymentDetails2": "payment details",
					"StatusCode": "SUCCESS",
					"StatusDesc": "Payment Posted Successfully"
				}
       ]
			}
		]
	}
}

{
	"OSVPaymentEnquiryResponse": {
		"OSVPaymentStatusResponse": [
      {
				"BankCode": "Bank_Code",
				"TransactionStatus": [
          {
					"CompanyCode": "Company_Code",
					"SequenceNum": "Sequence_Number",
					"TransactionReferenceNumber": "Transaction_Reference_Number",
					"FTReferenceNumber": "FT_Reference_Number",
					"BankReferenceNumber": "Bank_Reference_Number",
					"TransactionType": "Transaction_Type",
					"DebitAccountNo": "Debit_Account_Number",
					"AccountName1": "Account_Name_1",
					"DebitCurrency": "SAR",
					"DebitTheirRef": "Debit_Their_Ref",
					"CreditTheirRef": "Credit_Their_Ref",
					"CreditAccountNo": "Credit_Account_Number",
					"AccountName2": "Account_Name_2",
					"CreditCurrency": "SAR",
					"CreditAmount": "Credit_Amount",
					"AmountDebited": "Debit_Amount",
					"CustomerRate": "Customer_Rate",
					"AmountCredited": "Amount_Credited",
					"BenCustomer1": "Beneficiary_Customer_1",
					"DebitValueDate": "YYYY-MM-DD",
					"CreditValueDate": "YYYY-MM-DD",
					"PaymentDetails1": "Payment details",
					"PaymentDetails2": "payment details",
					"StatusCode": "PENDING",
					"StatusDesc": "Received and Under process (PAQ - OT)"
				}
       ]
			},
			{
				"BankCode": "Bank_Code",
				"TransactionStatus": [
          {
					"CompanyCode": "Company_Code",
					"SequenceNum": "Sequence_Number",
					"TransactionReferenceNumber": "Transaction_Reference_Number",
					"FTReferenceNumber": "FT_Reference_Number",
					"BankReferenceNumber": "Bank_Reference_Number",
					"TransactionType": "Transaction_Type",
					"DebitAccountNo": "Debit_Account_Number",
					"AccountName1": "Account_Name_1",
					"DebitCurrency": "SAR",
					"DebitTheirRef": "Debit_Their_Ref",
					"CreditTheirRef": "Credit_Their_Ref",
					"CreditAccountNo": "Credit_Account_Number",
					"AccountName2": "Account_Name_2",
					"CreditCurrency": "SAR",
					"CreditAmount": "Credit_Amount",
					"AmountDebited": "Debit_Amount",
					"CustomerRate": "Customer_Rate",
					"AmountCredited": "Amount_Credited",
					"BenCustomer1": "Beneficiary_Customer_1",
					"DebitValueDate": "YYYY-MM-DD",
					"CreditValueDate": "YYYY-MM-DD",
					"PaymentDetails1": "Payment details",
					"PaymentDetails2": "payment details",
					"StatusCode": "PENDING",
					"StatusDesc": "Received and Under process (PAQ - OT)"
				}
       ]
			}
		]
	}
}

{
	"OSVPaymentEnquiryResponse": {
		"OSVPaymentStatusResponse": [
      {
				"BankCode": "Bank_Code",
				"TransactionStatus": [
          {
					"CompanyCode": "Company_Code",
					"SequenceNum": "Sequence_Number",
					"TransactionReferenceNumber": "Transaction_Reference_Number",
					"FTReferenceNumber": "FT_Reference_Number",
					"BankReferenceNumber": "Bank_Reference_Number",
					"TransactionType": "Transaction_Type",
					"DebitAccountNo": "Debit_Account_Number",
					"AccountName1": "Account_Name_1",
					"DebitCurrency": "SAR",
					"DebitTheirRef": "Debit_Their_Ref",
					"CreditTheirRef": "Credit_Their_Ref",
					"CreditAccountNo": "Credit_Account_Number",
					"AccountName2": "Account_Name_2",
					"CreditCurrency": "SAR",
					"CreditAmount": "Credit_Amount",
					"AmountDebited": "Debit_Amount",
					"CustomerRate": "Customer_Rate",
					"AmountCredited": "Amount_Credited",
					"BenCustomer1": "Beneficiary_Customer_1",
					"DebitValueDate": "YYYY-MM-DD",
					"CreditValueDate": "YYYY-MM-DD",
					"PaymentDetails1": "Payment details",
					"PaymentDetails2": "payment details",
					"StatusCode": "FAILED",
					"StatusDesc": "No transaction found for the requested reference number"
				}
       ]
			},
			{
				"BankCode": "Bank_Code",
				"TransactionStatus": [
          {
					"CompanyCode": "Company_Code",
					"SequenceNum": "Sequence_Number",
					"TransactionReferenceNumber": "Transaction_Reference_Number",
					"FTReferenceNumber": "FT_Reference_Number",
					"BankReferenceNumber": "Bank_Reference_Number",
					"TransactionType": "Transaction_Type",
					"DebitAccountNo": "Debit_Account_Number",
					"AccountName1": "Account_Name_1",
					"DebitCurrency": "SAR",
					"DebitTheirRef": "Debit_Their_Ref",
					"CreditTheirRef": "Credit_Their_Ref",
					"CreditAccountNo": "Credit_Account_Number",
					"AccountName2": "Account_Name_2",
					"CreditCurrency": "SAR",
					"CreditAmount": "Credit_Amount",
					"AmountDebited": "Debit_Amount",
					"CustomerRate": "Customer_Rate",
					"AmountCredited": "Amount_Credited",
					"BenCustomer1": "Beneficiary_Customer_1",
					"DebitValueDate": "YYYY-MM-DD",
					"CreditValueDate": "YYYY-MM-DD",
					"PaymentDetails1": "Payment details",
					"PaymentDetails2": "payment details",
					"StatusCode": "FAILED",
					"StatusDesc": "No transaction found for the requested reference number"
				}
       ]
			}
		]
	}
}

Responses description

JSON Tag	Description	Data type
OSVPaymentEnquiryResponse	Root node	Object
OSVPaymentStatusResponse	Element root containing response of every bank transaction	Object
BankCode	Name of the bank Ex: “ALRAJHI”, “SABB”	String
TransactionStatus	This tag contains the status of the payments	String
CompanyCode	Sender company Code/Identifier	String
SequenceNum	Value of “SequenceNum” tag in the request message	String
TransactionReferenceNumber	Unique 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