API Documentation: GetClosedloopTransactionById

Description

The GetClosedLoopTransactionById API allows retrieving complete details of a specific Closed Loop transaction, including financial information, transaction status, contract data, and, when applicable, cancellation or reversal details.

This API is designed for single-transaction queries using the TransactionIdentifier, without requiring additional filters such as date ranges or transaction types.

Key Features

Retrieve a single transaction using the TransactionIdentifier
Return detailed transaction information, including:
- Status
- Financial values
- Relevant dates
- Contract and account details
Support for cancelled or reversed transactions through the CancellationInfo object
Ensures idempotent requests, allowing safe retries without duplication

Request JSON

{
  "Method": "GetClosedLoopTransactionById",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "TransactionIdentifier": "TRAc8bf0cf1-8b95-4030-8c69-8db61c6900b5TRA",
  "Identifier": "PurchaseTest1106new4"
}


Response JSON
{
  "Success": "true",
  "Message": "Transaction details retrieved successfully.",
  "TransactionDetails": {
    "Identifier": "DCL-ANNATESTE-c2ff47a0-f83c-4871-baac-b3df1b38c862",
    "Status": "PreSettled",
    "ExpirationDate": "2025-03-12T13:58:30Z",
    "ContractIdentifier": "CONb5fab06f-5234-4a44-8b5d-4fbe42027536CON",
    "MerchantAccountKey": "785644-690083-9999316-6",
    "UserAccountKey": "785644-690083-7503453-7",
    "SettlementDate": "2025-03-14T13:53:30Z",
    "TotalValue": 10,
    "SettledValue": 9,
    "RevenueValuePasstoReceiver": 0.1,
    "RevenueValuePasstoSupplier": 0.9,
    "RevenueSupplierPasstoArrangement": 0,
    "ExternalIdentifier": "1",
    "CancellationInfo": {
      "CancellationIdentifier": "d453e2d0-b02b-4067-9ebe-158edd72cbee",
      "Reason": "C01",
      "Description": "Incorrect amount entered, wrong account, duplicate transaction"
    }
  }
}

Response Fields Details

TransactionDetails

Field	Description	Type	Required
Identifier	Unique identifier associated with the transaction	String	Yes
Status	Current transaction status	String	Yes
ExpirationDate	Transaction expiration date and time	DateTime	No
ContractIdentifier	Associated contract identifier	String	No
MerchantAccountKey	Merchant account identifier	String	Yes
UserAccountKey	User account identifier	String	Yes
SettlementDate	Transaction settlement date and time	DateTime	Yes
TotalValue	Total transaction amount	Decimal	Yes
SettledValue	Effectively settled amount	Decimal	Yes
RevenueValuePasstoReceiver	Revenue amount passed to the receiver	Decimal	No
RevenueValuePasstoSupplier	Revenue amount passed to the supplier	Decimal	No
RevenueSupplierPasstoArrangement	Revenue amount passed to the arrangement	Decimal	No
ExternalIdentifier	External transaction identifier	String	No

CancellationInfo

When applicable, transactions may include cancellation or reversal information.

Fields

Field	Description	Type
CancellationIdentifier	Unique identifier of the cancellation or reversal	String
Reason	Standardized cancellation reason code	String
Description	Detailed reason provided by the operator or system	String