Checkout supports the buyer's shopping journey — starting and decisioning a financing application, returning personalized payment agreement options, completing checkout in-store or online, and issuing virtual cards into Apple Pay or Google Pay wallets. 18 operations.
BreadPay Checkout API is one of 13 APIs that Bread Financial publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Installment Financing, Checkout, Payments, BNPL, and Virtual Card. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
18 operations
across 17 paths,
organized into 2 resource areas,
and defines 68 schemas.
It is described by OpenAPI 3.0.3, at version 2.0.0.
Requests are made against 2 base URLs: https://api-preview.platform.breadpayments.com/, https://api.platform.breadpayments.com/.
18 operations17 paths68 schemas9 GET9 POST
Metadata
The identity and technical contract details declared by the specification.
BreadPay Checkout API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuthApplication).
It accepts HTTP bearer tokens (JWT) (bearerAuthVirtualCard).
bearerAuthApplication — The scoped JWT provided by the Auth service.
bearerAuthVirtualCard — The JWT access token provided by the Auth service.
Paths & Operations 18
Across 17 paths, the API surfaces 18 operations — 9 GET, 9 POST. They span 2 resource areas: Application, Virtual Card. Each is listed below with its method, path, parameters, and response codes.
The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are Application (26 properties), TxnAuth (15 properties), OrderItem (15 properties), Offer (11 properties). Each schema is shown below with its type and property counts.
Extension
object
An array of optional key-value pairs.
2 properties
Disclosure
object
A representation of a Disclosure for which the Buyer must provide consent.
3 properties2 required
OrderItem
object
An item that the Buyer wants to purchase with a Bread product.
15 properties5 required
Order
object
The collection of items that the Buyer wants to purchase with a Bread product.
9 properties5 required
Application
object
The Application for a given Buyer with Payment Agreement(s), if any.
26 properties11 required
ApplicationError
object
Default error model for application errors
ShortCode
object
The Short Code for a given Buyer with Payment Agreement(s), for an in-store application.
2 properties
ClientInfo
array
Generic client information for use in backend services
Metadata
array
Generic metadata information for use in backend services
Offer
object
The Offer being presented to the Buyer
11 properties3 required
Status
string
ServiceType
string
OfferPaymentAgreement
object
8 properties
TxnAuth
object
The Transaction Authorization for a given Application, if any.
15 properties9 required
VirtualCardError
object
Represents an error returned by virtualcard service.
1 property
IssuanceResponse
object
Information on the current issuance.
5 properties1 required
Issuance
object
Issuance data
9 properties4 required
Card
object
Card information
10 properties2 required
Wallet
object
Wallet information
8 properties5 required
Summary
object
Total authorized/settled/refunded transactions.
3 properties3 required
CardTransaction
object
Transaction type and token
5 properties4 required
ApplePay
object
ApplePay wallet information
1 property1 required
GooglePay
object
GooglePay wallet information
2 properties2 required
InStoreIssuance
object
Issuance data required for creating a virtual card
5 properties1 required
IssueVirtualCardRequest
object
Issuance data required for creating a virtual card
5 properties4 required
IssueApplePayRequest
object
ApplePay issuance request
IssueGooglePayRequest
object
GooglePay issuance request
7 properties7 required
UpdateCardStatusRequest
object
Update issuance status request
1 property1 required
WalletIssuanceResponse
object
Response from a digital wallet issuance request.
2 properties
ScopeType
string
Scope type of the issuance.
IssuanceStatus
string
Provisioning status of the issuance. REQUESTED represents a requested but not yet issued card. PROCESSING represents a provisioning issuance. ISSUED represents…
CardStatus
string
Provisioning status of a virtual card. ACTIVE represents a provisioned card. FAILED represents a card that failed provisioning. SUSPENDED represents a suspende…
WalletStatus
string
Provisioning status of a digital wallet token. PROVISIONING represents a digital wallet token in the process of provisioning. ACTIVE represents a successfully…
WalletType
string
Type of wallet.
ApplePayJws
object
4 properties4 required
CardEvents
object
List of events that have occurred on the card
1 property1 required
CardEvent
object
Transaction event that has occurred for the specific card
5 properties3 required
TransactionDataList
object
List of transaction data that has occurred on the card
1 property1 required
TransactionData
object
Card Acceptor data from the transaction
10 properties3 required
CountryCode
string
The two character ISO-3166-1 country code.
Region
string
The region or first-level administration division (e.g. State/Province) of the address.
CurrencyCode
string
The three letter currency code as defined in ISO 4217.
LanguageCode
string
The two language code as defined in ISO 639-1 along with subtags tag if applicable.
Money
object
Represents a monetary amount in the specified currency
2 properties2 required
Phone
string
Telephone number including country code
Email
string
Email address
Percentage
number
Percentage value
BasisPoint
integer
A value which represents one-hundredth of one percent.
Date
string
The date value formatted per RFC3339. This does not allow nulls.
NullDate
string
The date value formatted per RFC3339. This allows nulls.
Timestamp
string
The timestamp value formatted per RFC3339. This does not allow nulls.
NullTimestamp
string
The timestamp value formatted per RFC3339. This does allow nulls.
UUID
string
A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.
NullUUID
string
A universally unique identifier (Version 4) as defined in RFC4122. This allows nulls.
Address
object
Represents a fully defined address for an entity
6 properties5 required
Name
object
Represents the full name
3 properties2 required
Contact
object
Represents contact information for an entity
4 properties1 required
BankAccountDetail
object
Bank account detail definition
6 properties4 required
BusinessIdentity
object
Identity for a business
2 properties2 required
PersonIdentity
object
Identity for a person
2 properties2 required
BankIdentifier
object
2 properties2 required
PaymentProductType
string
The type of payment product
TermInterval
string
Defines set of valid term intervals for a payment product
Terms
object
Represents the terms offered for a payment product
4 properties4 required
AsLowAs
object
Represents a sample offer with the appropriate user prompts for a given amount and apr along with apr bounds
6 properties6 required
Identity
object
The claims that determines the access level of the caller.
5 properties1 required
Error
object
1 property4 required
BaseError
object
4 properties3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of BreadPay Checkout API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
