Skip to main content
GET
/
api
/
v3
/
dashboard
/
bulk-payments
/
api
/
transactions
/
{transactionId}
Get transaction details with batches
curl --request GET \
  --url https://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/transactions/{transactionId}
{
  "id": "<string>",
  "transactionName": "<string>",
  "description": "<string>",
  "status": "<string>",
  "fileName": "<string>",
  "totalBatches": 123,
  "totalRecipients": 123,
  "totalAmount": 123,
  "currencies": [
    "<string>"
  ],
  "completedBatches": 123,
  "failedBatches": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "batches": [
    {
      "id": "<string>",
      "batchName": "<string>",
      "status": "<string>",
      "totalAmount": 123,
      "totalPayments": 123,
      "successfulPayments": 123,
      "failedPayments": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "progress": [
        {
          "step": "<string>",
          "status": "<string>",
          "message": "<string>",
          "startedAt": "2023-11-07T05:31:56Z",
          "completedAt": "2023-11-07T05:31:56Z",
          "details": {}
        }
      ]
    }
  ]
}
Get detailed information about a specific bulk payment transaction including all batches.

Path Parameters

transactionId
string
required

Response

200 - application/json

Transaction details retrieved successfully

id
string
required

Transaction ID

transactionName
string
required

Transaction name

description
string
required

Transaction description

status
string
required

Transaction status

fileName
string
required

File name

totalBatches
number
required

Total batches

totalRecipients
number
required

Total recipients

totalAmount
number
required

Total amount

currencies
string[]
required

Currencies involved

completedBatches
number
required

Completed batches count

failedBatches
number
required

Failed batches count

createdAt
string<date-time>
required

Created date

createdBy
string
required

Created by

batches
object[]

Batches in this transaction