Application

The Application for a given Buyer with Payment Agreement(s), if any.

JSON

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "buyerID": "79138d13-785c-4040-bee6-64ea21f400b0",
  "tenantID": "f95ac700-4c8f-4a38-a8d1-1582733edd5b",
  "merchantID": "c30c8496-c2db-425f-8614-0e5f16767e31",
  "programID": "bc47d2e1-8006-4433-9336-16527618d7b1",
  "paymentMethodID": "b7a60692-ab86-4eb0-b961-3bb4a714aa42",
  "locationID": "1a421e47-94cf-4960-8d28-b125a9b84600",
  "cartID": "a974b3dc-486d-41d4-8e3e-69e560693147",
  "billingContact": {
    "name": {
      "givenName": "John",
      "familyName": "Doe",
      "additionalName": "string"
    },
    "phone": "[phone]",
    "address": {
      "address1": "156 5th Avenue",
      "address2": "string",
      "locality": "New York",
      "postalCode": "10019",
      "region": "US-NY",
      "country": "US"
    },
    "email": "[e-mail]"
  },
  "shippingContact": {
    "name": {
      "givenName": "John",
      "familyName": "Doe",
      "additionalName": "string"
    },
    "phone": "[phone]",
    "address": {
      "address1": "156 5th Avenue",
      "address2": "string",
      "locality": "New York",
      "postalCode": "10019",
      "region": "US-NY",
      "country": "US"
    },
    "email": "[e-mail]"
  },
  "order": {
    "subTotal": {
      "currency": "USD",
      "value": 50000
    },
    "totalDiscounts": {
      "currency": "USD",
      "value": 50000
    },
    "totalPrice": {
      "currency": "USD",
      "value": 50000
    },
    "totalShipping": {
      "currency": "USD",
      "value": 50000
    },
    "totalTax": {
      "currency": "USD",
      "value": 50000
    },
    "discountCode": "string",
    "pickupInformation": {
      "name": {
        "givenName": "John",
        "familyName": "Doe",
        "additionalName": "string"
      },
      "phone": "[phone]",
      "address": {
        "address1": "156 5th Avenue",
        "address2": "string",
        "locality": "New York",
        "postalCode": "10019",
        "region": "US-NY",
        "country": "US"
      },
      "email": "[e-mail]"
    },
    "fulfillmentType": "",
    "items": [
      {
        "name": "Noise Cancelling Headphones Q30",
        "category": "Headphones",
        "quantity": 2,
        "unitPrice": {
          "currency": "USD",
          "value": 50000
        },
        "unitTax": {
          "currency": "USD",
          "value": 50000
        },
        "sku": "string",
        "itemUrl": "string",
        "imageUrl": "string",
        "description": "string",
        "shippingCost": {
          "currency": "USD",
          "value": 50000
        },
        "shippingProvider": "string",
        "shippingDescription": "string",
        "shippingTrackingNumber": "string",
        "shippingTrackingUrl": "string",
        "fulfillmentType": ""
      }
    ]
  },
  "paymentAgreements": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "paymentProductID": "70ceb6c4-ceb7-41f8-8790-0dc87d8e1223",
      "status": "OFFERED",
      "statusCodes": [
        "100101"
      ],
      "capacity": {
        "currency": "USD",
        "value": 50000
      },
      "overflowCapacity": {
        "currency": "USD",
        "value": 50000
      },
      "shortCode": {
        "value": "string",
        "expiresAt": "2020-12-31T15:10:55Z"
      },
      "paymentAmount": {
        "currency": "USD",
        "value": 50000
      },
      "terms": {
        "amount": {
          "currency": "USD",
          "value": 50000
        },
        "interval": "BIWEEKLY",
        "length": 12,
        "rate": 5.75
      },
      "createdAt": "2020-12-31T15:10:55Z",
      "expiresAt": "2020-12-31T15:10:55Z",
      "updatedAt": "2020-12-31T15:10:55Z"
    }
  ],
  "offers": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "paymentMethodID": "b7a60692-ab86-4eb0-b961-3bb4a714aa42",
      "paymentProduct": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "type": "INSTALLMENTS"
      },
      "status": "APPROVED",
      "statusCodes": [
        "100101"
      ],
      "capacity": {
        "currency": "USD",
        "value": 50000
      },
      "overflowCapacity": {
        "currency": "USD",
        "value": 50000
      },
      "paymentAgreement": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "status": "ACCEPTED",
        "terms": {
          "interval": "BIWEEKLY",
          "length": 12,
          "rate": 5.75,
          "originalPrincipal": {
            "currency": "USD",
            "value": 50000
          },
          "adjustedPrincipal": {
            "currency": "USD",
            "value": 50000
          },
          "balanceDueAtMaturity": {
            "currency": "USD",
            "value": 50000
          }
        },
        "paymentAmount": {
          "currency": "USD",
          "value": 50000
        },
        "balanceSummary": {
          "totalInterestEstimate": {
            "currency": "USD",
            "value": 50000
          }
        },
        "createdAt": "2020-12-31T15:10:55Z",
        "expiresAt": "2020-12-31T15:10:55Z",
        "updatedAt": "2020-12-31T15:10:55Z"
      },
      "shortCode": {
        "value": "string",
        "expiresAt": "2020-12-31T15:10:55Z"
      },
      "createdAt": "2020-12-31T15:10:55Z",
      "updatedAt": "2020-12-31T15:10:55Z"
    }
  ],
  "capacity": {
    "value": 200000,
    "currency": "USD"
  },
  "status": "APPROVED",
  "statusCodes": [
    "100101"
  ],
  "disclosures": [
    {
      "type": "loan-agreement",
      "acceptedAt": "2020-12-31T15:10:55Z",
      "checksum": "95d2094b-b462-49b9-8e9e-8d3b79e22a42:aL6RastfmNl8Z/6EdSWlBg=="
    }
  ],
  "transactionID": "757f874e-e934-4bb8-bf5c-073c384eeee6",
  "retargetingURL": "https://www.breadfinancial.com/",
  "createdAt": "2020-12-31T15:10:55Z",
  "expiresAt": "2020-12-31T15:10:55Z",
  "updatedAt": "2020-12-31T15:10:55Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	true	none	Unique identifier of the Application.
