Capture a Transaction
This captures funds for the designated transaction. A capture can be done for any partial amount or for the total authorized amount.
Although the response returns the standard transaction_view object, only captures and either id or reference are needed.
Authorization
X-API-Key X-API-Key<token>
Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard.
In: header
Header Parameters
Idempotency-Key?string
A key created by merchants that ensures POST and PATCH requests are only performed once. Read more about Idempotent Requests here.
Request Body
application/json
Capture a Transaction
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/merchant/transactions/capture" \ -H "Content-Type: application/json" \ -d '{ "amount": 754, "currency": "USD", "transaction_reference": "LBLJ-TWW7-R9VC" }'{ "amount": { "amount": 754, "currency": "USD", "currency_symbol": "$" }, "authorization": { "auth": "string", "avs_response": "00", "cvv_response": "M", "merchant_event_id": "dbe0cd5d-3261-41d9-ba61-49e5b9d07567", "metadata": { "property1": "string", "property2": "string" }, "processor": "vantiv", "reason": "none", "status": "succeeded" }, "capture": { "amount": { "amount": 754, "currency": "USD", "currency_symbol": "$" }, "id": "BcDE4fafd2a4", "merchant_event_id": "dbe0cd5d-3261-41d9-ba61-49e5b9d07567", "metadata": { "property1": "string", "property2": "string" }, "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": { "property1": { "key1": "value1", "key2": "value2" }, "property2": { "key1": "value1", "key2": "value2" } }, "splits": { "amount": { "amount": 754, "currency": "USD", "currency_symbol": "$" }, "type": "net" }, "status": "succeeded" } ], "credit": { "status": "succeeded", "merchant_event_id": "dbe0cd5d-3261-41d9-ba61-49e5b9d07567" }, "date": 1615407159447, "from_consumer": { "authentication": { "actions": [ "set_password" ], "methods": [ "code" ], "sso_authorization_url": "string" }, "email_verified": true, "emails": [ { "address": "string", "id": "string", "priority": "primary", "status": "string" } ], "first_name": "string", "id": "string", "last_name": "string", "phones": [ { "country_code": "US", "id": "string", "number": "string", "priority": "primary", "status": "string" } ], "platform_account_status": "none" }, "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": 0, "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_type": "1", "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": 0 }, "processor": "adyen_gateway", "reference": "LBLJ-TWW7-R9VC", "review_ticket": { "id": "string", "request_deadline": 0, "status": "string" }, "risk_insights": { "available": true, "decision_factors": [ "string" ], "fraud_probability": 0, "payment_instrument_factors": { "property1": { "factor1": "factor1", "factor2": "factor2" }, "property2": { "factor1": "factor1", "factor2": "factor2" } } }, "risk_review_status": "reviewed", "risk_score": 0, "splits": [ { "amount": { "amount": 754, "currency": "USD", "currency_symbol": "$" }, "type": "net" } ], "status": "cancelled", "to_consumer": { "authentication": { "actions": [ "set_password" ], "methods": [ "code" ], "sso_authorization_url": "string" }, "email_verified": true, "emails": [ { "address": "string", "id": "string", "priority": "primary", "status": "string" } ], "first_name": "string", "id": "string", "last_name": "string", "phones": [ { "country_code": "US", "id": "string", "number": "string", "priority": "primary", "status": "string" } ], "platform_account_status": "none" }, "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": { "property1": { "key1": "value1", "key2": "value2" }, "property2": { "key1": "value1", "key2": "value2" } }, "type": "cc_payment", "void": { "cause": "merchant_action", "merchant_event_id": "dbe0cd5d-3261-41d9-ba61-49e5b9d07567", "status": "succeeded", "void": "123456" }, "view_status": "not_viewed"}Authorize a Card POST
This endpoint authorizes card payments and has three main use cases: * • Authorize a payment using an unsaved payment method for a guest or logged-in shopper. * • Authorize a payment using a saved payment method for a logged-in shopper. * • Re-charge a previous transaction using the `credit_card_id` of the transaction.
Refund a Transaction POST
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.