# BreadPay Tradein API

**Canonical:** https://apis.io/apis/bread-financial/tradein-api/  
**Provider:** Bread Financial — https://apis.io/providers/bread-financial/  
**Base URL:** https://api.platform.breadpayments.com  
**Documentation:** https://platform-docs.breadpayments.com/bread-developers/reference/tradein-introduction

BreadPay Tradein API is one of 13 APIs that [Bread Financial](https://apis.io/providers/bread-financial/) publishes on the [APIs.io](https://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.

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.

## Operations (6)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/tradein/upgrade-election` | Records user tradein election |
| POST | `/api/tradein/payment` | Applies a payment to an existing loan as part of the tradein process |
| GET | `/api/tradein/upgradeable-loan/payment-agreement/{paymentAgreementId}` | Retrieves the UpgradeableLoan entity related to a payment agreement |
| POST | `/api/tradein/payment-agreement/link-payment-agreement` | Links a buyers old and new loan |
| GET | `/api/tradein/upgradeable-loan/{id}` | Retrieves the UpgradeableLoan entity by its own id |
| POST | `/api/tradein/upgradeable-loan/{id}` | Creates an Upgradeable loan based on the given payment agreement ID |

## Machine-readable artifacts (2)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/bread-financial/refs/heads/main/openapi/bread-tradein-openapi.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/bread-financial/refs/heads/main/overlays/bread-tradein-overlay.yaml

## Other Bread Financial APIs (12)

- [BreadPay Platform API](https://apis.io/apis/bread-financial/breadpay-platform-api/)
- [Bread Pay API](https://apis.io/apis/bread-financial/bread-pay-api/)
- [Bread SplitPay API](https://apis.io/apis/bread-financial/split-pay-api/)
- [BreadPay Checkout API](https://apis.io/apis/bread-financial/bread-pay-api/)
- [Bread SplitPay](https://apis.io/apis/bread-financial/split-pay-api/)
- [BreadPay Merchant Operations API](https://apis.io/apis/bread-financial/merchant-operations-api/)
- [BreadPay Servicing API](https://apis.io/apis/bread-financial/servicing-api/)
- [BreadPay Buyer Management API](https://apis.io/apis/bread-financial/buyer-management-api/)
- [BreadPay Payments API](https://apis.io/apis/bread-financial/payments-api/)
- [BreadPay Foundations API](https://apis.io/apis/bread-financial/foundations-api/)
- [BreadPay Webhook API](https://apis.io/apis/bread-financial/webhook-api/)
- [BreadPay Program API](https://apis.io/apis/bread-financial/program-api/)

## Tags

Trade-In, Upgrade, Apple Program

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/bread-financial/tradein-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/bread-financial/.