buyerID	string(uuid)	true	none	Unique identifier of the Buyer.
tenantID	string(uuid)	true	none	Unique identifier of the Tenant.
merchantID	string(uuid)	true	none	Unique identifier of the Merchant.
programID	string(uuid)	true	none	Unique identifier of the Program.
paymentMethodID	string(uuid)	false	none	If exists, unique identifier of the payment method for an application.
locationID	string(uuid)	false	none	Unique identifier of the Location for instore applications.
cartID	string(uuid)	false	none	Unique identifier of the Cart for applications associated with a Cart
billingContact	object	false	none	Represents contact information for an entity
➥ name	object	true	none	Represents the full name
➥➥ givenName	string	true	none	Given name
➥➥ familyName	string	true	none	Family name
➥➥ additionalName	string	false	none	Additional name, if any
➥ phone	string	false	none	Telephone number including country code
➥ address	object	false	none	Represents a fully defined address for an entity
➥➥ address1	string	true	none	First address line
➥➥ address2	string	false	none	Second address line
➥➥ locality	string	true	none	The locality (e.g. City) of the address.
➥➥ postalCode	string	true	none	The administrative postal code (e.g. Zip Code)
➥➥ region	string	true	none	The region or first-level administration division (e.g. State/Province) of the address.
➥➥ country	string	true	none	The two character ISO-3166-1 country code.
➥ email	string(email)	false	none	Email address
shippingContact	object	false	none	Represents contact information for an entity
➥ name	object	true	none	Represents the full name
➥➥ givenName	string	true	none	Given name
➥➥ familyName	string	true	none	Family name
➥➥ additionalName	string	false	none	Additional name, if any
➥ phone	string	false	none	Telephone number including country code
➥ address	object	false	none	Represents a fully defined address for an entity
➥➥ address1	string	true	none	First address line
➥➥ address2	string	false	none	Second address line
➥➥ locality	string	true	none	The locality (e.g. City) of the address.
➥➥ postalCode	string	true	none	The administrative postal code (e.g. Zip Code)
➥➥ region	string	true	none	The region or first-level administration division (e.g. State/Province) of the address.
➥➥ country	string	true	none	The two character ISO-3166-1 country code.
➥ email	string(email)	false	none	Email address
order	object	true	none	The collection of items that the Buyer wants to purchase with a Bread product.
➥ subTotal	object	true	none	The total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.
➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥ totalDiscounts	object	true	none	The total price of discounts applied to this Order. The value must be greater than or equal to 0.
➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥ totalPrice	object	true	none	The total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.
➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥ totalShipping	object	true	none	The total shipping costs for this Order. The value must be greater than or equal to 0.
➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥ totalTax	object	true	none	The total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.
➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥ discountCode	string	false	none	Discount code applied to this Order.
➥ pickupInformation	object	false	none	Pickup information describes a person and store location for pickup.
➥➥ name	object	true	none	Represents the full name
➥➥➥ givenName	string	true	none	Given name
➥➥➥ familyName	string	true	none	Family name
➥➥➥ additionalName	string	false	none	Additional name, if any
➥➥ phone	string	false	none	Telephone number including country code
➥➥ address	object	true	none	Represents a fully defined address for an entity
➥➥➥ address1	string	true	none	First address line
➥➥➥ address2	string	false	none	Second address line
➥➥➥ locality	string	true	none	The locality (e.g. City) of the address.
➥➥➥ postalCode	string	true	none	The administrative postal code (e.g. Zip Code)
➥➥➥ region	string	true	none	The region or first-level administration division (e.g. State/Province) of the address.
➥➥➥ country	string	true	none	The two character ISO-3166-1 country code.
➥➥ email	string(email)	false	none	Email address
➥ fulfillmentType	string	false	none	The fulfillment type of the order.
➥ items	[object]	false	none	The list of items to be purchased in this Order.
➥➥ Order Item	object	false	none	An item that the Buyer wants to purchase with a Bread product.
➥➥➥ name	string	true	none	The name of the item to be purchased.
➥➥➥ category	string	false	none	The category of the product under which the item is listed.
➥➥➥ quantity	integer	true	none	The number of items to be purchased. The value must be greater than 0.
➥➥➥ unitPrice	object	true	none	The price per unit of item. The value must be greater than or equal to 0.
➥➥➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥➥➥ unitTax	object	true	none	The tax per unit of item. The value must be greater than or equal to 0.
➥➥➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥➥➥ sku	string	false	none	The unique SKU number of the item.
➥➥➥ itemUrl	string	false	none	The URL for referencing further details about the item.
➥➥➥ imageUrl	string	false	none	The URL for the item image.
➥➥➥ description	string	false	none	A longer description of the item.
➥➥➥ shippingCost	object	true	none	The cost of shipping all units of this item. The value must be greater than or equal to 0.
➥➥➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥➥➥ shippingProvider	string	false	none	The provider that will be used to ship the item.
➥➥➥ shippingDescription	string	false	none	The description of the shipping method (e.g. standard, express).
➥➥➥ shippingTrackingNumber	string	false	none	The tracking number that is provided by a shipping provider.
➥➥➥ shippingTrackingUrl	string	false	none	The URL for referencing further details about the shipping.
➥➥➥ fulfillmentType	string	false	none	The fulfillment type of the order item.
paymentAgreements	[object]	false	none	The list of Payment Agreements associated with the Application.
➥ id	string(uuid)	false	none	Unique identifier of the Payment Agreement that was created during Start.
➥ paymentProductID	string(uuid)	false	none	Unique identifier of the Payment Product.
➥ status	string	false	none	The Status of the Payment Agreement.
➥ statusCodes	[string]	false	none	List of numerical status codes that provide more information on the reason for the Payment Agreement status.
➥ capacity	object	false	none	The capacity of the Payment Agreement.
➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥ overflowCapacity	object	false	none	The max amount that the cart size can exceed the Payment Agreement's Capacity.
➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥ shortCode	object	false	none	The short code of the Payment Agreement, for in-store application.
➥➥ value	string	false	none	A six digit alphanumeric case insensitive value.
➥➥ expiresAt	string(date-time)	false	none	The date-time in UTC this Short Code expires at, represented as RFC3339 format.
➥ paymentAmount	object	false	none	The cost of each payment, calculated using the terms.
➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥ terms	object	false	none	The terms of the Payment Agreement.
➥➥ amount	object	true	none	The total amount for the term
➥➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥➥ interval	string	true	none	The payment interval for the term
➥➥ length	integer(int64)	true	none	Length of the term
➥➥ rate	number(float)	true	none	The interest rate for the term
➥ createdAt	string(date-time)	false	none	The date-time in UTC this Payment Agreement was created, represented as RFC3339 format.
➥ expiresAt	string(date-time)	false	none	The date-time in UTC this Payment Agreement expires at, represented as RFC3339 format.
➥ updatedAt	string(date-time)	false	none	The date-time in UTC this Payment Agreement was updated, represented as RFC3339 format.
offers	[object]	true	none	The list of Offers associated with the Application.
➥ Offer	object	false	none	The Offer being presented to the Buyer
➥➥ id	string(uuid)	true	none	Unique identifier of the Offer.
➥➥ paymentMethodID	string(uuid)	false	none	Unique identifier of the Payment Method.
➥➥ paymentProduct	object	true	none	The Payment Product of the Offer
➥➥➥ id	string(uuid)	true	none	Unique identifier of the Payment Product.
➥➥➥ type	string	true	none	none
➥➥ status	string	false	none	The status of the Offer.
➥➥ statusCodes	[string]	false	none	List of numerical Status Codes that provide more information on the reason for the Payment Agreement status.
➥➥ capacity	object	true	none	The Capacity of the Offer.
➥➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥➥ overflowCapacity	object	false	none	The max amount that the cart size can exceed the Offer's Capacity.
➥➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥➥ paymentAgreement	object	false	none	The Payment Agreement associated with the Offer.
➥➥➥ id	string(uuid)	false	none	Unique identifier of the Offer Payment Agreement.
➥➥➥ status	string	false	none	none
➥➥➥ terms	object	false	none	The Terms of the Payment Agreement
➥➥➥➥ interval	string	false	none	The Payment Interval for the Term
➥➥➥➥ length	integer(int64)	false	none	Length of the Term
➥➥➥➥ rate	number(float)	false	none	The Interest Rate for the Term
➥➥➥➥ originalPrincipal	object	false	none	The Original Principal amount for the Payment Agreement.
➥➥➥➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥➥➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥➥➥➥ adjustedPrincipal	object	false	none	The Adjusted Principal amount for the Payment Agreement.
➥➥➥➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥➥➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥➥➥➥ balanceDueAtMaturity	object	false	none	The Balance Due at Maturity for the Payment Agreement.
➥➥➥➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥➥➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥➥➥ paymentAmount	object	false	none	The Payment Amount due each Interval for the Offer.
➥➥➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥➥➥ balanceSummary	object	false	none	The Balance Summary of the Offer
➥➥➥➥ totalInterestEstimate	object	false	none	The Total Estimated Interest for this Offer
➥➥➥➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥➥➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
➥➥➥ createdAt	string(date-time)	false	none	The date-time in UTC this Offer Payment Agreement was created, represented as RFC3339 format.
➥➥➥ expiresAt	string(date-time)	false	none	The date-time in UTC this Offer Payment Agreement expires at, represented as RFC3339 format.
➥➥➥ updatedAt	string(date-time)	false	none	The date-time in UTC this Offer Payment Agreement was updated, represented as RFC3339 format.
➥➥ shortCode	object	false	none	The Short Code of the Offer, for in-store Application.
➥➥➥ value	string	false	none	A six digit alphanumeric case insensitive value.
➥➥➥ expiresAt	string(date-time)	false	none	The date-time in UTC this Short Code expires at, represented as RFC3339 format.
➥➥ createdAt	string(date-time)	false	none	The date-time in UTC this Offer was created, represented as RFC3339 format.
➥➥ updatedAt	string(date-time)	false	none	The date-time in UTC this Offer was updated, represented as RFC3339 format.
capacity	any	false	none	Deprecated - capacity is assigned per individual offer for the corresponding payment product.

