Get Transaction Details

Use the Get Transaction Details API endpoint to retrieve detailed information for a specific transaction associated with a customer's line of credit account.

📘
Early Access
Credit API endpoints are currently being finalised as part of ongoing product development. While we do not anticipate significant changes, some interfaces, behaviours, and documentation may be refined before general availability.

The Get Transaction Details endpoint enables you to retrieve detailed information for a specific transaction associated with a customer's line of credit account. Use this endpoint when you need to display the full details of an individual transaction, such as the transaction type, merchant information, billing cycle and authorisation amounts.

By default, the endpoint looks for a spend transaction. To retrieve a credit transaction, such as a rewards redemption, or a payment, set the transactionType query parameter. Use the transactionType value returned by Get Account Transactions.

📘
More Information
For more information about the Explorer endpoints, see: Credit Explorer.

Example Request

Retrieve transaction details by making a GET request to the Get Transaction Details endpoint.

GET {{baseUrl}}/api/v1/credit/explorer/accounts/{account_id}/transactions/{transaction_id}

Path Parameters

Parameter	Description
`account_id`	string. Required. The unique identifier of the account.
`transaction_id`	string. Required. The unique identifier of the transaction. Digits only.

Query Parameters

Parameter	Description
`transactionType`	string. Optional. The type of the transaction, as returned by Get Account Transactions. Defaults to `spend`. Possible values: `spend`, `credit`, `payment`. For a `credit` transaction, the response includes its `creditCategory`.
`rewardType`	string. Optional. Which reward points to include in the `rewardPoints` and `rewardDollarValue` fields. Defaults to `all`. Possible values: `all`, `earned`, `redeemed`.

Example Response

A successful request returns a 200 HTTP status code with the transaction details.

{
  "clientAssignedId": "acc_123456",
  "transactionId": "123456",
  "transactionType": "spend",
  "creditCategory": null,
  "accountId": "acc_123456",
  "amount": "49.99",
  "currency": "USD",
  "created": "2025-01-15T10:30:00Z",
  "valueDate": "/Date(1736899200)/",
  "cardId": "card_123456",
  "addressId": "addr_123456",
  "billingCycle": "2025-01",
  "description": "Coffee Shop",
  "merchantName": "The Coffee Shop",
  "merchantCategoryCode": "5812",
  "rawTransactionFeed": null,
  "status": "settled",
  "originalAuthAmount": "49.99",
  "rewardPoints": 50,
  "rewardDollarValue": "0.50"
}

Response Fields

Attribute	Description
`clientAssignedId`	string or null. The identifier of the parent line of credit account, as assigned in the loan management system.
`transactionId`	string or null. The unique identifier of the transaction.
`transactionType`	string or null. The type of transaction. Possible values: `fee`, `spend`, `payment`, `credit`, `interest`.
`creditCategory`	string or null. The credit category of a credit transaction, such as a rewards redemption. Only returned when `transactionType` is `credit`.
`accountId`	string or null. The unique identifier of the account associated with the transaction.
`amount`	string or null. The transaction amount.
`currency`	string or null. The ISO 4217 alphabetic currency code of the transaction.
`created`	string or null. The date and time the transaction was created.
`valueDate`	string or null. The date the transaction was applied to the account, in OData date format: `/Date(unix_epoch_seconds)/`. For example, `/Date(1736899200)/` is 15 January 2025.
`cardId`	string or null. The unique identifier of the card used for the transaction.
`addressId`	string or null. The unique identifier of the address associated with the transaction.
`billingCycle`	string or null. The billing cycle in which the transaction occurred.
`description`	string or null. A description of the transaction.
`merchantName`	string or null. The name of the merchant associated with the transaction.
`merchantCategoryCode`	string or null. The merchant category code (MCC) that classifies the type of business.
`rawTransactionFeed`	string or null. The raw transaction feed data.
`status`	string or null. The current status of the transaction.
`originalAuthAmount`	string or null. The original authorised amount of the transaction.
`rewardPoints`	number or null. The net reward points for this transaction. Positive when points are earned, and negative when points are redeemed or clawed back, for example after a merchant return. If you set `rewardType` to `earned` or `redeemed`, this counts only those points, without reversals.
`rewardDollarValue`	string or null. The reward points for this transaction, converted to a dollar value.

Updated 4 days ago

Did this page help you?