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
}
AttributeTypeParent AttributeDescription
breadTransactionIdstring-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.
billingContactobject-Billing contact information associated with the transaction
addressstringbillingContactBilling address line 1
address2stringbillingContactBilling address line 2 (i.e apartment number)
fullNamestringbillingContactFirst and last name
phonestringbillingContactPhone number. 10 numeric characters
zipstringbillingContactZipcode. 5 character US zip code
createdAttimestamp-
lineItemsarray-List of line item details, including id, product(s), price, and quantity
priceintegerlineItemsPrice of the item in cents
productarraylineItemsProduct object with properties of detailUrl, imageUrl, name, and sku. All properties are strings
quantityintegerlineItemsNumber of items for this product
skustringlineItemsThe identifier of the product in your system
merchantOrderIdstring-Unique identifier to tie to an order in your order management/ecommerce platform – set this via an API call
shippingContactobject-Shipping contact information associated with the transaction
addressstringshippingContactShipping address line 1
address2stringshippingContactShipping address line 2 (i.e apartment number)
fullNamestringshippingContactFirst and last name
phonestringshippingContactPhone number. 10 numeric characters
zipstringshippingContactZipcode. 5 digit US zipcode
shippingCostinteger-A value representing the cost of shipping in cents
shippingMethodCodestring-Code used to identity the type of shipping in your system, ie “FEDEX_OVERNIGHT”
statusstring-The current status of the transaction. All transactions start in the PENDING state. Other valid states are CANCELED, REFUNDED, EXPIRED, AUTHORIZED, SETTLED.
totalinteger-The completed total of the transaction in cents.
adjustedTotalinteger-The current total of the transaction after applying any actions such as cancellations or refunds. Value in cents.
totalTaxinteger-Tax total of the transaction in cents
trackingNumberstring-Shipping carrier tracking number
carrierNamestring-Shipping carrier name
discountsarray-A list of discount objects which were applied to the order
amountintegerdiscountsThe value in cents of the discount
descriptionstringdiscountsA description of the discount