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
🔐 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