Create Batch

Call this endpoint with the required parameters to create a payment batch containing the details of the beneficiaries/vendors to be paid. Upon successful creation of the batch, the batch will be created in Autopay.

Before the payments can be processed and beneficiaries/vendors credited, the designated Approving/Authorizing Officer must log in to Autopay to review and approve/authorize the batch. Once the necessary authorization is completed, the batch will be processed and the beneficiaries'/vendor's accounts will be credited accordingly.

Endpoint: POST /BatchUpload/CreateBatch

Request:

curl --location 'https://batch-upload.uat.isw.la/api/BatchUpload/CreateBatch' \
--header 'Content-Type: application/json' \
--header 'Accept: text/plain' \
--header 'Authorization: Bearer <TOKEN>'
--data-raw '{
"terminalId": "3SC10001",
  "institutionCode": "SC1",
  "sponsorCode": "ISW",
  "batchDescription": "Test Batch 281026",
  "isSingleDebit": true,
  "payingAccountName": "selenium additional card",
  "paymentCategory": "Allowance",
  "batchType": "Bulk Remittance",
"isDuplicateAllowed": false,
  "payments": [
    {
      "paymentReference": "6387392982",
      "beneficiaryCode": "4503",
      "names": "abyomi fatima",
      "accountNo": "0017063684",
      "accountType": "10",
      "cbnSortCode": "058",
      "isCashCard": false,
      "narration": "October Salary",
      "amount": "1000",
      "emailAddress": "[email protected]",
      "currencyCode": "NGN"
    }
  ]
}

Response:

{
    "hasResult": true,
    "result": {
        "batchId": 687842,
        "batchDescription": "Test Batch 281026",
        "batchType": "Bulk Remittance",
        "terminalId": "3SC10001",
        "institutionCode": "SC1",
        "totalRecord": 1,
        "payingAccountName": "selenium additional card",
        "batchStatus": "Closed",
        "dateCreated": "2026-10-28T05:29:31.65",
        "createdBy": "CLN4402776026"
    },
    "resultType": 1,
    "message": null,
    "validationMessages": null,
    "responseMessage": "Batch Created Successfully.",
    "responseCode": "00",
    "successful": true
}

Request Description

Field	Type	Required	Description
terminalId	string	Yes	Terminal identifier (max 20 chars, alphanumeric). This will be provided by Intersiwtch upon go-live
institutionCode	string	Yes	Corporate institution code (3-6 chars). This will be provided by Intersiwtch upon go-live
sponsorCode	string	Yes	Sponsor institution code (3-6 chars). This will be provided by Intersiwtch upon go-live
batchDescription	string	Yes	Batch name/description (5-50 chars)
isSingleDebit	boolean	Yes	True = Single debit (line-by-line debit) on the corporate account. False = Bulk debit on the corporate account. This requires a Float Card and will be provided by Interswitch upon go-live
payingAccountName	string	Yes	Name of the paying account (max 100 chars) as configured on Autopay
paymentCategory	string	Yes	Category of payment (e.g., "Salary", "Vendor")
batchType	string	Yes	Type: "Bulk Remittance" or "Single Payment".
isDuplicateAllowed	boolean	Yes	true or false. Allow duplicate payment references
payments	array	Yes	Array of payment objects (min 1, max 1000)
paymentReference	string	Yes	Unique payment reference (max 100 chars) for the beneficiary
beneficiaryCode	string	Yes	Beneficiary identifier
names	string	Yes	Beneficiary full name (max 200 chars)
accountNo	string	Yes	10-digit NUBAN account number of the beneficiary
accountType	string	Yes	"10" (Savings) or "20" (Current)
cbnSortCode	string	Yes	3-digit CBN bank sort code of the beneficiary's bank
isCashCard	string	Yes	If true, payment is to a cash card
narration	string	Yes	Payment description (5-200 chars)
amount	string	Yes	Amount in NGN (decimal format, e.g., "5000.00") to paid
emailAddress	string	Yes	Valid email address of the beneficiary
currencyCode	string	Yes	"NGN" only

📘
Key Points
The terminalId, institutionCode and sponsorCode will be provided by Interswitch upon go-live.

📘
Implementation Notes:
Upon successful creation of the batch, the designated Approving Officer must log in to Autopay to review and approve/authorize the batch. Once the required approval has been completed, the batch will be eligible for processing. Kindly follow the steps below to approve or authorize the batch.
Approving Officer:

Log in to Autopay.

Navigate to the "Approve Payments" menu.

Locate and select the batch you wish to approve.

Click Approve or Approve All to approve the payment(s) within the batch.

Authorizing Officer:

Log in to Autopay after the Approving Officer has completed the approval.

Navigate to the "Commit Payments" menu.

Locate the approved batch and click Authorize.

Click Authorize or Authorize All to authorize the payment(s) within the batch.

Enter your card PIN to complete the authorization process.

Support

For technical support or integration assistance and go-live:

Email: [email protected]