API Documentation: GetClosedloopTransactionList

Description

The GetClosedloopTransactionList API allows users to retrieve a list of transactions from the Closed Loop system. The API provides the ability to filter transactions by parameters such as TransactionIdentifier, MerchantAccountKey, TransactionType, and Date Range. This ensures that users can narrow down the results based on their specific needs.

Key Features:

The API supports pagination to handle large sets of data.
Date filters can be combined with transaction types for granular control over results.
Idempotent requests are ensured by the idempotencyKey, preventing transaction duplication.

Available Filters:

TransactionIdentifier: Use this to retrieve data for a specific transaction.
MerchantAccountKey: Helps filter transactions by a particular merchant.
TransactionType: Allows filtering by transaction types (e.g., Purchase, Withdrawal, Deposit).
StartDate & EndDate: Allows filtering by date range.

Request JSON

{
  "Method": "GetClosedloopTransactionList",
  "PartnerId": 30472,
  "BusinessUnitId": 10409,
  "MerchantAccountKey": "498191-209911-9590853-5",
  "TransactionIdentifier": "TRA3ae6ad69-f36e-4c33-89a8-f2568458309cTRA",
  "Identifier": "IDdoCliente3ae6ad69-f36e-4c33-89a8-f2568458309c",
  "TransactionIdentifier": "TRA3ae6ad69-f36e-4c33-89a8-f2568458309cTRA",
  "TransactionType": 1,
  "StartDate": "2024-01-01T00:00:00Z",
  "EndDate": "2024-01-31T23:59:59Z",
  "PageIndex": 1,
  "PageSize": 10
}

Response JSON

The response from the API contains detailed information about the transactions retrieved based on the filters provided. The following JSON structure outlines the format in which the data will be returned:

{
  "Success": "true",
  "Message": "Transactions retrieved successfully",
  "Transactions": [
    {
      "TransactionIdentifier": "TRA3ae6ad69-f36e-4c33-89a8-f2568458309cTRA",
      "Identifier": "IDClient3ae6ad69-f36e-4c33-89a8-f2568458309c",
      "MerchantAccountKey": "498191-209911-9590853-5",
      "BusinessUnitId": 10409,
      "TransactionType": 1,
      "TotalValue": 150.75,
      "Status": "Authorized",
      "SettlementDate": "2024-01-02T15:30:00Z"
    },
    {
      "TransactionIdentifier": "TRA7be8ad69-d78e-43a2-85d4-a2568745609cTRA",
      "Identifier": "IDClient3ae6ad69-f36e-4c33-89a8-f2568458309c",
      "MerchantAccountKey": "498191-209911-9590853-5",
      "BusinessUnitId": 10409,
      "TransactionType": 1,
      "TotalValue": 200.50,
      "Status": "Settled",
      "SettlementDate": "2024-01-05T18:00:00Z"
    }
  ]
}

Explanation of Response Fields

The following table provides detailed descriptions of each field in the API response.

Parameter Table

Parameter	Description	Type	Example	Mandatory
Method	The name of the method being executed by the API.	String	"GetClosedloopTransactionList"	Yes
PartnerId	The unique identifier of the partner responsible for the operation.	Integer	30472	Yes
BusinessUnitId	The identifier of the Business Unit associated with the transactions.	Integer	10409	Yes
MerchantAccountKey	The unique identifier for the merchant.	String	"498191-209911-9590853-5"	No
Identifier	A unique identifier for the customer associated with the transaction.	String	""IDClient3ae6ad69-f36e-4c33-89a8-f2568458309c"	No
TransactionIdentifier	The unique identifier of a transaction.	String	"TRA3ae6ad69-f36e-4c33-89a8-f2568458309cTRA"	No
TransactionType	The type of transaction (e.g., Purchase = 1, Withdrawal = 2, Deposit = 3).	Integer	1	No
StartDate	The start date for filtering transactions.	DateTime	"2024-01-01T00:00:00Z"	Conditional
EndDate	The end date for filtering transactions.	DateTime	"2024-01-31T23:59:59Z"	Conditional
PageIndex	The page number for pagination.	Integer	1	No
PageSize	The number of records per page for pagination.	Integer	10	No