Transaction Manage API Documentation

Welcome to the Transaction Manage API, part of the Finrelay Payments Platform. This API enables merchants and integrators to manage existing transactions by initiating follow-up actions such as captures, refunds, and voids based on original transaction references.

This is a general transaction management API and may support additional management operations in the future, allowing for expanded flexibility as integration needs evolve.

✅ Use Cases

The API supports a variety of transaction management operations, including:

• Partial or full capture of previously authorized transactions
• Partial or full refunds of completed purchases or captured transactions
• Void operations on authorized or pending transactions

⚠️ Note: Availability of specific transaction types (e.g., capture, void, refund) depends on:

• The underlying integration with the payment service provider (PSP)
• The type of credentials issued by the third-party PSP to your merchant account

Supported Transaction Types

The gateway supports two categories of transaction types: management transaction types used to perform follow-up operations on existing transactions via this API, and initial transaction types used when creating a new transaction.

Management Transaction Types

These transaction types are submitted to /api/transactions/manage to perform follow-up operations on an existing transaction:

Transaction Type	Description
CAPTURE	Collects funds from a previously authorized (AUTHORIZE) transaction. Supports partial or full capture up to the original authorized amount.
REFUND	Returns funds to the customer for a completed or captured transaction. Supports partial or full refund amounts.
VOID	Cancels an authorized or pending transaction before capture, releasing the held funds back to the customer.

Note: Availability of specific management transaction types depends on the underlying integration with the payment service provider (PSP) and the credentials issued to your merchant account.

Initial Transaction Types

These transaction types are submitted at the point of authorization to create a new transaction:

Transaction Type	Endpoint	Description
PURCHASE	/api/transactions/authorize	Combined authorization and immediate capture in a single step. Funds are reserved and collected at once. The most common type for standard card payments.
AUTHORIZE	/api/transactions/authorize	Reserves (holds) funds on the customer's card without capturing them immediately. A separate CAPTURE management operation must follow to collect the funds. Use when the final charge amount may change (e.g. hotel reservations, car rentals).
OCT	/api/transactions/authorize	Original Credit Transaction — pushes funds directly to a cardholder's card. Used for payouts, disbursements, and marketplace seller payments.
PAYOUT	/api/transactions/authorize	Sends funds to a card recipient via a payout flow.
PAYMENT	/api/transactions/payment	Alternative payment methods such as Open Banking, UPI, wallets, bank transfer, or QR code. The transaction_type is fixed to PAYMENT automatically for this endpoint.

---

🔐 Authentication

All requests require a valid JWT Bearer Token. The token must be included in the Authorization header of the request:

Authorization: Bearer <your-jwt-token>

🌐 Base URLs

Environment	URL
Dev	https://dev-api.finrelay.io
Production	https://api.finrelay.io

🧾 Endpoint Overview

POST /api/transactions/manage\ Initiates a transaction management operation using a reference to a previous transaction.

• Request Body: ManageTransactionRequestDto
• Response: ExtendedTransactionDto (includes updated transaction details)
• Security: Requires Bearer JWT