Name	Type	Required	Restrictions	Description
➥ anonymous	object	false	none	Represents a monetary amount in the specified currency
➥➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents

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

Name	Type	Required	Restrictions	Description
status	string	true	none	The status of the Application after running Start/Checkout.
statusCodes	[string]	true	none	List of numerical status codes that provide more information on the reason for the Application status.
disclosures	[object]	false	none	The list of Disclosures the Buyer provided consent for on the Application.
➥ Disclosure	object	false	none	A representation of a Disclosure for which the Buyer must provide consent.
➥➥ type	string	true	none	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	string(date-time)	true	none	The date-time in UTC when the Buyer provided consent, represented as RFC3339 format. The value must be in the past.
➥➥ checksum	string	false	none	The value returned in the X-Bread-Checksum header of the Get Disclosure response. Certain types of disclosures will require a checksum.
transactionID	string(uuid)	false	none	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	false	none	Indicates the URL for retargeting.
createdAt	string(date-time)	true	none	The date-time in UTC this Application was created, represented as RFC3339 format.
expiresAt	string(date-time)	true	none	The date-time in UTC this Application expires at, represented as RFC3339 format.
updatedAt	string(date-time)	true	none	The date-time in UTC this Application was updated, represented as RFC3339 format.

Enumerated Values

Value
PICKUP
DELIVERY
MULTIPLE
PICKUP
DELIVERY
OFFERED
ACCEPTED
EXPIRED
REVIEW
OUTSTANDING
PAID
CHARGED_OFF
CANCELLED
CLOSED
BIWEEKLY
MONTHLY
INSTALLMENTS
SPLITPAY
DEBT_CONSOLIDATION
PERSONAL_LOAN
APPROVED
ATTEMPTED_CHECKOUT
ATTEMPTED_PREPARE_CHECKOUT
CANCELLED
CHECKOUT_COMPLETED
CHECKOUT_PREPARED
DENIED
EXPIRED
INELIGIBLE
NEEDS_ACTION
STARTED
ACCEPTED
CANCELLED
CHARGED_OFF
CLOSED
EXPIRED
OFFERED
OUTSTANDING
PAID
REVIEW
BIWEEKLY
MONTHLY
APPROVED
ATTEMPTED_CHECKOUT
ATTEMPTED_PREPARE_CHECKOUT
CANCELLED
CHECKOUT_COMPLETED
CHECKOUT_PREPARED
DENIED
EXPIRED
INELIGIBLE
NEEDS_ACTION
STARTED