v2
latestOpenAPI 3.0.02026-07-3139594346.4 KBTransactions
Authorize a Card
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.
post/v1/merchant/transactions/authorize
Headers
X-Publishable-Keystring
The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].
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
Example request
{
"cart": {
"billing_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"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"
},
"discounts": [
{
"amount": 100,
"code": "SUMMER10DISCOUNT",
"description": "10% off our summer collection",
"details_url": "https://boltswagstore.com/SUMMERSALE",
"reference": "DISC-1234",
"type": "percentage"
}
],
"fees": [
{
"reference": "ItemFee",
"name": "Item Fee",
"description": "Item Fee"
}
],
"fulfillments": [
{
"cart_items": [
{
"brand": "Bolt",
"category": "bags",
"collections": [
"summer"
],
"color": "Bolt Blue",
"customizations": [
{
"attributes": {
"key1": "value1",
"key2": "value2"
},
"price": 754
}
],
"description": "Large tote with Bolt logo.",
"details_url": "https://boltswagstore.com/products/123456",
"gift_option": {
"cost": 770,
"merchant_product_id": "881",
"message": "Happy Anniversary, Smoochy Poo!"
},
"image_url": "https://boltswagstore.com/products/123456/images/1.png",
"isbn": "9780091347314",
"manufacturer": "Bolt Textiles USA",
"merchant_product_id": "881",
"merchant_variant_id": "888",
"name": "Bolt Swag Bag",
"options": "Special Edition",
"quantity": 1,
"reference": "item_100",
"shipment": {
"carrier": "FedEx",
"cost": 770,
"estimated_delivery_date": "08-30-2022",
"package_depth": 90,
"package_dimension_unit": "cm",
"package_height": 103,
"package_type": "A big package.",
"package_weight_unit": "kg",
"package_width": 222,
"service": "Option 1",
"shipping_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"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"
},
"shipping_address_id": "address1",
"shipping_method": "unknown",
"signature": "a1B2s3dC4f5g5D6hj6E7k8F9l0",
"tax_amount": 230,
"tax_code": "tax-12345",
"total_weight": 55,
"total_weight_unit": "kg",
"type": "door_delivery"
},
"size": "Large",
"sku": "BOLT-SKU_100",
"seller_id": "seller-1234",
"tags": "tote, blue, linen, eco-friendly",
"total_amount": 1000,
"unit_price": 1000,
"uom": "inches",
"upc": "0825764603119",
"weight": 10,
"weight_unit": "pounds"
}
],
"cart_shipment": {
"carrier": "FedEx",
"cost": 770,
"estimated_delivery_date": "08-30-2022",
"package_depth": 90,
"package_dimension_unit": "cm",
"package_height": 103,
"package_type": "A big package.",
"package_weight_unit": "kg",
"package_width": 222,
"service": "Option 1",
"shipping_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"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"
},
"shipping_address_id": "address1",
"shipping_method": "unknown",
"signature": "a1B2s3dC4f5g5D6hj6E7k8F9l0",
"tax_amount": 230,
"tax_code": "tax-12345",
"total_weight": 55,
"total_weight_unit": "kg",
"type": "door_delivery"
},
"in_store_cart_shipment": {
"cart_shipment": {
"carrier": "FedEx",
"cost": 770,
"estimated_delivery_date": "08-30-2022",
"package_depth": 90,
"package_dimension_unit": "cm",
"package_height": 103,
"package_type": "A big package.",
"package_weight_unit": "kg",
"package_width": 222,
"service": "Option 1",
"shipping_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"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"
},
"shipping_address_id": "address1",
"shipping_method": "unknown",
"signature": "a1B2s3dC4f5g5D6hj6E7k8F9l0",
"tax_amount": 230,
"tax_code": "tax-12345",
"total_weight": 55,
"total_weight_unit": "kg",
"type": "door_delivery"
},
"description": "Pick up in-store at 123 Main St.",
"distance": 3,
"distance_unit": "mile",
"in_store_pickup_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"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"
},
"store_name": "Bolt Collective"
}
}
],
"in_store_cart_shipments": [
{
"cart_shipment": {
"carrier": "FedEx",
"cost": 770,
"estimated_delivery_date": "08-30-2022",
"package_depth": 90,
"package_dimension_unit": "cm",
"package_height": 103,
"package_type": "A big package.",
"package_weight_unit": "kg",
"package_width": 222,
"service": "Option 1",
"shipping_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"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"
},
"shipping_address_id": "address1",
"shipping_method": "unknown",
"signature": "a1B2s3dC4f5g5D6hj6E7k8F9l0",
"tax_amount": 230,
"tax_code": "tax-12345",
"total_weight": 55,
"total_weight_unit": "kg",
"type": "door_delivery"
},
"description": "Pick up in-store at 123 Main St.",
"distance": 3,
"distance_unit": "mile",
"in_store_pickup_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"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"
},
"store_name": "Bolt Collective"
}
],
"items": [
{
"brand": "Bolt",
"category": "bags",
"collections": [
"summer"
],
"color": "Bolt Blue",
"customizations": [
{
"attributes": {
"key1": "value1",
"key2": "value2"
},
"price": 754
}
],
"description": "Large tote with Bolt logo.",
"details_url": "https://boltswagstore.com/products/123456",
"gift_option": {
"cost": 770,
"merchant_product_id": "881",
"message": "Happy Anniversary, Smoochy Poo!"
},
"image_url": "https://boltswagstore.com/products/123456/images/1.png",
"isbn": "9780091347314",
"manufacturer": "Bolt Textiles USA",
"merchant_product_id": "881",
"merchant_variant_id": "888",
"name": "Bolt Swag Bag",
"options": "Special Edition",
"quantity": 1,
"reference": "item_100",
"shipment": {
"carrier": "FedEx",
"cost": 770,
"estimated_delivery_date": "08-30-2022",
"package_depth": 90,
"package_dimension_unit": "cm",
"package_height": 103,
"package_type": "A big package.",
"package_weight_unit": "kg",
"package_width": 222,
"service": "Option 1",
"shipping_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"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"
},
"shipping_address_id": "address1",
"shipping_method": "unknown",
"signature": "a1B2s3dC4f5g5D6hj6E7k8F9l0",
"tax_amount": 230,
"tax_code": "tax-12345",
"total_weight": 55,
"total_weight_unit": "kg",
"type": "door_delivery"
},
"size": "Large",
"sku": "BOLT-SKU_100",
"seller_id": "seller-1234",
"tags": "tote, blue, linen, eco-friendly",
"total_amount": 1000,
"unit_price": 1000,
"uom": "inches",
"upc": "0825764603119",
"weight": 10,
"weight_unit": "pounds"
}
],
"loyalty_rewards": [
{
"description": "$5 off (100 Points)",
"details": "{\"id\": 123456, \"icon\": \"fa-dollar\", \"name\": \"$15.00 Off\", \"type\": \"Coupon\", \"amount\": 100, \"duration\": \"single_use\", \"cost_text\": \"150 Points\", \"description\": \"Get $15 off your next purchase for 150 points\", \"discount_type\": \"fixed_amount\", \"unrendered_name\": \"$15.00 Off\", \"discount_percentage\": null, \"discount_rate_cents\": null, \"discount_value_cents\": null, \"discount_amount_cents\": 1500, \"unrendered_description\": \"Get $15 off your next purchase for 150 points\", \"applies_to_product_type\": \"ALL\"}"
}
],
"shipments": [
{
"carrier": "FedEx",
"cost": 770,
"estimated_delivery_date": "08-30-2022",
"package_depth": 90,
"package_dimension_unit": "cm",
"package_height": 103,
"package_type": "A big package.",
"package_weight_unit": "kg",
"package_width": 222,
"service": "Option 1",
"shipping_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"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"
},
"shipping_address_id": "address1",
"shipping_method": "unknown",
"signature": "a1B2s3dC4f5g5D6hj6E7k8F9l0",
"tax_amount": 230,
"tax_code": "tax-12345",
"total_weight": 55,
"total_weight_unit": "kg",
"type": "door_delivery"
}
],
"total_amount": 900,
"cart_url": "https://boltswagstore.com/orders/123456765432",
"currency": "USD",
"display_id": "displayid_100",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"order_description": "Order #1234567890",
"order_reference": "order_100"
},
"credit_card": {
"billing_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"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": "411111",
"expiration": "2025-11",
"last4": "1234",
"postal_code": "10044",
"token": "a1B2c3D4e5F6G7H8i9J0k1L2m3N4o5P6Q7r8S9t0",
"token_type": "bolt",
"affirm_vcn_token": "a1B2c3D4e5F6G7H8i9J0k1L2m3N4o5P6Q7r8S9t0"
},
"division_id": "3X9aPQ67-YrB",
"merchant_event_id": "dbe0cd5d-3261-41d9-ba61-49e5b9d07567",
"shipping_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"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"
},
"user_identifier": {
"email": "alan.watts@example.com",
"phone": "+12125550199"
},
"user_identity": {
"first_name": "Charlotte",
"last_name": "Charles"
}
}Response
Authorization Successful
Example response
{
"transaction": {
"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"
}
}
}