Multiple Payments
Disburse multiple payments through Payouts API
SingleView Payouts API allows multiple payment facilities through JSON requests and responses. The request in the specified format is posted to the concerned end-point. Based on the validity of the request, SingleView Payouts API processes the request and reflects a response accordingly. The authentication process involves additional identification parameters to ensure the best way to authorize the payment request.
Mandatory information
- The user must provide the valid credentials in the header
- Encrypted and valid Signature and an active "Access Token."
- Request format as specified with all the mandatory details with appropriate request tags
🌐Domain details
- Sandbox API - https://sandboxapi.onesingleview.com
- Production/LIVE API - To be provided upon onboarding
Make Multiple Payments Payout
Endpoint details
Endpoint URL | Method | Grant type |
---|---|---|
/api/v1/payment/fundtransfer | POST | 1/. clientid (Optional)2. clientsecret (Optional)3. SVReferenceID 4. Device 5. DateTimeStamp 6. CompanyId 7. Authroization: Bearer (Token)8. Signature |
/transferType | Query Parameter | 1. Same Bank : interbank 2. Local Bank: sarie 3. International : swift |
Sample Request
curl --location 'https://sandboxapi.onesingleview.com/api/payment/fundtransfer' \
--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": {
"TransactionType": "MT100",
"OSVPaymentTransactionRequest": [
{
"BankCode": "ALRAJHI",
"TransactionReferenceNumber": "797687499",
"TransactionDescription": "2222222",
"BulkToSingle": true,
"TransactionData": [
{
"CompanyCode": "125001291",
"SequenceNum": "77858297",
"B2BAggrId": "CUST0348",
"B2BName": "",
"B2BUserId": "",
"B2BCRN": "2020050501",
"B2BUrn": "",
"DateCurrencyAmount": {
"Date": "250116",
"Currency": "SAR",
"Amount": "12"
},
"OrderingCustomerNameAddress": {
"OrderingCustomerName": "Susanta Patra",
"OrderingCustomerAdd1": "Head Off P.O Box 66674",
"OrderingCustomerAdd2": " Riyadh",
"OrderingCustomerAdd3": "Saudi Arabia"
},
"OrderingInstitution": "RJHISARI",
"OrderingCustomerAccountNumber": "204000010006085129123",
"OrderingCustomerIBAN": "204000010006085129123",
"OrderingCurrency": "SAR",
"BeneficiaryAccountWithInstitutionBIC": "RJHIKWK0",
"BeneficiaryAccountNumberNameAddress": {
"BeneficiaryAccount": "SA8780071050000000015966",
"BeneficiaryName": "WITHIN NCB- ABDUL- RIYADH BANK",
"BeneficiaryADD1": "Trade Finance Center",
"BeneficiaryADD2": "Al Rabie Dist Riyadh Saudi Arabia",
"BeneficiaryADD3": "Riyadh Saudi Arabia"
},
"PurposeOfRemittance": "01",
"DetailsOfCharge": "SHA",
"AdditionalDetails": "",
"TransactionComment": "2222",
"TransferType": "sarie"
},
{
"BankCode": "ALRAJHI",
"TransactionReferenceNumber": "797687489",
"TransactionDescription": "2222222",
"BulkToSingle": true,
"TransactionData": [
{
"CompanyCode": "125001291",
"SequenceNum": "77858277",
"B2BAggrId": "CUST0348",
"B2BName": "",
"B2BUserId": "",
"B2BCRN": "2020050501",
"B2BUrn": "",
"DateCurrencyAmount": {
"Date": "250116",
"Currency": "SAR",
"Amount": "12"
},
"OrderingCustomerNameAddress": {
"OrderingCustomerName": "Susanta Patra",
"OrderingCustomerAdd1": "Head Off P.O Box 66674",
"OrderingCustomerAdd2": " Riyadh",
"OrderingCustomerAdd3": "Saudi Arabia"
},
"OrderingInstitution": "RJHISARI",
"OrderingCustomerAccountNumber": "SA8780071050000000015966",
"OrderingCustomerIBAN": "SA8780071050000000015966",
"OrderingCurrency": "SAR",
"BeneficiaryAccountWithInstitutionBIC": "RJHIKWK0",
"BeneficiaryAccountNumberNameAddress": {
"BeneficiaryAccount": "204000010006085129123",
"BeneficiaryName": "WITHIN NCB- ABDUL- RIYADH BANK",
"BeneficiaryADD1": "Trade Finance Center",
"BeneficiaryADD2": "Al Rabie Dist Riyadh Saudi Arabia",
"BeneficiaryADD3": "Riyadh Saudi Arabia"
},
"PurposeOfRemittance": "01",
"DetailsOfCharge": "SHA",
"AdditionalDetails": "",
"TransactionComment": "2222",
"TransferType": "sarie"
}
]
}
]
}
]
}
}
},
"Signature": "Enter_Signature_String"
}'
Request Description
JSON Tag | Description | Data type |
---|---|---|
Message Mandatory | Header information (client credentials) | Object |
OSVPaymentMessageRequest Mandatory | Root node containing all the payment transaction messages | Object |
TransactionType Mandatory | To be always mentioned as MT100 | Alphanumeric |
OSVPaymentTransactionRequest Mandatory | This tag contains multiple banks requests | Object |
BankCode Mandatory | Unique bank identification code Ex: ALRAJHI, SABB, BSF, ANB, NCB, ALINMA, GIB, RIYADH, ALBI, BJAZ, ICICI, HDFC | Alphabet |
TransactionReferenceNumber Mandatory | It is a unique reference number generated by the customer for each transaction Maximum length : 16 numeric characters | Numeric |
TransactionDescription Mandatory | Payment Description Maximum length : 35 characters | String |
BulkToSingle Optional | Boolean indication of payment type (Bulk/Single) | Boolean (True/False) |
TransactionData Mandatory | This tag contains the payment details | Object/Array |
CompanyCode Mandatory | Sender company code/Identifier provided by the bank | Alphanumeric |
SequenceNum Mandatory | Unique number representing each transaction Length of input: 16 characters | Numeric |
B2BAggrId Conditional | Unique B2B aggregator identification details. Mandatory only for ICICI Bank. | String |
B2BName Conditional | Unique B2B name. Mandatory only for ICICI Bank. | String |
B2BUserId Conditional | Unique B2B user identification details. Mandatory only for ICICI Bank. | String |
B2BUrn Conditional | Unique B2B URN. Mandatory only for ICICI Bank. | String |
B2BCRN Conditional | Unique Identity for Client Will be provided by Al Rajhi Bank. Mandatory only for Al Rajhi Bank. | String |
DateCurrencyAmount Mandatory | Element root containing details of Date, Currency and Amount | Object |
Date Mandatory | Value date Transactions will be performed on this date. Date must be expressed as YYMMDD Maximum length : 6 numeric characters | Date |
Currency Mandatory | This is the currency code used in the transaction. Length of input: 3 characters | Alphabetic |
Amount Mandatory | This is the amount used in the transaction. | Numeric |
OrderingCustomerNameAddress Mandatory | Element root containing details of Ordering customer | Object/Array |
OrderingCustomerName Mandatory | Ordering Customer’s Name Input size: Min - 3 Characters Max - 35 Characters | Alphabet |
OrderingCustomerAdd1 Mandatory | Ordering Customer’s Address Line 1 Input size: Min - 3 Characters Max - 35 Characters | String |
OrderingCustomerAdd2 Mandatory | Ordering Customer’s Address Line 2 ( city to be mentioned)Input size: Min - 3 Characters Max - 35 Characters | String |
OrderingCustomerAdd3 Mandatory | Ordering Customer’s Address Line 3 Input size: Min - 3 Characters Max - 35 Characters | String |
OrderingInstitution Mandatory | Ordering Institution Ex: SABBSARI, RJHISARI Maximum length: 8 or 11 characters | Alphanumeric |
OrderingCustomerAccountNumber Mandatory | Ordering Customer’s account number (Any one is mandate Account Number or IBAN Number) Input size: Min - 11 Characters Max - 24 Characters | Alphanumeric |
OrderingCustomerIBAN Mandatory | Ordering Customer’s IBAN number (Any one is mandate Account Number or IBAN Number) | Alphanumeric |
OrderingCurrency Mandatory | This is the currency code used in the transaction. Maximum length : 3 digit currency code | Alphabet |
BeneficiaryAccountWithInstitutionBIC Mandatory | Beneficiary BIC Code Ex: SABBSARI, RJHISARI Maximum length: 8 or 11 characters | Alphanumeric |
BeneficiaryAccountNumberNameAddress Mandatory | Element root containing details of Beneficiary | Object/Array |
BeneficiaryAccount Mandatory | Beneficiary Customer’s account number Input size: Min - 11 Characters Max - 24 Characters | String |
BeneficiaryName Mandatory | Beneficiary Name Input size: Min - 3 Characters Max - 35 Characters | Alphabet |
BeneficiaryADD1 Mandatory | Beneficiary Address Line 1 Input size: Min - 3 Characters Max - 35 Characters | String |
BeneficiaryADD2 Mandatory | Beneficiary Address Line 2 ( city to be mentioned)Input size: Min - 3 Characters Max - 35 Characters | String |
BeneficiaryADD3 Mandatory | Beneficiary Address Line 3 Input size: Min - 3 Characters Max - 35 Characters | String |
PurposeOfRemittance Mandatory | Code representing the purpose of remittance | Numeric |
DetailsOfCharge Mandatory | To be mentioned as SHA | Alphabet |
AdditionalDetails Mandatory | Additional details Max size of input: 35 Characters | String |
TransactionComment Mandatory | Additional comments for the payments Max size of input: 35 Characters | String |
TransferType Mandatory | Same Bank : interbank, Local Bank: sarie, International : swift | Alphabet |
Signature Mandatory | Encrypted string generated using a Private Key/CA-Signed Certificate with SHA-256 and RSA (JCE Signature) | String |
Sample responses
✅ Successful response
{
"OSVPaymentMessageResponse": {
"OSVPaymentTransactionResponse": [
{
"BankCode": "ALRAJHI",
"BankReferenceNumber": "",
"TransactionReferenceNumber": "797687499",
"TransactionData": [
{
"CompanyCode": "125001291",
"SequenceNum": "77858297",
"StatusCode": "OK",
"StatusDetail": "Your Payment file has been accepted, Kindly attempt to do a Payment Inquiry in a few minutes to know the Final status"
}
]
},
{
"BankCode": "ALRAJHI",
"BankReferenceNumber": "",
"TransactionReferenceNumber": "797687489",
"TransactionData": [
{
"CompanyCode": "125001291",
"SequenceNum": "77858277",
"StatusCode": "OK",
"StatusDetail": "Your Payment file has been accepted, Kindly attempt to do a Payment Inquiry in a few minutes to know the Final status"
}
]
}
]
}
}
Response description
JSON Tag | Description | Data type |
---|---|---|
OSVPaymentMessageResponse | Root node | Object |
OSVPaymentTransactionResponse | Element root containing response of every bank transactions | Object/Array |
BankCode | Unique bank identification code Ex: ALRAJHI, SABB, BSF, ANB, NCB, ALINMA, GIB, RIYADH, ALBI, BJAZ, ICICI, HDFC | String |
BankReferenceNumber | Bank Reference Number | String |
TransactionReferenceNumber | It is a unique reference number generated by the customer by the time of transaction) | String |
TransactionData | 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 |
StatusCode | Code representing status of the requestOK FAILED ONHOLD | Alphabetical |
StatusDetail | Details of the status code represented:OK - Your Payment file has been accepted, Kindly attempt to do a Payment Inquiry in a few minutes to know the Final status.FAILED - Invalid Account number, Exceed Daily Limit, Account Restricted, Connectivity ErrorONHOLD - Timeout accessing the server. Please retry. | String |
Updated about 13 hours ago