How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Bread Financial

BreadPay Tradein API

Streamlines the upgrade / trade-in flow for the Apple program — upgrade elections, trade-in payments, and linking an upgradeable loan to a payment agreement. 6 operations.

Documentation Provider Profile APIs.io OpenAPI GitHub

BreadPay Tradein 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 Trade-In, Upgrade, and Apple Program. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 5 paths, and defines 38 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/.

6 operations 5 paths 38 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0.0
Base URL
https://api.platform.breadpayments.com
Authentication
HTTP Bearer
Contact
partnership-growth@getbread.com
Resource Areas
1

Authentication & Security 1

BreadPay Tradein API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuthTradein).

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Tradein 6
POST
/api/tradein/upgrade-election
Records user tradein election
tradeinUpgradeElection body → 200401403500
POST
/api/tradein/payment
Applies a payment to an existing loan as part of the tradein process
tradeinPayment body → 200401403500
GET
/api/tradein/upgradeable-loan/payment-agreement/{paymentAgreementId}
Retrieves the UpgradeableLoan entity related to a payment agreement
getUpgradeableLoanByPaymentAgreementId 1 param → 200401403500
POST
/api/tradein/payment-agreement/link-payment-agreement
Links a buyers old and new loan
tradeinLinkPaymentAgreement body → 200400401403500
GET
/api/tradein/upgradeable-loan/{id}
Retrieves the UpgradeableLoan entity by its own id
getUpgradeableLoanById 1 param → 200401403500
POST
/api/tradein/upgradeable-loan/{id}
Creates an Upgradeable loan based on the given payment agreement ID
createUpgradeableLoan 1 param → 200401403500

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are UpgradeableLoanEntity (21 properties), Address (6 properties), BankAccountDetail (6 properties), AsLowAs (6 properties). Each schema is shown below with its type and property counts.

UpgradeElectionRequest
object
Tradein UpgradeElection request
4 properties 3 required
LinkedPaymentAgreementRequest
object
Tradein LinkedPaymentAgreement request
3 properties 3 required
TradeinErrorResponse
TradeinErrorReason
string
Payment agreement retrieval error reason codes
PaymentLoanResponse
object
1 property 1 required
UpgradeableLoanEntity
object
21 properties 21 required
ElectionEntity
object
an object representing a election tied to an UpgradeableLoan entity
3 properties 3 required
LinkedPaymentAgreementEntity
object
an object representing two payment agreements to link
1 property 1 required
PaymentRequest
object
Tradein Payment request
4 properties 4 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 properties 2 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 properties 5 required
Name
object
Represents the full name
3 properties 2 required
Contact
object
Represents contact information for an entity
4 properties 1 required
BankAccountDetail
object
Bank account detail definition
6 properties 4 required
BusinessIdentity
object
Identity for a business
2 properties 2 required
PersonIdentity
object
Identity for a person
2 properties 2 required
BankIdentifier
object
2 properties 2 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 properties 4 required
AsLowAs
object
Represents a sample offer with the appropriate user prompts for a given amount and apr along with apr bounds
6 properties 6 required
Identity
object
The claims that determines the access level of the caller.
5 properties 1 required
Error
object
1 property 4 required
BaseError
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bread-tradein-openapi.json Raw ↑

Other APIs Bread Financial publishes across the network.

BreadPay Platform API
AE Profile APIs.io
Bread Pay API
AE Profile APIs.io
Bread SplitPay API
AE Profile APIs.io
BreadPay Checkout API
AE Profile APIs.io
Bread SplitPay
AE Profile APIs.io
BreadPay Merchant Operations API
AE Profile APIs.io
BreadPay Servicing API
AE Profile APIs.io
BreadPay Buyer Management API
AE Profile APIs.io
BreadPay Payments API
AE Profile APIs.io
BreadPay Foundations API
AE Profile APIs.io
BreadPay Webhook API
AE Profile APIs.io
BreadPay Program API
AE Profile APIs.io
#Trade-In#Upgrade#Apple Program
← Back to B APIs
API Details
ID
bread-financial:tradein-api
Base URL
https://api.platform.breadpayments.com
Docs
https://platform-docs.breadpayments.com/bread-developers/reference/tradein-introduction
Provider
Bread Financial
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=tradein-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/tradein-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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 Tradein 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.