Get Transaction By ID

API Documentation: GetClosedloopTransactionById

Description

The GetClosedloopTransactionById API allows users to retrieve detailed information about a specific transaction by its unique TransactionIdentifier. This API is designed to provide a straightforward way to query and retrieve transaction data without the need for additional filters like date ranges or transaction types. The API returns a comprehensive set of data related to the transaction, including status, amounts, and other transaction-specific details.

Key Features:

  • Retrieve a single transaction's details using the TransactionIdentifier.
  • The API provides detailed information about the transaction, including the status, value, and settlement date.
  • Idempotent requests are ensured, meaning the same request can be safely repeated without causing duplication.

Request JSON

{
  "Method": "GetClosedloopTransactionById",
  "PartnerId": 30472,
  "BusinessUnitId": 10409,
  "Identifier": "IDdoCliente3ae6ad69-f36e-4c33-89a8-f2568458309c",
  "TransactionIdentifier": "TRA3ae6ad69-f36e-4c33-89a8-f2568458309cTRA",
}

Response JSON

{
  "Success": "true",
  "Message": "Transaction retrieved successfully",
  "Transaction": {
    "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",
    "TransactionDate": "2024-01-01T14:30:00Z",
    "ExternalIdentifier": "EXT123456789"
  }
}

Explanation of Response Fields

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

ParameterDescriptionTypeExampleMandatory
MethodThe name of the method being executed by the API.String"GetClosedloopTransactionById"Yes
PartnerIdThe unique identifier of the partner responsible for the operation.Integer30472Yes
BusinessUnitIdThe identifier of the Business Unit associated with the transaction.Integer10409Yes
TransactionIdentifierThe unique identifier for the transaction.String"TRA3ae6ad69-f36e-4c33-89a8-f2568458309cTRA"Yes
IdentifierA unique identifier for the customer associated with the transaction.String"IDClient3ae6ad69-f36e-4c33-89a8-f2568458309c"Yes
MerchantAccountKeyThe unique identifier for the merchant.String"498191-209911-9590853-5"Yes
TransactionTypeThe type of transaction (e.g., Purchase = 1, Withdrawal = 2, Deposit = 3).Integer1Yes
TotalValueThe total value of the transaction.Decimal150.75Yes
StatusThe current status of the transaction.String"Authorized"Yes
SettlementDateThe date and time the transaction was settled.DateTime"2024-01-02T15:30:00Z"Yes
TransactionDateThe date and time the transaction occurred.DateTime"2024-01-01T14:30:00Z"Yes
ExternalIdentifierThe external identifier for the transaction (if applicable).String"EXT123456789"No