PATCH
Update a Transaction

Authorizations

X-API-Key
string
header
required

Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard.

Headers

Idempotency-Key
string

A key created by merchants that ensures POST and PATCH requests are only performed once. Read more about Idempotent Requests here.

Path Parameters

REFERENCE
string
required

This is the Bolt transaction reference. (ex. N7Y3-NFKC-VFRF)

Body

application/json

Update a Transaction

display_id
string

This field corresponds to the merchant's order reference associated with this Bolt transaction.

Example:

"order-123"

metadata
object

Custom metadata associated with this Bolt transaction.

Example:

Response

Transaction Details Retrieved

address_change_request_metadata
object
adjust_transactions
object[]

Nullable for Transactions Details.

amount
object
auth_verification_status
enum<string>

Used to track the status of micro-authorizations. Nullable for Transactions Details.

Available options:
new,
verified,
failed,
expired
Example:

"new"

authorization
object
authorization_id
string

The authorization's id.

Example:

"T1c3p4yBuVYJ9"

capture
object

Deprecated. Use captures.

captures
object[]

All captures associated with the transaction. Nullable for Transactions Details.

chargeback_details
object
credit
object
custom_fields
object
customer_list_status
object
date
integer

Transaction date. Nullable for Transactions Details.

Example:

1615407159447

from_consumer
object

The credit card user.

from_consumer_membership_users
object

Nullable for Transactions Details.

from_credit_card
object

Contains details about the credit card transaction.

id
string

The unique ID associated with the transaction. Nullable for Transactions Details.

Example:

"T1c3p4yBuVYJ9"

indemnification_decision
enum<string>

Describes whether the transaction is indemnified by Bolt for fraud.

Available options:
unknown,
indemnified,
not_indemnified
Example:

"indemnified"

indemnification_reason
enum<string>

Describes the reason that the transaction is or is not indemnified by Bolt for fraud.

Available options:
unknown,
checkout,
virtual_terminal,
merchant_back_office,
merchant_force_approved,
reversibly_rejected,
irreversibly_rejected,
risk_engine_approved,
analyst_approved,
auth_verification,
paypal,
afterpay,
direct_payments,
whitelist,
external_review,
affirm,
merchant_ip_address,
amazon_pay,
apple_pay,
phone_order,
klarna,
cardholder_authentication,
address_change_rejected,
indemnify_direct_payments,
indemnify_virtual_terminal,
membership_subscription,
embedded_guest_checkout,
risk_assessment_only,
sezzle,
credova,
subscription,
indemnify_apm_transaction
Example:

"merchant_force_approved"

last_viewed_utc
integer

The last view time as UTC.

Example:

1485997169003

last4
string

The card's last 4 digits. Nullable for Transactions Details.

Required string length: 4
Example:

"4021"

manual_disputes
object
merchant
object
merchant_division
object
merchant_order_number
string

The merchant's internal order number for this transaction.

Example:

"O-1234567"

order
object
order_decision
object

Decision and score for an order.

platform_metadata
object
processor
enum<string>

The processor used. Nullable for Transactions Details.

Available options:
adyen_gateway,
adyen_payfac,
affirm,
afterpay,
alliance_data,
amazon_pay,
authorize_net,
braintree,
checkout_com,
cybersource,
first_data,
klarna,
nmi,
orbital,
paypal,
radial,
radial_klarna,
radial_paypal,
rocketgate,
sezzle,
shopify_payments,
stripe,
vantiv
Example:

"adyen_gateway"

reference
string

The transaction's 12-digit Bolt reference ID. Nullable for Transactions Details.

Required string length: 12
Example:

"LBLJ-TWW7-R9VC"

refund_transaction_ids
string[]

Nullable for Transactions Details.

The unique ID associated with the transaction. Nullable for Transactions Details.

refund_transactions
object[]

Nullable for Transactions Details.

refunded_amount
object
review_ticket
object

Internal use only.

risk_insights
object

Displays fraud decisioning insights based on key factors. This information can either be forwarded via a risk_insights transaction webhook type or be polled by sending a GET request to Bolt's transactions endpoint.

risk_review_status
enum<string>

Describes the current Risk Review status. A transaction could be unreviewed, reviewed, or pending manual review by the Bolt team.

Available options:
unknown,
needs_review,
reviewed
Example:

"reviewed"

risk_score
integer
source_transaction
object
splits
object[]

A list of splits. Nullable for Transactions Details.

status
enum<string>

The transaction's status.

Available options:
in_progress,
completed,
cancelled,
failed,
pending,
created,
authorized,
rejected_reversible,
rejected_irreversible
Example:

"cancelled"

timeline
object
to_consumer
object
to_credit_card
object

Contains details about the credit card transaction.

transaction_properties
object
transaction_rejection_details
object
type
enum<string>

The type of transaction.

Available options:
cc_payment,
cc_credit,
funding_transfer,
processing_fee_transfer,
reserve_transfer,
float_transfer,
merchant_credit,
merchant_debit,
funding_withdrawal,
processing_fee_withdrawal,
zero_amount,
bolt_fee_transfer,
bolt_fee_withdrawal,
bank_account_verification,
authorization_verification,
paypal_payment,
paypal_refund,
apm_payment,
apm_refund,
zero_amount_verification
Example:

"cc_payment"

view_status
string
void
object
void_cause
string