Skip to content

Wallet Bulk Transfer

The bulk transfer endpoint enables you makes multiple transfer on a single request by using an array of transaction.

Request Body

Note

Serialize the request body, then encrypt (AES encryption) it using the provided key. The encryption requires a secret key and IV key which will be provided by the sterling team. Pass the encrypted string as the value of "Data" in the new request body. 

EncryptedReq {
  "Data": "string"
}

curl -X POST https://pass.sterling.ng/OneBankWalletV3/api/Wallet/BulkWalletTransfers
-H 'Content-Type: application/json'

https://pass.sterling.ng/OneBankWalletV3/api/Wallet/BulkWalletTransfers

[
    {
        "TransactionType":0,
        "amt":"20",
        "toacct":"08129878284",
        "frmacct":"08034743711",
        "paymentRef":"273888172",
        "remarks":"testing",
        "channelID":49,
        "CURRENCYCODE":"NGN",
        "BulkTransferID":null,
        "NIPData":null},
        {"TransactionType":1,
        "amt":"20",
        "toacct":"0068222456",
        "frmacct":"08034743711",
        "paymentRef":"27388817221",
        "remarks":"testing",
        "channelID":49,
        "CURRENCYCODE":"NGN",
        "BulkTransferID":null,
        "NIPData":null},
        {
            "TransactionType":2,
            "amt":"20",
            "toacct":"08129878284",
            "frmacct":"08034743711",
            "paymentRef":"273888172",
            "remarks":"testing",
            "channelID":49,
            "CURRENCYCODE":"NGN",
            "BulkTransferID":null,
            "NIPData":{
                "NESessionID":"23747447474",
                "SessionID":"848447772727",
                "ChannelCode":1,
                "PaymentRef":"4666666",
                "Amount":53.0,
                "Fee":10.0,
                "Vat":0.75,
                "BraCodeVal":"0",
                "CusNumVal":"0",
                "CurCodeVal":"NGN",
                "LedCodeVal":"0",
                "SubAcctVal":"0",
                "OrignatorName":"Davd James",
                "DestinationBankCode":null,
                "AccountName":null,
                "AccountNumber":null,
                "OriginatorAccountNumber":null,
                "AccountLockID":null,
                "AppID":49,
                "OriginatorBankVerificationNumber":"23455",
                "BeneficiaryBankVerificationNumber":"123455",
                "BeneficiaryKYCLevel":"1",
                "OriginatorKYCLevel":"1"
            }
        }
]

```JSON

{ "message": "Successfully Paid", "response": "00", "responsedata": null, "data": { "sent": true } } ```

{
"Message": "An error has occurred."
}

Request Parameters

Parameter Type Description
amt string *required The amount that is to be transferred
toacct string *required The account number of the recieving customer
frmacct string *required The customer’s virtual account number/Wallet to debit
paymentRef string The customer's payment reference
remarks string *required Payment transfer remarks, e.g school fees, pocket money"
channelID string *required Channel identifier
CURRENCYCODE string *required Wallet currency code e.g., NGN
BulkTransferID string *required Bulk transfer identification number
TransferType string *required Type of transfer,i.e., wallet to wallet or wallet to other banks
PIN string Transaction PIN
NOTE: To get NIPdata, use the /InterBankNameEnquiry method to make account verification and get a recievers bank account information from NIPS and also get the bank fee and VAT values using the /GetFeeAndVat method which you need to include in the NIPdata parameter.

To be able to send money to other banks the following NIP's data is reqired.

Parameter Type Description
NESessionID string *required Name enquiry season ID generated form /InterBankNameEnquiry method
SessionID string Session identification number
ChannelCode integer *required Channel Code
PaymentRef string The senders payment reference
Amount integer *required The sender amount to tranfer
Fee integer *required The transaction fee
Vat integer *required Value added tax
BraCodeVal string The Branch code Value
CusNumVal string The custmer number value is the Customer's ID
CurCodeVal string The currency transaction code i.e, NGN, USD...
OrignatorName string *required Name of originator i.e., The name of the sender
DestinationBankCode string *required The bank destination code
AccountName string *required Reciever's account name
AccountNumber string *required Reciever's account number
OriginatorAccountNumber string Account number of originator i.e., the sender
AccountLockID string The user's account lockID
AppID integer Application Identification
OriginatorBankVerificationNumber string Bank verification number of originator i.e., the sender
BeneficiaryBankVerificationNumber string Bank verification number of reciever
BeneficiaryKYCLevel string Beneficiary Know-Your-Customer Level
OriginatorKYCLevel string" The Sender's Know-Your-Customer Level