Complete Checkout for Instore Application

post https://api-preview.platform.breadpayments.com/api/application/instore/{shortcode}/checkout

Allows a Buyer to submit a generated short code in order to complete a Transaction and checkout with a Merchant.

Upon success, the updated Application details will be returned. Possible Application statuses include CANCELLED and CHECKOUT_COMPLETED. Any of these statuses will result in a 200 OK response - the client must check the status field in the response body.

In the event that the BuyerHash Check fails when attempting to complete a checkout for an Instore Application, the application will be marked with status CANCELLED and statusCode 010101.

Upon completed checkout, a Transaction record is generated for the Merchant and the Buyer's Checkout is now complete.

Responses

Response body

object

uuid

required

Unique identifier of the Application.

buyerID

uuid

required

Unique identifier of the Buyer.

tenantID

uuid

required

Unique identifier of the Tenant.

merchantID

uuid

required

Unique identifier of the Merchant.

programID

uuid

required

Unique identifier of the Program.

paymentMethodID

uuid

If exists, unique identifier of the payment method for an application.

locationID

uuid

Unique identifier of the Location for instore applications.

cartID

uuid

Unique identifier of the Cart for applications associated with a Cart

billingContact

object

Represents contact information for an entity

name

object

required

Represents the full name

phone

string

Telephone number including country code

address

object

Represents a fully defined address for an entity

string

Email address

shippingContact

object

Represents contact information for an entity

name

object

required

Represents the full name

phone

string

Telephone number including country code

address

object

Represents a fully defined address for an entity

string

Email address

order

object

required

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

paymentAgreements

array of objects

The list of Payment Agreements associated with the Application.

paymentAgreements

object

uuid

Unique identifier of the Payment Agreement that was created during Start.

paymentProductID

uuid

Unique identifier of the Payment Product.

status

string

The Status of the Payment Agreement.

OFFERED ACCEPTED EXPIRED REVIEW OUTSTANDING PAID CHARGED_OFF CANCELLED CLOSED

statusCodes

array of strings

List of numerical status codes that provide more information on the reason for the Payment Agreement status.

statusCodes

capacity

object

Represents a monetary amount in the specified currency

overflowCapacity

object

Represents a monetary amount in the specified currency

shortCode

object

The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.

paymentAmount

object

Represents a monetary amount in the specified currency

terms

object

Represents the terms offered for a payment product

createdAt

date-time

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

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.

offers

array of objects

required

The list of Offers associated with the Application.

offers*

object

uuid

required

Unique identifier of the Offer.

paymentMethodID

uuid

Unique identifier of the Payment Method.

paymentProduct

object

required

The Payment Product of the Offer

status

string

The status of the Offer.

APPROVED ATTEMPTED_CHECKOUT ATTEMPTED_PREPARE_CHECKOUT CANCELLED CHECKOUT_COMPLETED CHECKOUT_PREPARED DENIED EXPIRED INELIGIBLE NEEDS_ACTION STARTED

statusCodes

array of strings

List of numerical Status Codes that provide more information on the reason for the Payment Agreement status.

statusCodes

capacity

object

required

Represents a monetary amount in the specified currency

overflowCapacity

object

Represents a monetary amount in the specified currency

paymentAgreement

object

The Payment Agreement associated with the Offer.

shortCode

object

The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.

createdAt

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.

capacity

object

deprecated

Deprecated: Capacity is assigned per individual offer for the corresponding payment product. Use offer capacity instead.

currency

string

required

length between 3 and 3

The three letter currency code as defined in ISO 4217.

value

int64

required

Monetary value as an integral number of the currency fractional unit e.g for USD: cents

status

string

required

The status of the Application after running Start/Checkout.

APPROVED ATTEMPTED_CHECKOUT ATTEMPTED_PREPARE_CHECKOUT CANCELLED CHECKOUT_COMPLETED CHECKOUT_PREPARED DENIED EXPIRED INELIGIBLE NEEDS_ACTION STARTED

statusCodes

array of strings

required

List of numerical status codes that provide more information on the reason for the Application status.

statusCodes*

disclosures

array of objects

The list of Disclosures the Buyer provided consent for on the Application.

disclosures

object

type

string

required

The type of Disclosure that the Buyer is providing consent to. Certain types of disclosures are required during Start/Checkout based on Tenant, Merchant, Program and Payment Product configurations.

acceptedAt

date-time

required

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

checksum

string

The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.

transactionID

uuid

Unique identifier of the merchant Transaction that was created during Checkout. This field will only be present when the Application is in CHECKOUT_COMPLETED status.

retargetingURL

string

Indicates the URL for retargeting.

createdAt

date-time

required

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

expiresAt

date-time

required

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

updatedAt

date-time

required

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

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-preview.platform.breadpayments.com/api/application/instore/shortcode/checkout \
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

200The Application as a response.

400Error response for application errors

401Unauthorized. Indicates that provided credentials is not valid

403Forbidden. Indicates that request cannot be authorized

404Error response for application errors

422Error response for application errors

500Error response for application errors

503Error response for application errors