Skip to main content
GET
Retrieve a User Credit Transaction

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

user_credit_transaction_id
string
required

The ID of the User Credit Transaction to be retrieved.

Pattern: ^user_credit_transaction_\w+$

Response

A User Credit Transaction object.

id
string
required

The ID of the User Credit Transaction object.

Pattern: ^user_credit_transaction_\w+$
Example:

"user_credit_transaction_xyz123"

user_credit_balance_id
string
required

The ID of the User Credit Balance that this transaction belongs to.

Pattern: ^user_credit_balance_\w+$
Example:

"user_credit_balance_xyz123"

type
enum<string>
required

The type of the User Credit Transaction, which determines how the transaction affects the associated User Credit Balance.

Available options:
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
Example:

"card_network"

core_transaction_id
string | null
required

The core transaction on the settlement (FBO) account side of this transaction's posting. Null until the transaction posts.

Pattern: ^core_transaction_.+~\d+$
Example:

"core_transaction_xyz123"

counterparty_core_transaction_id
string | null
required

The core transaction on the counterparty's operating account side of this transaction's posting. Present only when the counterparty account is a program DDA; null when the counterparty is a GL account, or until the transaction posts.

Pattern: ^core_transaction_.+~\d+$
Example:

"core_transaction_xyz123"

currency_code
enum<string>
required

A three-letter currency code as defined in ISO 4217.

Available options:
USD
Example:

"USD"

amount
integer<int64>
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.

Example:

1500

amount_breakdown
object
required

A breakdown of amount into its principal, interest, and fee components. The three values must sum to amount.

effective_at
string<date-time>
required

An RFC 3339 timestamp representing when the transaction is effective.

Example:

"2026-09-30T00:00:00Z"

metadata
object
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.

Example:

"2026-09-30T11:01:36Z"

updated_at
string<date-time>
required

An ISO-8601 timestamp at which the User Credit Transaction was last updated.

Example:

"2026-09-30T11:05:00Z"

description
string

A client-provided description of the transaction.

Maximum string length: 120
Example:

"Monthly card fee"

amount_in_usd
integer<int64>

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.

Example:

1500

details
object

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.

funding_id
string

The ID of the associated Funding object. Present when type is funding.

Pattern: ^funding_\w+$
Example:

"funding_123"

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.

Pattern: ^user_credit_transaction_\w+$
Example:

"user_credit_transaction_abc789"