--- title: "Retrieve a User Credit Transaction" method: GET path: "/v2/user_credit_transactions/{user_credit_transaction_id}" tags: ["User Credit Transaction"] --- # Retrieve a User Credit Transaction `GET /v2/user_credit_transactions/{user_credit_transaction_id}` ## Request - Base URL: `https://api.sandbox.lead.bank` - URL: `https://api.sandbox.lead.bank/v2/user_credit_transactions/{user_credit_transaction_id}` - Auth: HTTP bearer Retrieve a User Credit Transaction by its ID. ## Path parameters - `user_credit_transaction_id` string, required ## Response `200` A User Credit Transaction object. - UserCreditTransaction - `id` string, required: The ID of the User Credit Transaction object. - `user_credit_balance_id` string, required: The ID of the User Credit Balance that this transaction belongs to. - `type` 'card_network' | 'funding' | 'fee' | 'fee_accrued' | 'dispute_provisional' | 'dispute_won' | 'dispute_lost' | 'charge_off' | 'charge_off_recovery' | 'rewards_earned' | 'rewards_spent' | 'rewards_redeemed' | 'interest_accrued' | 'adjustment' | 'reallocation' | 'payment' | 'cancellation' | 'client_credit', required: The type of the User Credit Transaction, which determines how the transaction affects the associated User Credit Balance. - `core_transaction_id` string, required - `counterparty_core_transaction_id` string, required - `description` string: A client-provided description of the transaction. - `currency_code` 'USD', required: A three-letter currency code as defined in ISO 4217. - `amount` integer, required: The transaction amount, represented in minor units. See `CreateUserCreditTransactionRequest.amount` for the per-`type` sign rules. On a transaction created by a reverse action, this is the negation of the original transaction's `amount`. - `amount_in_usd` integer: The transaction amount converted to USD, represented in minor units. On a transaction created by a reverse action, this is the negation of the original transaction's `amount_in_usd`. - `amount_breakdown` UserCreditTransactionAmountBreakdown, required: A breakdown of `amount` into its principal, interest, and fee components. The three values must sum to `amount`. - `principal` integer, required: The portion of `amount` applied to principal, represented in minor units. - `interest` integer, required: The portion of `amount` applied to interest, represented in minor units. - `fees` integer, required: The portion of `amount` applied to fees, represented in minor units. - `effective_at` string, date-time, required: An RFC 3339 timestamp representing when the transaction is effective. - `details` UserCreditTransactionDetails: Additional details about the User Credit Transaction. Which properties are populated depends on the transaction `type`: `fee_type` is required when `type` is `fee`; `rewards` is required when `type` is `rewards_redeemed`, `rewards_earned`, or `rewards_spent`; `card_network` is present when `type` is `card_network`; `reversal` is present only on a transaction created by a reverse action. - `fee_type` 'periodic_maintenance' | 'card' | 'international_transaction' | 'borrower_origination' | 'other': The category of fee represented by this transaction. Required when `type` is `fee`. - `card_network` UserCreditTransactionCardNetworkDetails: Card network details associated with a `card_network`-type User Credit Transaction. - `card_id` string: The ID of the card used for the transaction. - `bin` string: The Bank Identification Number of the card used for the transaction. - `card_network` 'visa' | 'mastercard' | 'pulse' | 'accel' | 'maestro' | 'tabapay' | 'amex' | 'star' | 'interlink': The card network that processed the transaction. - `original_transaction_id` string: The card network's identifier for the original transaction this record relates to (e.g. for a clearing record referencing its authorization). - `network_transfer_type` 'card' | 'oct' | 'aft': The stage of card network processing this record represents. - `authorization_amount` integer: The amount authorized by the card network, represented in minor units. - `authorization_currency_code` 'USD': A three-letter currency code as defined in ISO 4217. - `settlement_amount` integer: The amount settled by the card network, represented in minor units. - `settlement_currency_code` 'USD': A three-letter currency code as defined in ISO 4217. - `settlement_date` string, date: The date on which the transaction is expected to settle with the card network. Mutable via the update endpoint. - `merchant` UserCreditTransactionCardNetworkMerchant: Merchant details associated with a `card_network`-type User Credit Transaction. - `name` string: The name of the merchant. Required when `details.card_network.network_transfer_type` is `card`. - `address_line_1` string: The street address of the merchant. Optional; no format constraint. - `city` string: The city of the merchant. Optional; no format constraint. - `state` string: The state of the merchant. Optional; no format constraint. - `country_code` string: The two-letter ISO 3166-1 country code of the merchant. Required when `details.card_network.network_transfer_type` is `card`. - `zip_code` string: The postal code of the merchant. Optional; no format constraint. - `mcc` string: The Merchant Category Code for the transaction. Required when `details.card_network.network_transfer_type` is `card`. - `rewards` UserCreditTransactionRewardsDetails: Rewards program details associated with the User Credit Transaction. Required when `type` is `rewards_redeemed`. Required when `type` is `rewards_earned` or `rewards_spent` and the top-level `amount` is `0`. - `amount` integer, required: The rewards amount. When `unit` is `USD`, represented in minor units; when `unit` is `points`, a whole number of points. Non-negative when `type` is `rewards_earned`; non-positive when `type` is `rewards_spent` or `rewards_redeemed`. - `unit` 'points' | 'USD', required: The unit that `amount` is denominated in. - `reversal` UserCreditTransactionReversalDetails: Present only on a User Credit Transaction created by a reverse action. - `original_transaction_id` string, required: The ID of the User Credit Transaction object. - `funding_id` string: The ID of the associated Funding object. Present when `type` is `funding`. - `reversal_transaction_id` string: The ID of the reversal User Credit Transaction created when this transaction was reversed. Present only once this transaction has been reversed. - `metadata` Metadata, required: A set of key-value pairs that can be used to store additional information related to this object. - `created_at` string, date-time, required: An ISO-8601 timestamp at which the User Credit Transaction was created. - `updated_at` string, date-time, required: An ISO-8601 timestamp at which the User Credit Transaction was last updated. ## Other responses - `400`: The request URL could not be parsed (`request_malformed`). - `403`: Rejected before the request reached the User Credit Transaction API. `code` is one of: `authentication_missing` (the request has no credentials), `token_invalid` (the bearer token is expired, invalid, or does not grant the required scope), `source_ip_not_permitted` (the request came from an IP address that is not on your program's allowlist). - `404`: The user_credit_transaction_id passed in is not a valid User Credit Transaction ID. - `422`: The request was parsed but cannot be processed. `code` is one of: `parameters_invalid` (the User Credit Transaction ID is malformed). - `429`: Too many requests. Please retry after some time. - `500`: Internal server error. - `503`: The endpoint is temporarily disabled. Retry after the interval given in the `Retry-After` header. - `504`: An upstream system did not respond in time. Retry with backoff. ## Changes - **2026-11-03** `2c659854496e`: 1 info - endpoint added [Operation history](https://skmtc.dev/lead/apis/lead-bank/changes/v2/user_credit_transactions/:user_credit_transaction_id/get.md) --- [API](https://skmtc.dev/lead/apis/lead-bank.md) - [All operations](https://skmtc.dev/lead/apis/lead-bank/llms.txt) - [OpenAPI document](https://skmtc.dev/lead/apis/lead-bank/revisions/2c659854496e?raw)