Transactions

The Transaction Object

The transaction object represents successful checkouts with Bread. The API allows you to query, authorize, settle, cancel, or refund a transaction.

{
  "billingContact": {
    "fullName": "Emily Blunt",
    "address": "39 W 14th St.",
    "address2": "403",
    "city": "New York",
    "state": "NY",
    "zip": "10010",
    "phone": "5552342602",
    "email": "[email protected]"
  },
  "breadTransactionId": "addfa809-f4d5-4540-8902-0da4e3fd53c0",
  "merchantOrderId": "",
  "createdAt": "2016-10-13T18:00:00.000000Z",
  "lineItems": [{
    "sku": "TEST001",
    "quantity": 1,
    "price": 50000,
    "product": {
      "name": "Test Item",
      "sku": "TEST001",
      "imageUrl": "http://placehold.it/350x150",
      "detailUrl": "http://placehold.it/350x150"
    }
  }],
  "shippingContact": {
    "fullName": "Emily Blunt",
    "address": "39 W 14th St.",
    "address2": "403",
    "city": "New York",
    "state": "NY",
    "zip": "10010",
    "phone": "5552342602"
  },
  "shippingCost": 1500,
  "shippingMethodCode": "FEDEX_OVERNIGHT",
  "trackingNumber": "ABCDEF1234",
  "carrierName": "USPS",
  "discounts": [],
  "status": "PENDING",
  "total": 50000,
  "adjustedTotal": 50000,
  "totalTax": null
}

Attribute	Type	Parent Attribute	Description
breadTransactionId	string	-	Unique identifier used to reference the transaction in the Bread systems. When you make API calls on a transaction this is the transaction id to use.
billingContact	object	-	Billing contact information associated with the transaction
address	string	billingContact	Billing address line 1
address2	string	billingContact	Billing address line 2 (i.e apartment number)
fullName	string	billingContact	First and last name
phone	string	billingContact	Phone number. 10 numeric characters
zip	string	billingContact	Zipcode. 5 character US zip code
createdAt	timestamp	-
lineItems	array	-	List of line item details, including id, product(s), price, and quantity
price	integer	lineItems	Price of the item in cents
product	array	lineItems	Product object with properties of detailUrl, imageUrl, name, and sku. All properties are strings
quantity	integer	lineItems	Number of items for this product
sku	string	lineItems	The identifier of the product in your system
merchantOrderId	string	-	Unique identifier to tie to an order in your order management/ecommerce platform – set this via an API call
shippingContact	object	-	Shipping contact information associated with the transaction
address	string	shippingContact	Shipping address line 1
address2	string	shippingContact	Shipping address line 2 (i.e apartment number)
fullName	string	shippingContact	First and last name
phone	string	shippingContact	Phone number. 10 numeric characters
zip	string	shippingContact	Zipcode. 5 digit US zipcode
shippingCost	integer	-	A value representing the cost of shipping in cents
shippingMethodCode	string	-	Code used to identity the type of shipping in your system, ie “FEDEX_OVERNIGHT”
status	string	-	The current status of the transaction. All transactions start in the PENDING state. Other valid states are CANCELED, REFUNDED, EXPIRED, AUTHORIZED, SETTLED.
total	integer	-	The completed total of the transaction in cents.
adjustedTotal	integer	-	The current total of the transaction after applying any actions such as cancellations or refunds. Value in cents.
totalTax	integer	-	Tax total of the transaction in cents
trackingNumber	string	-	Shipping carrier tracking number
carrierName	string	-	Shipping carrier name
discounts	array	-	A list of discount objects which were applied to the order
amount	integer	discounts	The value in cents of the discount
description	string	discounts	A description of the discount