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 Buyer Management API

Registration, lookup and management of buyers and their contacts, credit-report data, status and authorized third parties, with fraud-management capabilities around allow-listing and self cure. Handles regulated consumer PII including credit-file results. 15 operations.

Documentation Provider Profile APIs.io OpenAPI GitHub

BreadPay Buyer Management 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 Identity, Consumer Credit, KYC, and PII. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 15 operations across 10 paths, organized into 2 resource areas, and defines 50 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/.

15 operations 10 paths 50 schemas 7 GET4 POST4 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
Contact
partnership-growth@getbread.com
Resource Areas
2

Authentication & Security 1

BreadPay Buyer Management API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuthBuyer).

  • bearerAuthBuyer — The JWT access token provided by the Auth service.

Paths & Operations 15

Across 10 paths, the API surfaces 15 operations — 7 GET, 4 POST, 4 PUT. They span 2 resource areas: Buyer, Service Account. Each is listed below with its method, path, parameters, and response codes.

Buyer 14
POST
/api/buyer
Register a buyer
registerBuyer body → 200201400401403500
GET
/api/buyer
Lookup buyers
lookupBuyer 8 params → 200400401403500
POST
/api/buyer/unverified
Register an unverified buyer
registerUnverifiedBuyer body → 200201400401403500
GET
/api/buyer/{id}
Get a buyer
getBuyer 1 param → 200401403404500
PUT
/api/buyer/{id}
Update a buyer
updateBuyer 1 param body → 200400401403404500
POST
/api/buyer/{id}/contact
Create a buyer contact
createBuyerContact 1 param body → 200400401403404500
GET
/api/buyer/{id}/contact/{contact_id}
Get a buyer contact
getBuyerContact 2 params → 200400401403404500
PUT
/api/buyer/{id}/contact/{contact_id}
Update a buyer contact
updateBuyerContact 2 params body → 200400401403404500
GET
/api/buyer/{id}/creditReport
Get credit report data via service account
getCreditReportDataByBuyerID 2 params → 200400401403404500
PUT
/api/buyer/{id}/status
Update a buyer's status
updateBuyerStatus 1 param body → 200400401403404500
POST
/api/buyer/{id}/authorizedThirdParty
Create an authorized third party
CreateAuthorizedThirdParty 1 param body → 201400401403500
GET
/api/buyer/{id}/authorizedThirdParty
Get a list of a buyer's authorized third parties
listAuthorizedThirdParties 1 param → 200400401403404500
GET
/api/buyer/{id}/authorizedThirdParty/{authorized_third_party_id}
Get a buyer authorized third party
getBuyerAuthorizedThirdParty 2 params → 200400401403404500
PUT
/api/buyer/{id}/authorizedThirdParty/{authorized_third_party_id}
Update a buyer authorized third party via service account
updateBuyerAuthorizedThirdParty 2 params body → 200400401403404500
Service Account 1
GET
/api/buyer/{id}/creditReport/{cra}
Get credit report data via service account
getCreditReportData 2 params → 200400401403404500

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are CreditDataResponse (43 properties), Buyer (19 properties), AuthorizedThirdParty (15 properties), BuyerContact (9 properties). Each schema is shown below with its type and property counts.

BuyerError
object
Represents an error returned by buyer service.
1 property
BuyerErrorReason
string
Machine-readable reason code returned in the reason field of an error response. Use this value (rather than the human-readable message) to programmatically bra…
AuthorizedThirdParties
object
A list of authorized third parties including pagination response fields.
1 property
AuthorizedThirdParty
object
AuthorizedThirdParty represents a person who is allowed to perform certain actions on behalf of the buyer
15 properties 2 required
AuthorizedThirdPartyType
string
AuthorizedThirdPartyType represents a authorized third party type as enum Possible values: AUTHORIZEDTHIRDPARTY, POWEROFATTORNEY, ATTORNEYREPRESENTATION, GUARD…
PhoneType
string
PhoneType represents a phone type as enum Possible values: MOBILE, WORK, HOME, OTHER
Buyer
object
Buyer represents a buyer
19 properties 8 required
UnverifiedBuyerRequest
object
UnverifiedBuyerRequest represents an unverified buyer request, the object is the same as a regular buyer but more identity fields (iinShort and birthDate) are…
3 properties 1 required
BuyerList
object
A list of Buyers including pagination response fields.
4 properties
Address
object
Represents a fully defined address for an entity
6 properties 5 required
BuyerContact
object
BuyerContact represents a set of contact information.
9 properties 3 required
BuyerPrimaryContact
object
BuyerPrimaryContact represents a set of contact information.
8 properties 3 required
BuyerContactMap
object
BuyerContactMap represents a mapping of buyer contact IDs to contacts
BuyerStatus
string
Status represents buyer status as string. Options available will depend on tenant level configurations
BuyerSubStatus
string
SubStatus represents buyer sub status as constant string. Options available will depend on status value and tenant level configurations
Employment
object
Optional. Employment represents the buyer's employment.
8 properties 1 required
EmploymentType
string
EmploymentType represents a buyer employment type as enum Possible values: EMPLOYED, SELFEMPLOYED, UNEMPLOYED, STUDENT, RETIRED
Identity
object
The claims that determines the access level of the caller.
5 properties 1 required
UnverifiedIdentityRequest
object
Identity represents the identity of a unverified buyer
6 properties 6 required
CreditDataAddress
object
An address associated with a credit report
6 properties
CreditDataResponse
object
Response to a Credit Data Request
43 properties
CreditReportData
object
CreditReportData contains the values for requested keys in a credit report, KeyValues represents a map of fields as keys to raw JSON strings as values
3 properties
KeyValuesMap
object
KeyValuesMap contains a map of JSON path keys as strings to raw JSON values as strings and is used to return credit report information
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.
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
PaymentProductType
string
The type of payment product
TermInterval
string
Defines set of valid term intervals for a payment product
Terms
object
Represents the terms offered for a payment product
4 properties 4 required
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
Error
object
1 property 4 required
BaseError
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bread-buyer-management-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 Servicing 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
#Identity#Consumer Credit#KYC#PII
← Back to B APIs
API Details
ID
bread-financial:buyer-management-api
Base URL
https://api.platform.breadpayments.com
Docs
https://platform-docs.breadpayments.com/bread-developers/reference/buyer-management-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=buyer-management-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/buyer-management-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 Buyer Management 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.