Bulk payment enquiry

SingleView Bulk 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)

Domain details
Environment
Domain
Rate/Limit
Sandbox
sandboxapi.onesingleview.com
3 Calls per Minute
Production/LIVE
To be provided upon onboarding
Based on contract

Environment	Domain	Rate/Limit
Sandbox	sandboxapi.onesingleview.com	3 Calls per Minute
Production/LIVE	To be provided upon onboarding	Based on contract

Get Bulk Payment Enquiry

Endpoint details

Endpoint URL	Method	Authentication requirements
`/v2/bulk/payment/enquiry`	POST	`SVReferenceID` `CompanyId` `Device` `DateTimeStamp` `Authorization: Bearer`

Sample request

curl --location 'https://sandboxapi.onesingleview.com/api/v2/bulk/payment/enquiry' \
--header 'SVReferenceID:  SV123456' \
--header 'CompanyId: SINGLEVIEW1234' \
--header 'Device: web' \
--header 'DateTimeStamp: 2025-07-22T10:20:39' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNaVN4MzdCZHREWlNGdTFad3B5QnlkOVpHelZXR2ZwUmFQNUYrZzB5YVg5bi9KVE5wK1FucERJMEZXWWN6VGJsOEc5cXhaUkVxQTJhSE1uWVBZMjQ0ckNXNkN2YUxvVTQxVGNNTzlwSDlUNCIsImlhdCI6MTc1MzE1OTMyNCwiZXhwIjoxNzUzMTYyOTI0fQ.gyBvuywn7ywvSKSaRYwaKRMma7OArPWHP-Ojo6BnJhA' \
--header 'Content-Type: application/json' \
--data '{
"Message": {
  "OSVPaymentMessageRequest": {
    "OSVPaymentStatusRequest": [
      {
        "BankCode": "ALRAJHI",
        "MessageType": "BPE",
        "ReferenceNumber": "41870234567",
        "CompanyCode": "SV12345",
        "Transactions": [		
        ]
      }
    ]
  }
},
"Signature": "Aaa6MBzIjDnktv7Q8beyUkcjA05jnlHdegG5WLkz6amwsglvS1NkYAvn2fbM8EGkzN2fYeirUDoPXABNaF4en9HkW1Ap5RhN/UdAggO+C6Ovy03apxyEomsEReU6eG0fJG80CUNfgEadVqvfXLmF9MfA2OpHPCTrX3kJlSOvP4iiVM6htEtmq1/wThr9Z9GYMmuhC99S4HMo4xxOCrsdYun9vpFFuAOJHd7f35/4SDhvF3j5cbBVqbKvpZC32f3LdgJUYSYImvtGsnJBqNRL10LohAzjuQUTAr9RxIrcIC+SLQs9qM65Am54K3oEyrEYzpgkKY2GMoIN7s6x/4FuHA=="
}'

Request parameters

JSON Tag	Requirement	Description	Data type
OSVPaymentMessageRequest	Mandatory	Root node containing all the payment enquiry message	Object
OSVPaymentStatusRequest	Mandatory	Tag carrying information on the payment enquiry request	Object/Array
BankCode	Mandatory	Unique bank identification code `ALRAJHI` - Al Rajhi Bank `SABB` - Saudi Awaal Bank `BSF` - Banque Saudi Fransi `ALINMA` - Arab National Bank `ANB` - Arab National Bank `NCB` - Saudi National Bank `RIYADH` - Riyadh Bank `GIB` - Gulf International Bank `BJAZ` - Bank Al Jazira `ALBI` - Bank Al Bilad	String
MessageType	Mandatory	Details on the type of message request to be mentioned as `BPE`	String
ReferenceNumber	Mandatory	Unique tracking identification number of the payment request	String
CompanyCode	Mandatory	Sender company code or identifier provided by the bank at the time of on-boarding	Alphanumeric
Transactions	Mandatory	Tag carrying information of transactions to be requested for payment enquiry	Object/Array
SequenceNum	Conditional Mandatory for SAB & BSF	List of sequence numbers existing in the payment request for individual transaction tracking Length of input: 16 characters	String
Signature	Mandatory	Encrypted string generated using a Private Key/CA-Signed Certificate with SHA-256 and RSA (JCE Signature)	String

Sample response

Bulk Payment Enquiry Response

{
  "OSVPaymentEnquiryResponse": [
    {
      "BankCode": "ALRAJHI",
      "ReferenceNumber": "41870235067",
      "CompanyCode": "SV12345",
      "Status": "Completed",
      "StatusMessage": "File processing completed successfully.",
      "OSVPaymentStatusResponse": [
        {
          "SequenceNum": "123456789",
          "StatusCode": "Completed",
          "StatusDetail": "Processed successfully",
          "BankReferenceNumber":"B260108143421114"
        },
        {
          "SequenceNum": "123456788",
          "StatusCode": "Completed",
          "StatusDetail": "Processed successfully",
          "BankReferenceNumber":"B260108143421115"
        }
      ]
    }
  ]
}

Responses parameters

JSON Tag	Description	Data type
OSVPaymentEnquiryResponse	Tag carrying information on payment enquiry response	Object
BankCode	Unique bank identification code `ALRAJHI` - Al Rajhi Bank `SABB` - Saudi Awaal Bank `BSF` - Banque Saudi Fransi `ALINMA` - Arab National Bank `ANB` - Arab National Bank `NCB` - Saudi National Bank `RIYADH` - Riyadh Bank `GIB` - Gulf International Bank `BJAZ` - Bank Al Jazira `ALBI` - Bank Al Bilad	String
ReferenceNumber	Unique tracking identification number of the payment request	String
CompanyCode	Sender company Code/Identifier	Alphanumeric
Status	Unique code displaying the current status of the payment request	String
StatusMessage	Description of the status code to convey information about the payment request	String
OSVPaymentStatusResponse	This tag contains the status of the transactions included in the payment request	Object/Array
SequenceNum	Unique number representing each transaction generated by the client	String
StatusCode	Code representing status of the individual transaction in the request	String
StatusDetail	Details of the status code represented for individual transaction the request	String
BankReferenceNumber	Unique transaction reference number provided by the bank Available only for ANB, SNB, SAB, Alinma For Al Rajhi Bank, tag appears based on client agreement	String

Status Codes & Information

File status

Status	StatusMessage
Processing	File is being processed
Completed	File processing completed successfully
Failed	Bulk payment failed. Transactions are rejected.
Partially_Completed	Bulk payment request is partial success. Check individual transactions for more details.
Response_Timeout	Unable to get response from the bank. Please contact SingleView support.

Transaction status

StatusCode	StatusDetail
Processing	Bank response description
Completed	Bank response description
Failed	Bank response description

Categories

GENERAL INFORMATION

GETTING STARTED

AUTHENTICATION

Data APIs

Payment APIs

SADAD

RESOURCES

API Archives