Single Payment Enquiry

Fetch updated status of the processed Payouts payments

SingleView Single Payment Enquiry V2.0 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)
❗️

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 (NCB)
  • Riyad Bank
  • Bank Al Jazira

🌐

Domain details

EnvironmentDomainRate/Limit
Sandboxsandboxapi.onesingleview.com10 Calls per Minute
Production/LIVETo be provided upon onboardingBased on contract

Perform a Single Payment Enquiry - V2.0

Endpoint details

Endpoint URL

Method

Authentication requirements

/api/v2/single/payment/enquiry

POST

  1. CompanyId
  2. SVReferenceID
  3. DateTimeStamp
  4. Device
  5. Authorization: Bearer (Token)

Sample request

curl --location 'https://sandboxapi.onesingleview.com/api/v2/single/payment/enquiry' \
--header 'SVReferenceID:  sv123456' \
--header 'CompanyId: SINGLEVIEW0001' \
--header 'Device: web' \
--header 'DateTimeStamp: 2025-08-04T10:20:39' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNaVN4MzdCZHREWlNGdTFad3B5QnlkOVpHelZXR2ZwUmFQNUYrZzB5YVg5bi9KVE5wK1FucERJMEZXWWN6VGJsOEc5cXhaUkZhSXphSEVuWmZnMTdZckV1SlFwRGQ2UTczd1Z0a3dFaCtFUSIsImlhdCI6MTc1NDMwOTEyMSwiZXhwIjoxNzU0MzEyNzIxfQ.bHTDX5yJChHXJCA6futcLGDdBW2ln0_szAJcGTVa7oY' \
--header 'Content-Type: application/json' \
--data '{
"Message": {
  "OSVPaymentMessageRequest": {
    "OSVPaymentStatusRequest": [
      {
        "BankCode": "ANB",
        "MessageType": "SINGLEREQ",
        "Transactions": [
          {
            "CompanyCode": "SV0001",
            "TransactionReferenceNumber": "913123456",
            "BankReferenceNumber": "e38d6ef9-13af-417c-b233-073cab4cd71f",
            "SequenceNum": "2112123"
          }
        ]
      }
    ]
  }
},
"Signature": "Z7iPynHNp1GKbTKLY5XiLLJytsEeywM+vRyu29/W83KWcXkesm4LKC/jSPk4DvAkHTGAwgOYwKz3x6HI90G5rL3pKP1LHo20rQZjQkCWgxv4H2Il2ogsLbGX2VNIZ0vU/mrg9lASEhj2x33CXiSI5MCxI37OnpJUVefAh4KZRFEWzthp7ojluopfAg0iFpagghLqw3z2Bcn+p/Hy7wux3eY9KFUL8TBxNgWKskzO/NZDd81Ym274Di67yMO8Z2QHbFcrNG4K5UfmWuUC2faF14TlyTHCZTADdbIHlgP6LQoVfIz/90spJ7kqOWZQiioqz3u/nFlmkY5/YQqpikFlfw=="
}'

Request description

JSON Tag

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

BankCode Mandatory

Unique bank identification code ALRAJHI - Al Rajhi Bank SABB - Saudi Awwaal Bank ANB - Arab National Bank NCB - Saudi National Bank GIB - Gulf International Bank

String

MessageType Mandatory

Details on the type of message request to be mentioned as SINGLEREQ

String

Transactions Mandatory

Tag carrying information of transactions to be requested for payment enquiry

Object

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

BankReferenceNumber Mandatory

Unique bank reference number Maximum length : 32 numeric characters

String

SequenceNum Conditional Mandatory for SAB

Unique number representing each transaction generated by the client Length of input: 16 characters

Numeric

Signature Mandatory

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",
      "TransactionReferenceNumber": "913123456",
      "OSVPaymentStatusResponse": [
        {
          "CompanyCode": "SV0001",
          "SequenceNum": "2112123",
          "StatusCode": "SUCCESS",
          "StatusDetail": "SUCCESS",
          "FTReferenceNumber": "SD9390261",
          "BankReferenceNumber": "e38d6ef9-13af-417c-b233-073cab4cd71f",
          "TransactionComment": "Regular service payment",
          "AckReference": "BT00231152"
        }
      ]
    }
  ]
}
{
  "OSVPaymentEnquiryResponse": [
    {
      "BankCode": "ANB",
      "MessageType": "SINGLEREQ",
      "TransactionReferenceNumber": "913123456",
      "OSVPaymentStatusResponse": [
        {
          "CompanyCode": "SV0001",
          "SequenceNum": "2112123",
          "StatusCode": "FAILED",
          "StatusDetail": "Failed to make the payment to issue at bank server."
        }
      ]
    }
  ]
}

Responses description

JSON Tag

Description

Data type

OSVPaymentEnquiryResponse

Root node

Object

BankCode

Unique bank identification code ALRAJHI - Al Rajhi Bank SABB - Saudi Awwaal Bank ANB - Arab National Bank NCB - Saudi National Bank GIB - Gulf International Bank

String

MessageType

Type of the response generally collected as BPE

Alphabetic

TransactionReferenceNumber

Unique reference number generated by the customer by the time of transaction)

String

OSVPaymentStatusResponse

Element root containing response of every bank transaction

Object

CompanyCode

Sender company Code/Identifier

Alphanumeric

SequenceNum

Sequence number of the transaction

Numerical

StatusCode

Status code of the response

  • SUCCESS- For successfully settled payment
  • PENDING- For a pending payment
  • FAILED- For a payment failed processing

String

StatusDetail

Status description of the response

String

FTReferenceNumber

Unique file reference number for the payment

String

BankReferenceNumber

Unique bank reference number for the transaction

String

TransactionComment

Comment describing the transaction details provided by the client/user

String

AckReference

Date of processing the transaction

Date