Create a Cart

post https://api-preview.platform.breadpayments.com/api/cart

Create a Cart using a JSON body. Returns a response that includes the URL to checkout, the time at which the Cart was created, and the expiration time. Carts will automatically expire after a default time of 7 days and will be deleted automatically after a default time of 30 days.

Body Params

Payload that is sent to the Cart service to create a Cart

callbackUrl

uri

Where we'll POST the transactionID of the checkout and the orderRef following a successful checkout.

checkoutCompleteUrl

uri

URL that the customer is redirected to following a successful checkout

checkoutErrorUrl

uri

URL the user is redirected to if checkout fails

isHipaaRestricted

boolean

orderReference

string

Unique identifier provided by the merchant. Appended to the CheckoutCompleteURL after a Cart is complete.

expiresAt

date-time

The timestamp value formatted per RFC3339. This does not allow nulls.

updatedAt

date-time

The timestamp value formatted per RFC3339. This does not allow nulls.

createdAt

date-time

The timestamp value formatted per RFC3339. This does not allow nulls.

merchantID

uuid

required

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

programID

uuid

required

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

contact

object

Represents buyer information that is associated with the Cart object

order

object

The collection of items that the Buyer wants to purchase with a Bread product.

disclosures

array of objects

required

disclosures*

Responses

Response body

object

string

CartID associated with a Cart

checkoutCompleteUrl

uri

URL that the customer is redirected to following a successful checkout

callbackUrl

uri

Where we'll POST the transactionID of the checkout and the orderRef following a successful checkout.

checkoutErrorUrl

uri

URL the user is redirected to if checkout fails

checkoutUrl

uri

URL to Checkout using the associated Cart

expiresAt

date-time

The timestamp value formatted per RFC3339. This does not allow nulls.

merchantID

uuid

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

programID

uuid

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

status

string

The current status of the Cart. Generated when returning a Cart object.

ACTIVE NOTIFIED VISITED EXPIRED DELETED COMPLETED

orderReference

string

Unique identifier provided by the merchant. Appended to the CheckoutCompleteURL after a Cart is complete.

contact

object

Represents buyer information that is associated with the Cart object

name

object

required

Represents the full name

phone

string

required

Telephone number including country code

shippingAddress

object

required

Represents a fully defined address for an entity

billingAddress

object

Represents a fully defined address for an entity

string

required

Email address

order

object

The collection of items that the Buyer wants to purchase with a Bread product.

subTotal

object

required

Represents a monetary amount in the specified currency

totalDiscounts

object

required

Represents a monetary amount in the specified currency

totalPrice

object

required

Represents a monetary amount in the specified currency

totalShipping

object

required

Represents a monetary amount in the specified currency

totalTax

object

required

Represents a monetary amount in the specified currency

discountCode

string

Discount code applied to this Order.

pickupInformation

object

Pickup information describes a person and store location for pickup.

fulfillmentType

string

The fulfillment type of the order.

PICKUP DELIVERY MULTIPLE

items

array of objects

The list of items to be purchased in this Order.

items

object

name

string

required

The name of the item to be purchased.

category

string

The category of the product under which the item is listed.

quantity

integer

required

The number of items to be purchased. The value must be greater than 0.

unitPrice

object

required

Represents a monetary amount in the specified currency

unitTax

object

required

Represents a monetary amount in the specified currency

sku

string

The unique SKU number of the item.

itemUrl

string

The URL for referencing further details about the item.

imageUrl

string

The URL for the item image.

description

string

A longer description of the item.

shippingCost

object

required

Represents a monetary amount in the specified currency

shippingProvider

string

The provider that will be used to ship the item.

shippingDescription

string

The description of the shipping method (e.g. standard, express).

shippingTrackingNumber

string

The tracking number that is provided by a shipping provider.

shippingTrackingUrl

string

The URL for referencing further details about the shipping.

fulfillmentType

string

The fulfillment type of the order item.

PICKUP DELIVERY

disclosures

array of objects

disclosures

object

name

string

A symbol identifying a disclosure document type

acceptedAt

date-time

The timestamp value formatted per RFC3339. This does not allow nulls.

asLowAs

object

Represents a sample offer with the appropriate user prompts for a given amount and apr along with apr bounds

terms

object

required

Represents the terms offered for a payment product

paymentAmount

object

required

Represents a monetary amount in the specified currency

minRate

float

required

The minimum interest rate that may be offered

maxRate

float

required

The maximum interest rate that may be offered

promptText

object

required

The financing disclosure text that can be provided to the buyer in the appropriate language

Has additional fields

paymentAmountText

object

required

The payment amount with the appropriate formatting

Has additional fields

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-preview.platform.breadpayments.com/api/cart \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

201Returns a Cart object

401Unauthorized. Indicates that provided credentials is not valid

403Forbidden. Indicates that request cannot be authorized

500Default error response for any errors in the API