Card Transaction
Card transaction event object
The card transaction event object represents a specific event within the lifecycle of a card transaction (e.g., authorization, clear, refund).
Object Parameters
amounts
objectThe amounts associated with the event
cardholder_authorized
objectThe amount authorized and being held in the cardholder's currency
amount
numberThe amount in the smallest unit of the currency
currency_code
stringThe currency code (e.g., USD)
fx_rate
stringThe foreign exchange rate (if applicable), serialized as a decimal string
cardholder_requested
objectThe amount requested by the merchant in the cardholder's currency
amount
numberThe amount in the smallest unit of the currency
currency_code
stringThe currency code (e.g., USD)
fx_rate
stringThe foreign exchange rate (if applicable), serialized as a decimal string
cardholder_settled
objectThe amount settled in the cardholder's currency
amount
numberThe amount in the smallest unit of the currency
currency_code
stringThe currency code (e.g., USD)
fx_rate
stringThe foreign exchange rate (if applicable), serialized as a decimal string
merchant_authorized
objectThe amount authorized and being held in the merchant's currency
amount
numberThe amount in the smallest unit of the currency
currency_code
stringThe currency code (e.g., USD)
fx_rate
stringThe foreign exchange rate (if applicable), serialized as a decimal string
merchant_requested
objectThe amount requested by the merchant in the merchant's currency
amount
numberThe amount in the smallest unit of the currency
currency_code
stringThe currency code (e.g., USD)
fx_rate
stringThe foreign exchange rate (if applicable), serialized as a decimal string
merchant_settled
objectThe amount settled in the merchant's currency
amount
numberThe amount in the smallest unit of the currency
currency_code
stringThe currency code (e.g., USD)
fx_rate
stringThe foreign exchange rate (if applicable), serialized as a decimal string
authentication_attempt_id
stringThe authentication attempt ID
authorization_expires_at
date-timeThe authorization expiration date
card_account_id
stringThe ID of the card account
card_id
stringThe ID of the card
card_program_id
stringThe ID of the card program
card_token_id
stringThe card token used for this transaction event, if applicable.
created_at
date-timeThe creation date of the card transaction event
decisioning_details
objectAuthorization decisioning details
auth_code
stringThe authorization code
card_authorization_policy_decision
enumThe aggregate authorization policy decision. Possible values: passed, failed, skipped
card_authorization_policy_decision_reason
stringThe reason the aggregate authorization policy decision was made. Only set when the policy decision is failed
card_authorization_policy_evaluations
array of objectsPer-policy evaluation results showing the outcome of each authorization policy
card_authorization_policy_id
stringThe ID of the card authorization policy
card_authorization_policy_version_id
stringThe ID of the card authorization policy version
decision
enumThe policy evaluation decision. Possible values: passed, failed, skipped
decision_reason
stringThe reason the policy failed. Only set when decision is failed
owner
enumThe owner of the policy. Possible values: column, platform_owner
scope
enumThe scope of the policy. Possible values: card_program, card_account, card
decision
enumThe authorization decision. Possible values: undecided, approved, partially_approved, declined
decision_reason
enumThe reason the decision was made
Possible values: approved, partially_approved, insufficient_funds, suspected_fraud, realtime_authorization_request_timeout, realtime_authorization_connection_error, realtime_authorization_invalid_response, manual_override, generic_decline, error, realtime_authorization_endpoint_missing, invalid_transaction, account_closed, account_blocked, card_lost, card_stolen, card_expired, invalid_merchant, exceeds_approval_amount_limit, invalid_verification_code, invalid_cvv, invalid_cvv2, missing_or_invalid_pin, account_verification_succeeded, account_verification_and_anticipated_amount_succeeded, account_verification_succeeded_unsupported_amount, stop_payment, invalid_account_type_savings, invalid_account_type_checking, invalid_account_type_credit, three_ds_authentication_required, invalid_expiration, compliance_decline, card_paused, pin_cryptographic_error, invalid_amount, pending
decision_source
enumThe party that made the authorization decision. Possible values: card_network, column, platform_owner
realtime_authorization_amount
numberThe amount returned by the platform's realtime authorization endpoint, in the smallest unit of the currency
realtime_authorization_decision
stringThe decision returned by the platform's realtime authorization endpoint. Possible values: approve, partially_approve, decline
realtime_authorization_decision_reason
stringThe decline reason returned by the platform's realtime authorization endpoint
event_type
enumThe type of the card transaction event. Possible values: financial, financial_reversal, authorization, authorization_reversal, authorization_expiration, authorization_completion, incremental_authorization, incremental_authorization_reversal, reauthorization, reauthorization_reversal, refund_authorization, refund_authorization_reversal, refund_financial, refund_financial_reversal, clear, clear_reversal, credit_clear, credit_clear_reversal, credit_applied, force_clear, force_clear_reversal, account_verification, original_credit, original_credit_reversal, balance_inquiry, dispute_credit, dispute_credit_reversal, dispute_debit, dispute_debit_reversal, credit_applied_reversal
id
stringThe ID of the card transaction event