POST
/
v1
/
merchant
/
transactions
/
credit
Refund a Transaction
curl --request POST \
  --url https://api.bolt.com/v1/merchant/transactions/credit \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "amount": 754,
  "currency": "USD",
  "transaction_reference": "LBLJ-TWW7-R9VC",
  "merchant_event_id": "dbe0cd5d-3261-41d9-ba61-49e5b9d07567",
  "skip_hook_notification": false
}
'
{
  "amount": {
    "amount": 754,
    "currency": "USD",
    "currency_symbol": "$"
  },
  "authorization": {
    "auth": "<string>",
    "merchant_event_id": "dbe0cd5d-3261-41d9-ba61-49e5b9d07567",
    "metadata": {},
    "status": "succeeded"
  },
  "capture": {
    "amount": {
      "amount": 754,
      "currency": "USD",
      "currency_symbol": "$"
    },
    "id": "BcDE4fafd2a4",
    "merchant_event_id": "dbe0cd5d-3261-41d9-ba61-49e5b9d07567",
    "metadata": {},
    "splits": [
      {
        "amount": {
          "amount": 754,
          "currency": "USD",
          "currency_symbol": "$"
        },
        "type": "processing_fee"
      }
    ],
    "status": "succeeded"
  },
  "captures": [
    {
      "amount": {
        "amount": 754,
        "currency": "USD",
        "currency_symbol": "$"
      },
      "id": "BcDE4fafd2a4",
      "merchant_event_id": "dbe0cd5d-3261-41d9-ba61-49e5b9d07567",
      "metadata": {},
      "splits": {
        "amount": {
          "amount": 754,
          "currency": "USD",
          "currency_symbol": "$"
        }
      },
      "status": "succeeded"
    }
  ],
  "credit": {
    "status": "succeeded",
    "merchant_event_id": "dbe0cd5d-3261-41d9-ba61-49e5b9d07567"
  },
  "date": 1615407159447,
  "from_consumer": {
    "first_name": "Alan",
    "id": "<string>",
    "last_name": "Watts",
    "authentication": {
      "actions": [],
      "methods": [],
      "sso_authorization_url": "<string>"
    },
    "email_verified": true,
    "emails": [
      {
        "address": "<string>",
        "id": "<string>",
        "priority": "primary",
        "status": "<string>"
      }
    ],
    "phones": [
      {
        "country_code": "US",
        "id": "<string>",
        "number": "<string>",
        "status": "<string>"
      }
    ]
  },
  "from_credit_card": {
    "billing_address": {
      "company": "Bolt",
      "country": "United States",
      "country_code": "US",
      "door_code": "123456",
      "email_address": "alan.watts@example.com",
      "first_name": "Alan",
      "id": "<string>",
      "last_name": "Watts",
      "locality": "Brooklyn",
      "name": "Alan Watts",
      "phone_number": "+12125550199",
      "postal_code": "10044",
      "priority": "primary",
      "region": "NY",
      "region_code": "NY",
      "street_address1": "888 main street",
      "street_address2": "apt 3021",
      "street_address3": "c/o Alicia Watts",
      "street_address4": "Bridge Street Apartment Building B"
    },
    "bin": "402201",
    "display_network": "Visa",
    "expiration": 1654041600000,
    "icon_asset_path": "img/issuer-logos/visa.png",
    "id": "AB3rJKam5DhYE",
    "last4": "4021",
    "network": "visa",
    "priority": "primary",
    "status": "active",
    "token": "a1B2c3D4e5F6G7H8i9J0k1L2m3N4o5P6Q7r8S9t0",
    "token_type": "bolt"
  },
  "id": "T1c3p4yBuVYJ9",
  "indemnification_decision": "indemnified",
  "indemnification_reason": "merchant_force_approved",
  "last4": "4021",
  "last_viewed_utc": 123,
  "merchant_division": {
    "account_page_url": "<string>",
    "api_base_domain_url": "<string>",
    "base_domain_url": "<string>",
    "confirmation_redirect_url": "<string>",
    "create_order_url": "<string>",
    "debug_url": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "get_account_url": "<string>",
    "shopper_custom_fields_updated_url": "<string>",
    "hook_url": "<string>",
    "id": "<string>",
    "is_universal_merchant_api": true,
    "is_webhooks_v2": true,
    "logo": {
      "domain": "<string>",
      "resource": "<string>"
    },
    "logo_dashboard": {
      "domain": "<string>",
      "resource": "<string>"
    },
    "merchant_id": "<string>",
    "mobile_app_domain_url": "<string>",
    "oauth_logout_url": "<string>",
    "oauth_redirect_url": "<string>",
    "platform": "<string>",
    "plugin_config_url": "<string>",
    "privacy_policy_url": "<string>",
    "product_info_url": "<string>",
    "public_id": "<string>",
    "remote_apiurl": "<string>",
    "shipping_and_tax_url": "<string>",
    "shipping_url": "<string>",
    "status": "<string>",
    "tax_url": "<string>",
    "terms_of_service_url": "<string>",
    "universal_merchant_api_url": "<string>",
    "update_cart_url": "<string>",
    "use_async_refunds_amazon_pay": true,
    "use_async_refunds_paypal": true,
    "validate_additional_account_data_url": "<string>",
    "merchant_password_login_url": "https://www.example.com/login"
  },
  "merchant_order_number": "<string>",
  "order_decision": {
    "decision_factors": [
      "<string>"
    ],
    "score": 123
  },
  "processor": "adyen_gateway",
  "reference": "LBLJ-TWW7-R9VC",
  "review_ticket": {
    "id": "<string>",
    "request_deadline": 123,
    "status": "<string>"
  },
  "risk_insights": {
    "available": true,
    "decision_factors": [
      "<string>"
    ],
    "fraud_probability": 123,
    "payment_instrument_factors": {}
  },
  "risk_review_status": "reviewed",
  "risk_score": 123,
  "splits": [
    {
      "amount": {
        "amount": 754,
        "currency": "USD",
        "currency_symbol": "$"
      }
    }
  ],
  "status": "cancelled",
  "to_consumer": {
    "first_name": "Alan",
    "id": "<string>",
    "last_name": "Watts",
    "authentication": {
      "actions": [],
      "methods": [],
      "sso_authorization_url": "<string>"
    },
    "email_verified": true,
    "emails": [
      {
        "address": "<string>",
        "id": "<string>",
        "priority": "primary",
        "status": "<string>"
      }
    ],
    "phones": [
      {
        "country_code": "US",
        "id": "<string>",
        "number": "<string>",
        "status": "<string>"
      }
    ]
  },
  "to_credit_card": {
    "billing_address": {
      "company": "Bolt",
      "country": "United States",
      "country_code": "US",
      "door_code": "123456",
      "email_address": "alan.watts@example.com",
      "first_name": "Alan",
      "id": "<string>",
      "last_name": "Watts",
      "locality": "Brooklyn",
      "name": "Alan Watts",
      "phone_number": "+12125550199",
      "postal_code": "10044",
      "priority": "primary",
      "region": "NY",
      "region_code": "NY",
      "street_address1": "888 main street",
      "street_address2": "apt 3021",
      "street_address3": "c/o Alicia Watts",
      "street_address4": "Bridge Street Apartment Building B"
    },
    "bin": "402201",
    "display_network": "Visa",
    "expiration": 1654041600000,
    "icon_asset_path": "img/issuer-logos/visa.png",
    "id": "AB3rJKam5DhYE",
    "last4": "4021",
    "network": "visa",
    "priority": "primary",
    "status": "active",
    "token": "a1B2c3D4e5F6G7H8i9J0k1L2m3N4o5P6Q7r8S9t0",
    "token_type": "bolt"
  },
  "transaction_properties": {},
  "type": "cc_payment",
  "void": {
    "merchant_event_id": "dbe0cd5d-3261-41d9-ba61-49e5b9d07567",
    "status": "succeeded",
    "void": "123456"
  }
}

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.

