/api/v2/bulk/payment

POST

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

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

TransactionDescription Mandatory

Payment Description Maximum length : 35 characters

String

BankCode Mandatory

Unique bank identification code ALRAJHI - Al Rajhi Bank SABB - Saudi Awaal Bank BSF - Banque Saudi Fransi ANB - Arab National Bank NCB - Saudi National Bank RIYADH - Riyadh Bank

Alphabet

TransactionReferenceNumber Mandatory

It is a unique reference number generated by the customer for each transaction Maximum length : 16 numeric characters

Numeric

TransactionData Mandatory

This tag contains the payment details

Object/Array

PurposeOfRemittance Conditional Review POR list for mandatory banks

Code representing the purpose of remittance View all POR codes

Numeric

TransferType Mandatory

Same Bank : interbank Local Bank: sarie International : swift

Alphabet

SequenceNum Mandatory

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

Numeric

OrderingCustomerIBAN Mandatory

Ordering Customer’s IBAN number (Any one is mandate Account Number or IBAN Number)

Alphanumeric

OrderingCustomerAccountNumber Mandatory

Ordering Customer’s account number (Any one is mandatory Account Number or IBAN Number) Input size: Min - 11 Characters Max - 24 Characters

Alphanumeric

OrderingInstitution Mandatory

Ordering Institution Ex: SABBSARI, RJHISARI Maximum length: 8 or 11 characters

Alphanumeric

OrderingCurrency Mandatory

This is the currency code used in the transaction. Maximum length : 3 digit currency code

Alphabet

OrderingCustomerNameAddress Mandatory

Element root containing details of Ordering customer

Object/Array

OrderingCustomerName Mandatory

Ordering Customer’s Name Input size: 3-35 Characters

Alphabet

OrderingCustomerAdd1 Mandatory

Ordering Customer’s Address Line 1 Input size: 3-35 Characters

String

OrderingCustomerAdd2 Mandatory

Ordering Customer’s Address Line 2 ( city to be mentioned) Input size: 3-35 Characters

String

OrderingCustomerAdd3 Mandatory

Ordering Customer’s Address Line 3 Input size: 3-35 Characters

String

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

BeneficiaryName Mandatory

Beneficiary Name Input size: 3-35 Characters

Alphabet

BeneficiaryAccount Mandatory

Beneficiary Customer’s account number Input size: 3-35 Characters

String

BeneficiaryADD1 Mandatory

Beneficiary Address Line 1 Input size: 3-35 Characters

String

BeneficiaryADD2 Mandatory

Beneficiary Address Line 2 ( city to be mentioned) Input size: 3-35 Characters

String

BeneficiaryADD3 Mandatory

Beneficiary Address Line 3 Input size: 3-35 Characters

String

TransactionComment Mandatory

Additional comments for the payments Max size of input: 35 Characters

String

DateCurrencyAmount Mandatory

Element root containing details of Date, Currency and Amount

Object

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

Date Mandatory

Value date Transactions will be performed on this date. Date must be expressed as YYMMDD Maximum length : 6 numeric characters

Date

CompanyCode Mandatory

Unique identification code of the company

Alphanumeric

DetailsOfCharge Mandatory

To be mentioned as SHA

Alphabet

AdditionalDetails Optional

Additional details about the payment Max size of input: 35 Characters

String

B2BCRN Conditional

Unique Commercial Registration Number for Client provided by Al Rajhi Bank Mandatory only for Al Rajhi Bank

String

B2BAggrId Conditional

Unique B2B aggregator identification details. Mandatory only for ICICI Bank

Alphanumeric

B2BName Conditional

Unique B2B name Mandatory only for ICICI Bank

Alphabet

B2BUserId Conditional

Unique B2B user identification details Mandatory only for ICICI Bank

Alphanumeric

B2BUrn Conditional

Unique B2B URN Mandatory only for ICICI Bank

String

Signature Mandatory

Encrypted string generated using a Private Key/CA-Signed Certificate with SHA-256 and RSA (JCE Signature)

String

OSVPaymentMessageResponse

Root node

Object

OSVPaymentTransactionResponse

Element root containing response of every bank transactions

Object/Array

BankCode

Unique bank identification code ALRAJHI - Al Rajhi Bank SABB - Saudi Awaal Bank BSF - Banque Saudi Fransi ANB - Arab National Bank NCB - Saudi National Bank RIYADH - Riyadh Bank

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

StatusCode

Code representing status of the request OK FAILED ONHOLD - In such case perform a payment enquiry. If payment enquiry cannot be performed, contact customer support

Alphabetical

StatusDetail

Details of the status code represented: OK - Your Payment file has been accepted. Kindly attempt to do a Payment Enquiry in a few minutes to know the Final status. FAILED - Invalid Account number, Exceed Daily Limit, Account Restricted, Connectivity Error ONHOLD - Response timeout! Please perform payment enquiry to check the status after few minutes or contact support.

String

BankReferenceNumber

Unique bank reference identification details for the transaction

String