# BreadPay Servicing API

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

BreadPay Servicing 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 Loan Servicing, Payments, Disclosures, Disputes, and Post-Purchase. The published artifact set on APIs.io includes an OpenAPI specification.

The buyer's post-purchase journey — payment agreements, balances and ledger breakdowns, autopay enrollment, scheduled and ad-hoc payments, refunds, fee and principal waivers, product disputes, deferred interest, "as low as" offers and regulatory disclosure generation. The largest definition at 64 operations, and the only one carrying an idempotency key.

## Operations (60 of 64)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/servicing/buyer/{buyerID}/autopay` | List Autopay Enrollments |
| GET | `/api/servicing/buyer/{buyerID}/payment-agreement` | List Buyer Payment Agreements |
| GET | `/api/servicing/occ` | List OCC requests |
| POST | `/api/servicing/occ/add-record` | Add OCC Record |
| GET | `/api/servicing/payment-agreement` | List Payment Agreement Summaries |
| PUT | `/api/servicing/payment-agreement-tag` | Update payment agreement tags |
| DELETE | `/api/servicing/payment-agreement-tag` | Delete payment agreement tags. |
| GET | `/api/servicing/payment-agreement/buyer/{buyerID}/future/list` | List Scheduled Payment by Buyer ID |
| GET | `/api/servicing/payment-agreement/{id}` | Get Payment Agreement |
| DELETE | `/api/servicing/payment-agreement/{id}/autopay` | Unenroll from Autopay |
| POST | `/api/servicing/payment-agreement/{id}/autopay` | Enroll in Autopay |
| GET | `/api/servicing/payment-agreement/{id}/history` | Get Balance History |
| GET | `/api/servicing/payment-agreement/{id}/ledger-breakdown` | Get ledger activities for a loan |
| POST | `/api/servicing/payment-agreement/{id}/payment` | Make Payment |
| DELETE | `/api/servicing/payment-agreement/{id}/payment/{paymentID}/cancel-payment` | Cancel a payment |
| PATCH | `/api/servicing/payment-agreement/{id}/payment/{paymentID}/reallocate` | Reallocate Payment |
| POST | `/api/servicing/payment-agreement/{id}/payment/add-payment-record` | Add a payment record |
| PATCH | `/api/servicing/payment-agreement/{id}/payment/backdate-payment` | Backdate Payment |
| PATCH | `/api/servicing/occ/{occID}` | Update OCC request |
| PATCH | `/api/servicing/occ/{occID}/set-manual-review` | Set OCC to be manually reviewed |
| GET | `/api/servicing/payment-agreement-by-number/{agreementNumber}` | Get Payment Agreement By Number |
| POST | `/api/servicing/payment-agreement/payment/future/schedule` | Schedule Future Payment |
| GET | `/api/servicing/payment-agreement/{id}/disputes` | List disputes |
| POST | `/api/servicing/payment-agreement/{id}/disputes` | Open a dispute |
| GET | `/api/servicing/payment-agreement/{id}/disputes/is-eligible` | Check if eligible to open a dispute |
| PUT | `/api/servicing/payment-agreement/{id}/disputes/{disputeID}` | Closes a dispute |
| GET | `/api/servicing/payment-agreement/{id}/future/list` | List Scheduled Payments by Payment Agreement ID |
| POST | `/api/servicing/payment-agreement/{id}/waive-amount` | Waive an amount |
| POST | `/api/servicing/payment-agreement/{id}/waive-remaining` | Waive any remaining amount |
| POST | `/api/servicing/payment-agreement/{id}/waive-remaining-outstanding-balance` | Waive remaining outstanding balance |
| POST | `/api/servicing/payment-agreement/{id}/waive-amount-installment-due` | Waive installment due amount |
| POST | `/api/servicing/payment-agreement/{id}/waive-principal-amount` | Waive principal amount |
| POST | `/api/servicing/payment-agreement/{id}/modifications/rate` | Update Loan Interest Rate |
| POST | `/api/servicing/payment-agreement/{id}/esign-consent` | Update E-Sign Consent |
| POST | `/api/servicing/esign-consent-bulk` | Bulk Update E-Sign Consent |
| POST | `/api/servicing/update-mail-returned` | Update mail returned status on a payment-agreement |
| PUT | `/api/servicing/payment-agreement/{id}/update-amount` | Update the loan amount |
| DELETE | `/api/servicing/payment-agreement/{id}/cancel-payment-agreement` | Cancel a payment agreement |
| DELETE | `/api/servicing/payment-agreement/payment/{paymentID}/future/cancel-payment` | Cancel a future payment |
| POST | `/api/servicing/payment-agreement/payment/future/process-single-payment` | Process Single Scheduled Payment |
| POST | `/api/servicing/payment-agreement/payment/future/process` | Process Scheduled Payments |
| GET | `/api/servicing/calculated-payments` | Calculate payment for a set of agreements |
| POST | `/api/servicing/generate-payment-schedule` | Generate a payment schedule given a set of parameters |
| POST | `/api/servicing/disclosure/generate-document` | GenerateDocument requests a disclosure document to be generated for the requested agreement ID. This method should only be used for special cases on specific... |
| GET | `/api/servicing/audit-action` | List audit actions for a payment agreement |
| POST | `/api/servicing/audit-action` | Add an audit action for a payment agreement |
| POST | `/api/servicing/payment-agreement/{id}/payment/refund-payment` | Refund Payment |
| GET | `/api/servicing/payment-agreement/{id}/allowed-payment-method-types` | Get Allowed Payment Method Types |
| POST | `/api/servicing/payment-agreement/{id}/skipped-late-fees` | Add skipped late fees |
| DELETE | `/api/servicing/payment-agreement/{id}/skipped-late-fees` | Delete skipped late fees |
| POST | `/api/servicing/payment-agreement/{id}/late-fee-hold-eligibility` | Check late fee hold eligibility |
| POST | `/api/servicing/payment-agreement/{id}/modifications/deferred-interest-period-end-date` | Update Deferred Interest Period End Date |
| GET | `/api/servicing/payment-agreement/{id}/deferred-interest-details` | Get deferred interest details for a loan |
| GET | `/api/experience/servicing/as-low-as` | Get As-Low-As |
| GET | `/api/experience/dynamic-financing/payment-plan` | Get Financing Payment Plan |
| GET | `/api/experience/dynamic-financing/loan-terms` | Get financing/loan-terms |
| GET | `/api/experience/dynamic-financing/dynamic-disclosure` | Get Financing Dynamic Disclosure |
| POST | `/api/disclosure/payment-agreement/{paymentAgreementID}` | Generate a set of disclosures |
| GET | `/api/disclosure/document/{disclosureName}/payment-agreement/{paymentAgreementID}` | Get latest disclosure by agreement ID and disclosure name |
| GET | `/api/disclosure/document/{disclosureID}` | Get disclosure by ID |

…and 4 more operations. They are listed in full on the page.

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/bread-financial/refs/heads/main/openapi/bread-servicing-openapi.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/bread-financial/refs/heads/main/overlays/bread-servicing-overlay.yaml
- **AgentSkill** — https://raw.githubusercontent.com/api-evangelist/bread-financial/refs/heads/main/skills/bread-take-a-payment-on-a-payment-agreement.md

## 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 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

Loan Servicing, Payments, Disclosures, Disputes, Post-Purchase

---

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