Partner API
Get Transaction Status
GET
/v1/partner/payments/transactions/:transactionIdReturns the full transaction object — the same object delivered by transaction.* webhooks. Fields fill in as the transaction progresses through its lifecycle.
Auth
Header: x-api-key
Use the bank-provisioned partner API key for authentication.
Usage Notes
- Header: x-api-key
- Returns the same object shape as transaction.* webhooks — use it as a fallback when a webhook is missed
- Fields are absent (not null) until the lifecycle stage that produces them
- timestamps.payoutDate is an ISO YYYY-MM-DD date and is present when the transaction is future-dated with status scheduled
Request Fields
transactionIdstringrequiredTransaction identifier used as the path parameter.
x-api-keystringrequiredPartner API key passed in the request header.
Request bodystringoptionalNo request body is required for this API.
GET /v1/partner/payments/transactions/txn-1747485000000-001 x-api-key: fp_test_51H8xKlMnOpQrStUv
Sample Success Response
{
"object": "transaction",
"transactionId": "68bc0a1b-b2d3-4f42-84cd-1030e5aac4b3",
"jobId": "f2baca0b-5896-4f7f-af27-f0ac2d89e6bd",
"apiRefNumber": "PO-2026-08-01-778",
"reference": "Acme July invoice",
"tag": "july-settlement",
"remark": "Monthly vendor settlement",
"metadata": {
"erpBatchId": "SAP-99213",
"costCenter": "CC-42"
},
"status": "paid",
"source": "partner_api",
"initiationMode": "bulk",
"packageCode": "VENPAY",
"paymentMethod": "NEFT",
"amount": {
"value": 25000000,
"currency": "INR"
},
"fees": {
"base": {
"value": 500,
"currency": "INR"
},
"gst": {
"value": 90,
"currency": "INR"
},
"total": {
"value": 590,
"currency": "INR"
}
},
"debitAccount": {
"accountNumber": "000112220001"
},
"beneficiary": {
"code": "ACME-VENDOR-01",
"name": "Acme Supplies Pvt Ltd",
"accountNumber": "000112223345",
"ifsc": "HDFC0005678",
"purpose": "Invoice INV-2291"
},
"approval": {
"levelsRequired": 2,
"currentLevel": 2,
"comment": "Verified against PO"
},
"actors": {
"createdBy": {
"userId": "usr-maker-01",
"username": "priya.finance",
"role": "finance_maker"
},
"approvedBy": {
"userId": "usr-checker-02",
"username": "rahul.checker",
"role": "finance_checker"
}
},
"timestamps": {
"createdAt": 1785460000000,
"approvedAt": 1785472000000,
"sentToBankAt": 1785473000000,
"paidAt": 1785473600000
},
"utr": "HDFCN2026080100778",
"narration": "CMS-HDFCN2026080100778-VENPAY",
"bankReference": "BANKALPHA-DISP-68BC0A1B"
}Sample Error Response
{
"type": "object_not_found_error",
"title": "The requested object was not found.",
"detail": "Transaction not found.",
"status": 404
}