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

Self-service webhook subscription management — create, update and delete subscriptions with NONE, BASIC or static-bearer subscriber auth, list delivered events by status, replay failed events by id, fire a synthetic integration test event, and fetch the JWKs that verify the detached JWS signature on every delivery. Events are CloudEvents 1.0.2 over the HTTP binding. 9 operations.

Documentation Provider Profile APIs.io OpenAPI GitHub

BreadPay Webhook 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 Webhooks, Events, CloudEvents, and Replay. The published artifact set on APIs.io includes an OpenAPI specification.

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

9 operations 6 paths 48 schemas 1 DELETE4 GET1 PATCH3 POST

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
Core-Eng@breadfinancial.com
Resource Areas
3

Authentication & Security 1

BreadPay Webhook API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuthWebhook).

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

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 1 PATCH, 3 POST. They span 3 resource areas: Subscription Management, Events, Client Management. Each is listed below with its method, path, parameters, and response codes.

Subscription Management 6

Managing webhook subscriptions

GET
/api/webhook/subscription
List subscriptions
getAllSubscriptions 2 params → 200400500
POST
/api/webhook/subscription
Create a subscription
createSubscription body → 201400401403500
GET
/api/webhook/subscription/{name}
Get a subscription
getSubscription 1 param → 200400401403404500
PATCH
/api/webhook/subscription/{name}
Update a subscription
updateSubscription 1 param body → 200400401403404500
DELETE
/api/webhook/subscription/{name}
Delete a subscription
deleteSubscription 1 param → 204400401403404409410500
POST
/api/webhook/subscription/{name}/integration-test-event
Send a Subscription Integration Test Event
createSubscriptionTest 1 param → 201400401403404500
Events 2

Event status retrieval and replay mechanism

GET
/api/webhook/subscription/{name}/event
List events
getEventBySubscriptionAndStatus 6 params → 200400401403404500
POST
/api/webhook/subscription/{name}/event/{id}/dispatch
Replay an event
replayEventBySubscriptionNameAndEventID 2 params → 200400401403404500
Client Management 1
GET
/api/webhook/client/jwks
List JWKs
getClientJWKs → 200304401403404500

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are BankAccountDetail (6 properties), AsLowAs (6 properties), Address (6 properties), EventDispatch (5 properties). Each schema is shown below with its type and property counts.

EventList
object
2 properties 2 required
EventSubscription
string
Events subscribed to by subscriber
SubscriptionURL
string
Subscriber endpoint to call with event
Name
object
Represents the full name
3 properties 2 required
SubscriptionList
object
contains list of subscription and pagination info
3 properties 3 required
Subscription
SubscriptionData
object
Object containing subscription data returned for successful requests
3 properties 3 required
CreateSubscription
object
Object containing data to make a request to create a subscription
4 properties 4 required
UpdateSubscription
object
Object containing data to make a request to update a subscription
3 properties
EventDispatch
object
Event Dispatch object.
5 properties 5 required
Pagination
object
pagination for response
3 properties 3 required
Auth
AuthNone
object
Represents sending of no Authorization header to the subscription endpoint
1 property 1 required
AuthBasic
object
Represents sending of an Authorization header in format of https://www.ietf.org/rfc/rfc2617.txt. Will be sent in the format of "Basic base64(username:password)…
3 properties 3 required
AuthStaticBearerToken
object
Represents sending of an Authorization header in format of https://www.ietf.org/rfc/rfc6750.txt. Will be sent in the format of "Bearer token" to the subscripti…
2 properties 2 required
EventStatusEnum
string
JWK
object
5 properties 5 required
JWKList
object
Object containing list of JWK
1 property 1 required
SubscriptionTestStatus
object
Subscription Test Status
2 properties 2 required
TestStatus
string
status stating if request was sent to subscriber
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
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
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-webhook-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 Buyer Management API
AE Profile APIs.io
BreadPay Payments API
AE Profile APIs.io
BreadPay Foundations API
AE Profile APIs.io
BreadPay Program API
AE Profile APIs.io
BreadPay Tradein API
AE Profile APIs.io
#Webhooks#Events#CloudEvents#Replay
← Back to B APIs
API Details
ID
bread-financial:webhook-api
Base URL
https://api.platform.breadpayments.com
Docs
https://platform-docs.breadpayments.com/bread-developers/reference/webhook-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=webhook-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/webhook-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 Webhook 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.