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 Servicing API

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.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 64 operations across 59 paths, organized into 6 resource areas, and defines 254 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/.

64 operations 59 paths 254 schemas 6 DELETE26 GET4 PATCH25 POST3 PUT

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, HTTP Bearer
Contact
partnership-growth@getbread.com
Resource Areas
6

Authentication & Security 2

BreadPay Servicing API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuthServicing). It accepts HTTP bearer tokens (JWT) (bearerAuthDisclosure).

  • bearerAuthDisclosure — JWT access token provided by the Auth service

Paths & Operations 64

Across 59 paths, the API surfaces 64 operations — 6 DELETE, 26 GET, 4 PATCH, 25 POST, 3 PUT. They span 6 resource areas: Servicing, As Low As, Financing Payment Plan, Financing Dynamic Disclosure, Disclosures, Disclosure Templates. Each is listed below with its method, path, parameters, and response codes.

Servicing 53
GET
/api/servicing/buyer/{buyerID}/autopay
List Autopay Enrollments
listAutopayEnrollments 2 params → 200400401403500
GET
/api/servicing/buyer/{buyerID}/payment-agreement
List Buyer Payment Agreements
listBuyerPaymentAgreements 8 params → 200400401403500
GET
/api/servicing/occ
List OCC requests
listOccRequests 13 params → 200401403500
POST
/api/servicing/occ/add-record
Add OCC Record
addOccRecord 1 param body → 200401403500
GET
/api/servicing/payment-agreement
List Payment Agreement Summaries
listPaymentAgreementSummaries 7 params → 200400401403500
PUT
/api/servicing/payment-agreement-tag
Update payment agreement tags
updatePaymentAgreementsTags 1 param body → 200400401403500
DELETE
/api/servicing/payment-agreement-tag
Delete payment agreement tags.
deletePaymentAgreementsTags 1 param body → 200400401403500
GET
/api/servicing/payment-agreement/buyer/{buyerID}/future/list
List Scheduled Payment by Buyer ID
listFuturePaymentsByBuyerId 2 params → 200401403500
GET
/api/servicing/payment-agreement/{id}
Get Payment Agreement
getPaymentAgreement 3 params → 200400401403500
DELETE
/api/servicing/payment-agreement/{id}/autopay
Unenroll from Autopay
unenrollFromAutopay 2 params body → 204400401403500
POST
/api/servicing/payment-agreement/{id}/autopay
Enroll in Autopay
enrollInAutopay 2 params body → 200400401403500
GET
/api/servicing/payment-agreement/{id}/history
Get Balance History
getBalanceHistory 2 params → 200400401403500
GET
/api/servicing/payment-agreement/{id}/ledger-breakdown
Get ledger activities for a loan
getLedgerBreakdown 3 params → 200400401403500
POST
/api/servicing/payment-agreement/{id}/payment
Make Payment
makePayment 3 params body → 200400401403500
DELETE
/api/servicing/payment-agreement/{id}/payment/{paymentID}/cancel-payment
Cancel a payment
cancelPayment 3 params body → 200400401403500
PATCH
/api/servicing/payment-agreement/{id}/payment/{paymentID}/reallocate
Reallocate Payment
reallocatePayment 3 params body → 200400401403500
POST
/api/servicing/payment-agreement/{id}/payment/add-payment-record
Add a payment record
addPaymentRecord 2 params body → 200400401403500
PATCH
/api/servicing/payment-agreement/{id}/payment/backdate-payment
Backdate Payment
backdatePayment 2 params body → 200400401403500
PATCH
/api/servicing/occ/{occID}
Update OCC request
updateOcc 2 params body → 200400401403500
PATCH
/api/servicing/occ/{occID}/set-manual-review
Set OCC to be manually reviewed
setOccManualReview 2 params body → 200400401403500
GET
/api/servicing/payment-agreement-by-number/{agreementNumber}
Get Payment Agreement By Number
getPaymentAgreementByNumber 4 params → 200400401403500
POST
/api/servicing/payment-agreement/payment/future/schedule
Schedule Future Payment
scheduleFuturePayment 1 param body → 200401403500
GET
/api/servicing/payment-agreement/{id}/disputes
List disputes
listProductDisputes 2 params → 200401403500
POST
/api/servicing/payment-agreement/{id}/disputes
Open a dispute
openProductDispute 2 params body → 200401403500
GET
/api/servicing/payment-agreement/{id}/disputes/is-eligible
Check if eligible to open a dispute
isEligibleForProductDispute 2 params → 200401403500
PUT
/api/servicing/payment-agreement/{id}/disputes/{disputeID}
Closes a dispute
closeProductDispute 3 params body → 200401403500
GET
/api/servicing/payment-agreement/{id}/future/list
List Scheduled Payments by Payment Agreement ID
listFuturePaymentsByPaymentAgreementId 2 params → 200401403500
POST
/api/servicing/payment-agreement/{id}/waive-amount
Waive an amount
waiveAmount 2 params body → 200401403500
POST
/api/servicing/payment-agreement/{id}/waive-remaining
Waive any remaining amount
waiveRemaining 2 params body → 200401403500
POST
/api/servicing/payment-agreement/{id}/waive-remaining-outstanding-balance
Waive remaining outstanding balance
waiveRemainingOutstandingBalance 2 params → 200401403500
POST
/api/servicing/payment-agreement/{id}/waive-amount-installment-due
Waive installment due amount
waiveAmountInstallmentDue 2 params body → 200401403500
POST
/api/servicing/payment-agreement/{id}/waive-principal-amount
Waive principal amount
waivePrincipalAmount 2 params body → 200401403500
POST
/api/servicing/payment-agreement/{id}/modifications/rate
Update Loan Interest Rate
updateInterestRate 2 params body → 200401403500
POST
/api/servicing/payment-agreement/{id}/esign-consent
Update E-Sign Consent
updateEsignConsent 2 params body → 200401403500
POST
/api/servicing/esign-consent-bulk
Bulk Update E-Sign Consent
bulkUpdateEsignConsent 1 param body → 200400401403500
POST
/api/servicing/update-mail-returned
Update mail returned status on a payment-agreement
updateMailReturned 1 param body → 200401403500
PUT
/api/servicing/payment-agreement/{id}/update-amount
Update the loan amount
updateLoanAmount 2 params body → 200401403500
DELETE
/api/servicing/payment-agreement/{id}/cancel-payment-agreement
Cancel a payment agreement
cancelPaymentAgreement 2 params → 200400401403500
DELETE
/api/servicing/payment-agreement/payment/{paymentID}/future/cancel-payment
Cancel a future payment
cancelFuturePayment 2 params → 204400401403500
POST
/api/servicing/payment-agreement/payment/future/process-single-payment
Process Single Scheduled Payment
processScheduledPayment 1 param body → 204400401403500
POST
/api/servicing/payment-agreement/payment/future/process
Process Scheduled Payments
processScheduledPayments 1 param body → 200401403500
GET
/api/servicing/calculated-payments
Calculate payment for a set of agreements
calculatePayments 4 params → 200400401403500
POST
/api/servicing/generate-payment-schedule
Generate a payment schedule given a set of parameters
generatePaymentSchedule 1 param body → 200401403500
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 disclosures, such as re-generating a disc…
generateDocument 1 param body → 200400401403500
GET
/api/servicing/audit-action
List audit actions for a payment agreement
listAuditActions 2 params → 200401403500
POST
/api/servicing/audit-action
Add an audit action for a payment agreement
addAuditAction 1 param body → 200401403500
POST
/api/servicing/payment-agreement/{id}/payment/refund-payment
Refund Payment
refundPayment 2 params body → 200400401403500
GET
/api/servicing/payment-agreement/{id}/allowed-payment-method-types
Get Allowed Payment Method Types
getAllowedPaymentMethodTypes 2 params → 200400401403500
POST
/api/servicing/payment-agreement/{id}/skipped-late-fees
Add skipped late fees
addSkippedLateFees 2 params body → 200401403500
DELETE
/api/servicing/payment-agreement/{id}/skipped-late-fees
Delete skipped late fees
deleteSkippedLateFees 2 params body → 200401403500
POST
/api/servicing/payment-agreement/{id}/late-fee-hold-eligibility
Check late fee hold eligibility
checkLateFeeHoldEligibility 2 params body → 200401403500
POST
/api/servicing/payment-agreement/{id}/modifications/deferred-interest-period-end-date
Update Deferred Interest Period End Date
updateDeferredInterestPeriodEndDate 2 params body → 200400401403404500
GET
/api/servicing/payment-agreement/{id}/deferred-interest-details
Get deferred interest details for a loan
getDeferredInterestDetails 2 params → 200400401403500
As Low As 2
GET
/api/experience/servicing/as-low-as
Get As-Low-As
getAsLowAs 3 params → 200400500
GET
/api/experience/dynamic-financing/loan-terms
Get financing/loan-terms
getFinancingLoanTerms 2 params → 200400500
Financing Payment Plan 1
GET
/api/experience/dynamic-financing/payment-plan
Get Financing Payment Plan
getFinancingPaymentPlan 2 params → 200400500
Financing Dynamic Disclosure 1
GET
/api/experience/dynamic-financing/dynamic-disclosure
Get Financing Dynamic Disclosure
getFinancingDynamicDisclosure 2 params → 200400500
Disclosures 6
POST
/api/disclosure/payment-agreement/{paymentAgreementID}
Generate a set of disclosures
generateDisclosures 2 params body → 200400401403500
GET
/api/disclosure/document/{disclosureName}/payment-agreement/{paymentAgreementID}
Get latest disclosure by agreement ID and disclosure name
getDisclosureByAgreementAndName 6 params → 200400401403500
GET
/api/disclosure/document/{disclosureID}
Get disclosure by ID
getDisclosureByDisclosureID 3 params → 200400401403500
GET
/api/disclosure/document/{disclosureName}/target/{targetID}
Get disclosure by target
getDisclosureByNameAndTargetID 5 params → 200400401403500
GET
/api/disclosure/static/{disclosureName}
Get static disclosure
getStaticDisclosure 3 params → 200400401403500
GET
/api/disclosure
List disclosures
listDisclosures 8 params → 200400401403500
Disclosure Templates 1
GET
/api/disclosure/template/{disclosureName}/program/{programID}
Get a disclosure template
getTemplate 3 params → 200400401403500

