Bread Financial

Bread Financial Servicing API

The Servicing API from Bread Financial — 48 operation(s) for servicing.

GitHub OpenAPI

Operations 53

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

Documentation

📖
Documentation
https://platform-docs.breadpayments.com/bread-developers
📖
Authentication
https://platform-docs.breadpayments.com/bread-developers/docs/api-access

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bread-financial/refs/heads/main/openapi/bread-financial-servicing-api-openapi.yml

Other Resources

🔗
DeclineCodes
https://raw.githubusercontent.com/api-evangelist/bread-financial/refs/heads/main/errors/bread-decline-codes.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/bread-financial/refs/heads/main/webhooks/bread-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/bread-financial-servicing-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bread-financial-servicing-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Servicing API
  description: Servicing supports a buyer's post purchase journey, enabling viewing and management of payment agreements across all payment products.
  version: 2.0.0
  contact:
    email: partnership-growth@getbread.com
servers:
- url: https://api-preview.platform.breadpayments.com/
  description: Preview environment
- url: https://api.platform.breadpayments.com/
  description: Production environment
tags:


# --- truncated at 32 KB (5570 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bread-financial/refs/heads/main/openapi/bread-financial-servicing-api-openapi.yml