List/Get Transactions

Partner API

GET/v1/partner/reports/transactions

Returns transactions filtered the same way the Transactions screen is, with full item-level detail per transaction. Pass transactionId to fetch one transaction directly.

Auth

Header: x-api-key

Use the bank-provisioned partner API key for authentication.

Usage Notes

Header: x-api-key
Dates are DD-MM-YYYY (India-only), UTC day boundaries, max 6-month range
Every result includes item-level detail (items[]) — this is not just a summary list
No transaction timeline in this response — that's a UI-only concept

Request Fields

initiatedByUserIdstringrequired

The user this integration acts as — either a service user or a real human user. Its role decides which packages and debit accounts you can see.

transactionIdstringoptional

Fetch a single transaction directly.

fromDatestringoptional

Optional DD-MM-YYYY UTC day start. Must be supplied together with toDate.

toDatestringoptional

Optional DD-MM-YYYY UTC day end (inclusive). Must be supplied together with fromDate; range capped at 6 months.

statestringoptional

pending_approval, partially_approved, approved, rejected, sent_to_bank, paid, or failed.

packagesstringoptional

Comma-separated package codes.

paymentMethodsstringoptional

Comma-separated payment method codes, e.g. NEFT,IMPS.

debitAccountIdstringoptional

Filter to one funding account.

searchstringoptional

Matches title, batch ID, beneficiary name/ID, or amount.

sourcestringoptional

e.g. corporate_app, file_upload, partner_api, client_sdk, payout_link, payout_checkout.

amountOperatorstringoptional

between, equals, gt, or lt. Use amountValue or amountMin/amountMax as appropriate.

limitstringoptional

Default 50, max 100.

afterstringoptional

Opaque cursor from the previous page's pagination.nextCursor.

GET /v1/partner/reports/transactions?fromDate=31-07-2026&toDate=02-08-2026&initiatedByUserId=svc-user-8f3a2b&state=paid&packages=VENPAY
x-api-key: fp_test_51H8xKlMnOpQrStUv

Sample Success Response

{
  "items": [{
    "transactionId": "batch-20260801-004521",
    "title": "Vendor payout - July settlement",
    "state": "paid",
    "totalAmount": { "value": 452000, "currency": "INR" },
    "packageCode": "VENPAY",
    "debitAccountId": "1234",
    "items": [{
      "itemId": "item-001",
      "beneficiaryId": "BENE7712",
      "amount": 250000,
      "state": "paid",
      "accountNumber": "000112223345",
      "ifsc": "HDFC0001234"
    }]
  }],
  "pagination": { "limit": 50, "hasMore": false, "nextCursor": null }
}

Sample Error Response

{
  "message": "The initiating user is not valid for this API key."
}