Sign in

v2

latestOpenAPI 3.0.02026-07-3139594346.4 KB
Transactions

Refund a Transaction

This refunds a captured transaction. Refunds can be done for any partial amount or for the total authorized amount. These refunds are processed synchronously and return information about the refunded transaction in the standard transaction_view object.

post/v1/merchant/transactions/credit

Headers

Idempotency-Keystring

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

Request body

amountinteger required

The amount in cents. Nullable for Transactions Details.

currencystring required

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

merchant_event_idstring

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.

skip_hook_notificationboolean

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

transaction_referencestring required

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

Example request

{
  "amount": 754,
  "currency": "USD",
  "merchant_event_id": "dbe0cd5d-3261-41d9-ba61-49e5b9d07567",
  "transaction_reference": "LBLJ-TWW7-R9VC"
}

Response

Refund Successful

dateinteger

Transaction date. Nullable for Transactions Details.

idstring

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

indemnification_decision'unknown' | 'indemnified' | 'not_indemnified'

Describes whether the transaction is indemnified by Bolt for fraud.

indemnification_reason'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'

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

last4string

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

last_viewed_utcnumber
merchant_order_numberstring
processor'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'

The processor used. Nullable for Transactions Details.

referencestring

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

risk_review_status'unknown' | 'needs_review' | 'reviewed'

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

risk_scoreinteger
status'in_progress' | 'completed' | 'cancelled' | 'failed' | 'pending' | 'created' | 'authorized' | 'rejected_reversible' | 'rejected_irreversible'

The transaction's status.

transaction_propertiesobject
type'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'

The type of transaction.

view_status'not_viewed' | 'viewed' | 'viewing'

Example response

{
  "amount": {
    "amount": 754,
    "currency": "USD",
    "currency_symbol": "$"
  },
  "authorization": {
    "merchant_event_id": "dbe0cd5d-3261-41d9-ba61-49e5b9d07567",
    "status": "succeeded"
  },
  "capture": {
    "amount": {
      "amount": 754,
      "currency": "USD",
      "currency_symbol": "$"
    },
    "id": "BcDE4fafd2a4",
    "merchant_event_id": "dbe0cd5d-3261-41d9-ba61-49e5b9d07567",
    "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",
      "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",
    "last_name": "Watts",
    "emails": [
      {
        "priority": "primary"
      }
    ],
    "phones": [
      {
        "country_code": "US"
      }
    ]
  },
  "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",
      "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",
  "merchant_division": {
    "merchant_password_login_url": "https://www.example.com/login"
  },
  "processor": "adyen_gateway",
  "reference": "LBLJ-TWW7-R9VC",
  "risk_review_status": "reviewed",
  "splits": [
    {
      "amount": {
        "amount": 754,
        "currency": "USD",
        "currency_symbol": "$"
      }
    }
  ],
  "status": "cancelled",
  "to_consumer": {
    "first_name": "Alan",
    "last_name": "Watts",
    "emails": [
      {
        "priority": "primary"
      }
    ],
    "phones": [
      {
        "country_code": "US"
      }
    ]
  },
  "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",
      "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"
  },
  "type": "cc_payment",
  "void": {
    "merchant_event_id": "dbe0cd5d-3261-41d9-ba61-49e5b9d07567",
    "status": "succeeded",
    "void": "123456"
  }
}