Use this endpoint to retrieve a bulk VA transfer batch by batch ID or batch reference.

-H "x-api-key: your_secret_key"

GET {{host}}/v1/va/transfer/bulk/{id}

Path Parameters

Field	Data Type	Required	Description
id	string	Yes	Bulk transfer batch ID or batch reference.

If the API call is successful, Kyshi returns the batch, beneficiary, and child payout items.

{
  "status": true,
  "message": "Success",
  "code": 200,
  "data": {
    "id": "0e7c4f6d-6d5c-46b7-91fd-91d7f100a001",
    "reference": "BULK-1778623597453",
    "status": "COMPLETED",
    "currency": "NGN",
    "mode": "live",
    "provider": "VFD",
    "rail": "VFD_VA",
    "amount": 100000000,
    "totalFees": 100,
    "totalDebitAmount": 100000100,
    "splitCount": 20,
    "successfulCount": 20,
    "failedCount": 0,
    "pendingCount": 0,
    "items": [
      {
        "id": "c5c5ed7c-7d86-45b6-a240-f21a5d000001",
        "sequence": 1,
        "reference": "BULK-1778623597453-001",
        "amount": 5000000,
        "status": "SUCCESS",
        "externalReference": "vfd-session-1",
        "transactionId": "6ae63a6d-2a58-4cb1-8cbd-b697a9000001",
        "transferId": "87b89739-437b-4fdc-b132-ceaa41000001"
      }
    ]
  }
}

Batch Statuses

Status	Description
PENDING	Batch has been created and is waiting to process.
PROCESSING	Kyshi is processing one or more child payouts.
COMPLETED	All child payouts completed successfully.
PARTIALLY_FAILED	At least one child payout failed and at least one completed.
FAILED	All child payouts failed.

Errors

If the batch cannot be found for your business and mode, Kyshi returns:

{
  "status": false,
  "message": "Transfer batch does not exist",
  "code": 404
}