Bulk Payment Name Enquiry
The Bulk Name Enquiry service retrieves the information associated with
beneficiaries.
Body Parameters
serviceType
|
string
|
Required
Service type for this request is Bulk_Name_Enquiry
requestRef
|
string
|
Required
The unique reference identifier for this request.
AccountNumber
|
string
|
Required
The beneficiary’s account number.
BankCode
|
string
|
Required
Beneficiary’s bank code.
Headers
Authorization : Bearer
|
string
|
Required
Your Access Token
Sample Request
JSON
Copy
{
"serviceType": "BULK_NAME_ENQUIRY",
"requestRef": "492-bulk",
"Data": [
{
"AccountNumber": "1300997999",
"BankCode": "000023"
}
]
}Response
{
"message": "Request successful.",
"status": true,
"data": {
"beneficiaries": [
{
"accountNumber": "2000355517",
"accountName": "Open API",
"bankCode": "999129",
"nameEnquirySessionId": "NA",
"responseMessage": null
},
{
"accountNumber": "2504275504",
"accountName": "Testing Bussiness",
"bankCode": "999129",
"nameEnquirySessionId": "NA",
"responseMessage": null
}
]
}
}Collection Or Main Account Bulk Payment
This request enables you make bulk payments to more beneficiaries at once
through you Main or collection Account.
Body Parameters
serviceType
|
string
|
Required
There are two types of service types for this request:
1. COLLECTION_ACCOUNT_BULK_PAYMENT
2. MAIN_ACCOUNT_BULK_PAYMENT
requestRef
|
string
|
Required
The unique reference identifier for this request.
TrackingReference
|
string
|
Unique identifier of the debit account for collection account.
TotalAmount
|
string
|
Required
Total transaction amount
NotificationEmail
|
string
|
Required
Email to receive transaction information
narration
|
string
|
Transaction description
BeneficiaryPaymentData
|
object
|
array
|
Required
The columns below contains the parameters for beneficiary payment Data Array-objects.n
accountNumber
|
string
|
Required
The beneficiary’s acccount number.
AmountInKobo
|
string
|
Required
The transaction amount in Kobo.
FeeAmountInKobo
|
string
|
Required
The fee amount in kobo
DestinationAccountName
|
string
|
Required
The beneficiary’s account name.
bankCode
|
string
|
Required
Beneficiary’s bank code.
Narration
|
string
|
Required
The transaction refrence/description.
nameEnquirySessionId
|
string
|
Required
The sessionId from BulkNameEnquiry. Type in ‘NA’ if it’s not available.
Headers
Authorization : Bearer
|
string
|
Required
Your Access Token
Sample Request: Collection Account
JSON
Copy
{
"serviceType": "COLLECTION_ACCOUNT_BULK_PAYMENT",
"requestRef": "23222",
"data": {
"TrackingReference": "ttetedx123",
"TotalAmount": 700000,
"NotificationEmail": "test@gmail.com",
"narration": "My Test",
"BeneficiaryPaymentData": [
{
"FeeAmountInKobo": 1000,
"DestinationAccountName": "Testing Bussiness",
"AmountInKobo": 550000,
"bankCode": "999129",
"Narration": "My Test",
"nameEnquirySessionId": "NA",
"accountNumber": "2504275504"
},
{
"FeeAmountInKobo": 1000,
"DestinationAccountName": "Open API",
"AmountInKobo": 150000,
"bankCode": "999129",
"Narration": "My Test",
"nameEnquirySessionId": "NA",
"accountNumber": "2000355517"
}
]
}
}Sample Request: Main Account
JSON
Copy
{
"serviceType": "MAIN_ACCOUNT_BULK_PAYMENT",
"requestRef": "2322281",
"data": {
"ClientAccountNumber": "2504357961",
"TotalAmount": 700000,
"NotificationEmail": "test@gmail.com",
"narration": "My Test",
"BeneficiaryPaymentData": [
{
"FeeAmountInKobo": 1000,
"DestinationAccountName": "Testing Bussiness",
"AmountInKobo": 550000,
"bankCode": "999129",
"Narration": "My Test",
"nameEnquirySessionId": "NA",
"accountNumber": "2504275504"
},
{
"FeeAmountInKobo": 1000,
"DestinationAccountName": "Open API",
"AmountInKobo": 150000,
"bankCode": "999129",
"Narration": "My Test",
"nameEnquirySessionId": "NA",
"accountNumber": "2000355517"
}
]
}
}Response
{
"requestReference": "2322281",
"transactionReference": null,
"instrumentNumber": null,
"responseCode": "K06",
"status": true,
"message": "Request successful",
"data": null
}This method retrieves the transaction query status for Client’s bulk payment.
Body Parameters
serviceType
|
string
|
Required
Service type for this request is
BULK_TRANSFER_TSQ
requestRef
|
string
|
Required
The unique reference identifier for this request.
Headers
Authorization : Bearer
|
string
|
Required
Your Access Token
Sample Request
JSON
Copy
{
"serviceType": "BULK_PAYMENT_TSQ",
"requestRef": "23222"
}Response
{
"message": "Request successful.",
"status": true,
"data": {
"beneficiaries": [
{
"status": "Processing",
"amount": 150000,
"fee": 1000,
"beneficiaryAccountName": "Open API",
"beneficiaryAccountNumber": "2000355517",
"transactionReference": null,
"feeTransactionReference": null,
"instrumentNumber": null,
"isFeeProcessed": false,
"bankCode": "999129"
},
{
"status": "Processing",
"amount": 550000,
"fee": 1000,
"beneficiaryAccountName": "Testing Bussiness",
"beneficiaryAccountNumber": "2504275504",
"transactionReference": null,
"feeTransactionReference": null,
"instrumentNumber": null,
"isFeeProcessed": false,
"bankCode": "999129"
}
]
}
}