# BreadPay Checkout API

**Canonical:** https://apis.io/apis/bread-financial/bread-pay-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/checkout-introduction

BreadPay Checkout 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 Installment Financing, Checkout, Payments, BNPL, and Virtual Card. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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.

## Operations (18)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/application` | List Applications by Filter |
| POST | `/api/application` | Start an Application |
| GET | `/api/application/{applicationID}` | Get Application by ID |
| POST | `/api/application/{applicationID}/agreement/{agreementID}/checkout` | Complete Checkout for Application |
| POST | `/api/application/{applicationID}/prepare-checkout` | Prepare Checkout for Application |
| POST | `/api/application/instore/{shortcode}/checkout` | Complete Checkout for Instore Application |
| POST | `/api/virtual-card/issuance` | Issue a new virtual card |
| POST | `/api/virtual-card/issuance/{lookupKey}/wallet/applepay` | Issue a new ApplePay digital wallet token |
| POST | `/api/virtual-card/issuance/{lookupKey}/wallet/googlepay` | Issue a new GooglePay digital wallet token |
| GET | `/api/virtual-card/issuance/{lookupKey}` | Get issuance |
| GET | `/api/virtual-card/issuance/{lookupKey}/card` | Get issuance card |
| GET | `/api/virtual-card/issuance/{lookupKey}/card/pan` | Get issuance card with PAN and CVV |
| POST | `/api/virtual-card/issuance/{lookupKey}/card/{cardId}/reprovision` | Reprovision a card |
| GET | `/api/virtual-card/issuance/{lookupKey}/wallet/{walletId}` | Get wallet |
| GET | `/api/virtual-card/issuance/{lookupKey}/wallet/{walletId}/pan` | Get wallet and DPAN |
| POST | `/api/virtual-card/issuance/{lookupKey}/card/status` | Update Issuance Status |
| GET | `/api/virtual-card/issuance/{lookupKey}/events` | Get Virtual Card Events |
| GET | `/api/virtual-card/issuance/{lookupKey}/transaction_data` | Get Virtual Card Transaction Data |

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/bread-financial/refs/heads/main/openapi/bread-checkout-openapi.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/bread-financial/refs/heads/main/overlays/bread-checkout-overlay.yaml
- **Documentation** — https://platform-docs.breadpayments.com/bread-developers
- **OpenAPI** — https://docs.breadpayments.com/oas/v2/2.0/checkout.openapi3.json

## Other Bread Financial APIs (11)

- [BreadPay Platform API](https://apis.io/apis/bread-financial/breadpay-platform-api/)
- [Bread SplitPay API](https://apis.io/apis/bread-financial/split-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/)
- [BreadPay Tradein API](https://apis.io/apis/bread-financial/tradein-api/)

## Tags

Installment Financing, Checkout, Payments, BNPL, Virtual Card

---

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