Body

application/json

Refund a Transaction

​
amount
integer
required

The amount in cents. Nullable for Transactions Details.

Example:

754

​
currency
string
required

The 3-digit ISO code for the currency. Nullable for Transactions Details.

Example:

"USD"

​
transaction_reference
string
required

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

Required string length: 12
Example:

"LBLJ-TWW7-R9VC"

​
merchant_event_id
string

The reference ID associated with a transaction event (auth, capture, refund, void). This is an arbitrary identifier created by the merchant. Bolt does not enforce any uniqueness constraints on this ID. It is up to the merchant to generate identifiers that properly fulfill its needs.

Example:

"dbe0cd5d-3261-41d9-ba61-49e5b9d07567"

​
skip_hook_notification
boolean

Set to true to skip receiving a webhook notification from Bolt that is triggered by this update to the transaction.

Example:

false

Response

Refund Successful

​
amount
object
​
authorization
object
​
capture
object

Deprecated. Use captures.

​
captures
object[]
​
credit
object
​
date
integer

Transaction date. Nullable for Transactions Details.

Example:

1615407159447

​
from_consumer
object
​
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"

​
last4
string

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

Required string length: 4
Example:

"4021"

​
last_viewed_utc
number<int64>
​
merchant_division
object
​
merchant_order_number
string
​
order_decision
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"

​
review_ticket
object
​
risk_insights
object
​
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<int64>
​
splits
object[]
​
status
enum<string>

The transaction's status.

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

"cancelled"

​
to_consumer
object
​
to_credit_card
object

Contains details about the credit card transaction.

​
transaction_properties
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"

​
void
object
​
view_status
enum<string>
Available options:
not_viewed,
viewed,
viewing