Schemas 254

The contract defines 254 schemas that model the data the API accepts and returns. The most detailed are BalanceSummary (66 properties), LedgerActivityMonetaryValues (34 properties), BalanceHistoryPeriodSummary (24 properties), AuditAction (21 properties). Each schema is shown below with its type and property counts.

PaymentAgreementErrorResponse
PaymentAgreementErrorReason
string
Payment agreement retrieval error reason codes
ListOccResponse
object
The response returned by the List OCC endpoint.
2 properties 1 required
ListPaymentAgreementsResponse
object
The response returned by the ListPaymentAgreements endpoint.
1 property 1 required
ListBuyerPaymentAgreementsResponse
object
A response object for a buyer payment agreement list request.
2 properties
UpdateAgreementsTagResponse
object
The response returned by the UpdateAgreementsTag endpoint.
1 property
DeleteAgreementsTagResponse
object
The response returned by the DeleteAgreementsTag endpoint.
1 property
CalculatePaymentsResponse
object
Response returned by the Calculate Payments endpoint
1 property 1 required
ProductDispute
ProductDisputeChargebackType
string
ProductDisputeResolution
object
4 properties 2 required
CloseProductDisputeResponse
object
1 property 1 required
IsEligibleForProductDisputeResponse
object
3 properties 2 required
ListProductDisputeResponse
object
1 property 1 required
OpenProductDisputeRequest
object
1 property 1 required
OpenProductDisputeResponse
object
1 property 1 required
ProcessScheduledPaymentRequest
object
1 property 1 required
ProcessScheduledPaymentsRequest
object
1 property 1 required
ProcessScheduledPaymentsResponse
object
2 properties
ProductDisputeReasonCode
string
ProductDisputeStatus
string
GetPaymentAgreementResponse
object
The response returned by the GetPaymentAgreement endpoint.
1 property 1 required
GetBalanceHistoryResponse
object
The response returned by the GetBalanceHistory endpoint.
1 property 1 required
GetLedgerBreakdownResponse
object
The response returned by the GetLedgerBreakdown endpoint.
3 properties 2 required
PaymentAgreementBase
object
A slim view of a payment agreement.
18 properties 15 required
PaymentProductType
string
The type of payment product
UpdateAgreementTagError
object
2 properties
DeleteAgreementTagError
object
2 properties
PaymentAgreementSummary
Pagination
object
Result pagination values
3 properties
PaymentAgreement
PaymentAgreementStatus
string
The status of a payment agreement. Note: REVIEW is deprecated.
PaymentAgreementSubStatus
string
The substatus of a payment agreement.
PaymentAgreementReasonCode
string
- UNKNOWNREASON: unknown reason - WRITEOFF: Paid, Closed status - CONTRACTUAL: Charged off - FULLYREFUNDED: Closed - MERCHANTFRAUD: Cancelled - OTHERCHOSEN: Ex…
Terms
object
Represents the terms offered for a payment product
4 properties 4 required
TermsInterval
string
TermsLateFee
object
The configuration of the late fee for the loan.
3 properties
TermsDeferredInterest
object
The deferred interest configuration for the loan.
1 property
PaymentSchedule
object
Describes the start date and its installments.
4 properties 2 required
Installment
object
Describes an installment.
6 properties 2 required
InstallmentPeriod
object
Describes an installment period, with start and end dates.
13 properties 5 required
LedgerActivityMetadata
object
2 properties
SkippedLateFeeAssessmentMetadata
object
4 properties
DrawLineOfCreditMetadata
object
4 properties
LedgerActivityMonetaryValues
object
Describes just the monetary part of ledger activity that could change.
34 properties
LedgerActivity
PaymentAgreementActivity
object
18 properties 3 required
PaymentAgreementActivityExtensionType
string
PaymentAgreementActivityPaymentExtension
object
Represents a payment made towards the loan
17 properties 4 required
PaymentAgreementActivityRefundExtension
object
10 properties 2 required
PaymentAgreementActivityDueDateChangeExtension
object
1 property
PaymentAgreementNumber
string
A human-friendly unique ID for a payment agreement.
PaymentRecurrence
object
2 properties
PaymentAgreementActivityOccExtension
object
6 properties 3 required
PaymentAgreementActivityFuturePaymentExtension
object
9 properties
PaymentAgreementActivitySkippedInstallmentsExtension
object
6 properties
PaymentAgreementActivityTermsUpdateExtension
object
17 properties
PaymentAgreementActivityChargeBackExtension
object
4 properties 4 required
PaymentAgreementActivityPaymentRefundExtension
object
8 properties 5 required
PaymentAgreementActivityWaiveExtension
object
4 properties
PaymentAgreementActivitySkippedLateFeesExtension
object
9 properties 2 required
PaymentAgreementActivityDrawExtension
object
10 properties 4 required
PaymentAgreementActivityEodSodReenrollExtension
object
Represents an End of Day/Start of Day autopay enrollment
2 properties 2 required
PaymentAgreementActivityEodSodUnenrollExtension
object
Represents an End of Day/Start of Day autopay unenrollment
2 properties 2 required
PaymentRecurrenceFrequency
string
BalanceSummary
object
Represents a summary of the payment agreement's aggregated balances.
66 properties 11 required
BalanceSummarySubset
object
Select subset of fields from Balance Summary.
2 properties
AutopayStatus
object
Describes the autopay enrollment for a payment agreement.
3 properties
AvailableAdjustment
object
7 properties
AvailableAdjustmentCategory
string
AvailableAdjustmentWaiveAmountDetail
object
1 property
StatusHistory
object
Lists all previous statuses and their record times of a payment agreement
5 properties 5 required
OccBase
object
5 properties 2 required
OccRequest
OccStatus
string
OccReviewStatus
string
OccExecutionType
string
DisclosureType
string
A symbol identifying a disclosure document type for GenerateDocument endpoint only
CalculatedPayment
object
Calculates new payment amount for the terms of the given agreement, based on a new loan amount
3 properties
PaymentMethodType
string
PaymentMethodType is a further distinction of an AccountType. E.g. debit vs credit for card accounts
PaymentStatus
string
PaymentSubStatus
string
PaymentRequestType
string
One of 'INSTALLMENT', 'OTHER', 'OUTSTANDINGBALANCE', 'PAYOFF', 'PRINCIPAL', 'RECOVERY', 'DOWNPAYMENT', 'SPLITPAYFIRSTPAYMENT'
SourceType
string
Identifies the processing source type of payment. Note: 'SCHEDULEDPAYMENT' is deprecated in favor of SCHEDULED
SubSourceType
string
SubSourceType is the medium through which the payment was originated. One of WEB (online), TEL (over the phone), or IVR (automated through interactive voice re…
AccountType
string
AccountType designates the type of an account, and is logically aligned with payments' PaymentMethodType.
PaymentDispute
object
6 properties 6 required
PaymentDisputeType
string
PaymentDisputeStatus
string
BalanceHistory
object
3 properties 2 required
BalanceHistoryPeriodEvent
object
13 properties
BalanceHistoryPeriodEventType
string
Enumerated types of period events in a payment agreement's balance history.
BalanceHistoryPeriodEventOccEvent
object
3 properties
BalanceHistoryPeriodEventPaymentEvent
object
4 properties
BalanceHistoryPeriodEventRefundEvent
object
3 properties
BalanceHistoryPeriodEventChargeOffEvent
object
2 properties
BalanceHistoryPeriodEventChargeBackEvent
object
3 properties
BalanceHistoryPeriodEventWaiveEvent
object
4 properties
BalanceHistoryPeriodEventPaymentRefundEvent
object
3 properties
BalanceHistoryPeriodEventDrawEvent
object
7 properties 1 required
BalanceHistoryPeriodEventRefundType
string
BalanceHistoryPeriodEventChargeBackCategory
string
BalanceHistoryPeriodEventWaiveCategory
string
BalanceHistoryPeriodEventChargeOffReason
string
BalanceHistoryPeriodSummary
object
24 properties 2 required
AutopayEnrollment
object
3 properties 3 required
AgreementTag
string
Payment Agreement Tag Name. Note: 'CREDITBUREAUREPORTING' is deprecated and should not be used.
CreditBureauDisputeStatusType
string
CreditBureauReportingStatusType
string
CreditBureauReportingSubStatusType
string
PaymentAgreementTag
object
11 properties
PauseCollectionCalls
object
2 properties
MigratedFromClassic
object
2 properties
CbrDoNotReport
object
CbrForceReport
object
1 property
ImproperChargeOff
object
CbrDeleteAccount
object
TestProductionLoan
object
PaymentRefundStatus
string
RefundStatus
string
DrawType
string
DrawStatus
string
ListAutopayEnrollmentsResponse
object
1 property 1 required
EnrollInAutopayRequest
object
3 properties 2 required
UnenrollFromAutopayRequest
object
AutoPay Unenrollment Data (object containing all required data for unenrollment)
1 property
UpdateAgreementsTagRequest
object
Request parameters for bulk updating payment agreement tags.
1 property 1 required
UpdateAgreementTagRequest
object
Request parameters for updating a tag for a payment agreement.
12 properties 2 required
DeleteAgreementsTagRequest
object
Request parameters for bulk deletion of payment agreement tags.
1 property 1 required
DeleteAgreementTagRequest
object
Request parameters for deleting a tag for a payment agreement.
2 properties 2 required
PaymentBase
object
5 properties 2 required
Payment
1 required
FuturePayment
4 required
MakePaymentRequest
object
12 properties 5 required
MakePaymentResponse
object
3 properties
ReallocatePaymentRequest
object
3 properties 1 required
ReallocatePaymentRequestType
string
ReallocatePaymentResponse
object
2 properties
BackdatePaymentRequest
object
4 properties 3 required
BackdatePaymentResponse
object
1 property
AddPaymentRecordRequest
object
5 properties
AddPaymentRecordResponse
object
2 properties
ScheduleFuturePaymentResponse
object
1 property 1 required
ScheduleFuturePaymentRequest
3 required
CancelPaymentRequest
object
2 properties 1 required
CancelPaymentResponse
object
1 property
DisclosureAcknowledgement
object
2 properties 2 required
EnrollInAutopayResponse
object
Response for the Enroll in Autopay Endpoint
3 properties 3 required
ListFuturePaymentsResponse
object
Response for the List Future Payments endpoint
1 property 1 required
UpdateLoanInterestRequest
object
4 properties 2 required
UpdateLoanInterestResponse
object
1 property 1 required
UpdateEsignConsentRequest
object
2 properties 1 required
BulkUpdateEsignConsentRequest
object
4 properties 1 required
BulkUpdateEsignConsentResponse
object
1 property 1 required
UpdateMailReturnedRequest
object
2 properties 2 required
UpdateLoanAmountResponse
object
1 property 1 required
WaiveAmountRequest
object
2 properties 2 required
WaiveAmountResponse
object
Response for the Waive Amount Endpoint
1 property 1 required
WaiveAmountInstallmentDueRequest
object
1 property 1 required
WaiveAmountPrincipalRequest
object
3 properties 2 required
UpdateLoanAmountRequest
object
1 property 1 required
WaiveAmountCategory
string
Category of waive. Supported - CREDIT: Credit means we are waiving off an amount that we owe the customer.
WaiveRemainingRequest
object
Category of waive - supported: PETTYINTEREST, OUTSTANDINGBALANCE
1 property 1 required
WaiveRemainingResponse
object
Response for the Waive Remaining Endpoint
1 property 1 required
UpdateOccResponse
object
Response for the Update Occ Endpoint
1 property 1 required
UpdateOccRequest
object
Request body for updating Occ endpoint
5 properties 1 required
SetOccManualReviewRequest
object
Request body for the Set OCC Manual Review Endpoint
1 property
SetOccManualReviewResponse
object
Response for the Set OCC Manual Review Endpoint
1 property 1 required
AddOccRecordResponse
object
Response for the Add Occ Record Endpoint
1 property 1 required
AddOccRecordRequest
object
Request body for updating Occ endpoint
4 properties 3 required
CancelPaymentAgreementResponse
object
1 property
SkippedInstallmentsReason
string
SkippedLateFeesReason
string
Identifies the skipped late fees reason. Note: 'DISASTERRELIEF' is deprecated in favor of 'DISASTERASSISTANCE'.
ProcessSodRequest
object
1 property
ProcessSodResponse
object
1 property
GenerateDocumentRequest
object
Request for the generate document endpoint
5 properties 2 required
GenerateDocumentResponse
object
Response for the generate document endpoint
1 property
RefundPaymentRequest
object
4 properties 3 required
RefundPaymentResponse
object
1 property
ListAuditActionResponse
object
Response for the list audit action endpoint
1 property
AddAuditActionRequest
object
Request body for AddAuditAction
1 property
AddAuditActionResponse
object
The response returned by the AddAuditAction endpoint.
1 property
AuditAction
object
Container for audit action object values
21 properties
BackdatePaymentExtension
object
3 properties
CreateManualPaymentExtension
object
1 property
CancelManualPaymentExtension
object
1 property
AdjustAprExtension
object
3 properties
AdjustDpdHistoryExtension
object
1 property
ImproperChargeOffExtension
object
1 property
CbrForceReportExtension
object
1 property
CbrDeleteAccountExtension
object
1 property
CbrDoNotReportExtension
object
1 property
UpdateEsignConsentExtension
object
2 properties
WaivePrincipalExtension
object
1 property
RefundPaymentExtension
object
1 property
SkippedLateFeeExtension
object
3 properties 1 required
ManualChargeOffExtension
object
2 properties
AuditActionExtensionType
string
GetAllowedPaymentMethodTypesResponse
object
The response returned by the GetAllowedPaymentMethodTypesAgreement endpoint
1 property 1 required
AddSkippedLateFeesRequest
object
Request for the Add Skipped Late Fees Endpoint
4 properties 3 required
DeleteSkippedLateFeesRequest
object
Request for the Delete Skipped Late Fees Endpoint
4 properties 3 required
CheckLateFeeHoldEligibilityRequest
object
Request for the Check Late Fee Hold Eligibility Endpoint
2 properties 1 required
AddSkippedLateFeesResponse
object
Response for the Add Skipped Late Fees Endpoint
1 property 1 required
DeleteSkippedLateFeesResponse
object
Response for the Delete Skipped Late Fees Endpoint
1 property 1 required
CheckLateFeeHoldEligibilityResponse
object
Response for the Check Late Fee Hold Eligibility Endpoint
1 property 1 required
PaymentScheduleCategory
string
InterestRoundingPolicy
string
GeneratePaymentScheduleRequest
object
Request for the Generate Payment Schedule Endpoint
8 properties 6 required
GeneratePaymentScheduleResponse
object
Response for the Generate Payment Schedule Endpoint
1 property 1 required
UpdateDeferredInterestPeriodEndDateRequest
object
2 properties 2 required
UpdateDeferredInterestPeriodEndDateResponse
object
1 property 1 required
DeferredInterestStatus
string
GetDeferredInterestDetailsResponse
object
The response returned by the GetDeferredInterestDetails endpoint.
7 properties 7 required
AsLowAsBadRequest
object
Represents a error returned by aslowas service.
1 property
AsLowAsInternalServerError
object
As-low-as.
1 property
AsLowAsResponse
object
Information on the as low as offering.
2 properties
PaymentProductSummaryResponse
object
Payment product headline and subhead text used on financing page.
4 properties
LoanTermsResponse
object
Loan terms subhead and SubheadInstallmentdisclosuresymbol on financing page.
2 properties
DynamicDisclosureResponse
object
Dynamic disclosure copy for financing page.
4 properties
DisclosureName
string
A symbol identifying a disclosure document type
disclosureOperation
string
A high level category of the operation being disclosed
GenerateDisclosureRequest
object
The request body for generating multiple documents. Choose one of the disclosure Operations.
7 properties 1 required
GenerateDisclosureResponse
object
2 properties
DisclosureResponse
object
The response body for one disclosure generated as part of a request to generate multiple disclosures
3 properties 3 required
ListDisclosuresResponse
object
Response for the ListDisclosuresResponseBody
2 properties
Disclosure
object
A representation of a single disclosure document
8 properties 8 required
DisclosureErrorResponse
DisclosureErrorReason
string
Disclosure error reason codes
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
TermInterval
string
Defines set of valid term intervals for a payment product
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-servicing-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 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
BreadPay Tradein API
AE Profile APIs.io
#Loan Servicing#Payments#Disclosures#Disputes#Post-Purchase
← Back to B APIs
API Details
ID
bread-financial:servicing-api
Base URL
https://api.platform.breadpayments.com
Docs
https://platform-docs.breadpayments.com/bread-developers/reference/servicing-1-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=servicing-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/servicing-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 Servicing 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.