BreadPay Merchant Operations 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 Transactions, Settlement, Refunds, Reporting, and Carts. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
32 operations
across 26 paths,
organized into 3 resource areas,
and defines 89 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/.
The identity and technical contract details declared by the specification.
TransactionMetadata
object
Metadata is a JSON field available to merchants for storing external data on a Transaction Metadata keys have a max size of 128, and there can be up to 50 keys…
TransactionListSort
string
The possible sort keys for listing Transactions
TransactionStatus
string
The possible statuses of a Transaction
ExternalID
string
An identifier that has significance to the Merchant allowing the transaction to be associated with the Merchant’s systems.
Transaction
object
Transaction is a representation of a single transaction
33 properties
31 required
TransactionHistoryType
string
The type of action that was performed for a given part of a transaction's history.
TransactionHistory
object
An action that was performed on a transaction.
8 properties
8 required
KPI
object
A key performance indicator for a particular transaction status. This is an aggregation across many transactions.
7 properties
7 required
Aggregation
object
An instance of an aggregated object
2 properties
2 required
AggregationTerm
string
The possible aggregation terms
UpdateRequest
object
Object to modify an existing transaction.
2 properties
ActionRequest
object
Object for performing actions like authorizations, refunds, and cancellations.
4 properties
1 required
Pagination
object
Result pagination values
3 properties
TransactionList
object
all metadata and data related to a requested report
7 properties
AggregationList
object
1 property
1 required
KPIList
object
An array of key performance indicators
1 property
1 required
TransactionHistoryList
object
An array containing the points of history in a single transaction.
1 property
1 required
FulfillmentDetail
object
Fulfillment detail, carrier and tracking number, for a transaction
5 properties
4 required
FulfillmentDetailRequest
object
2 properties
1 required
FulfillmentDetailList
object
An array containing all the fulfillment details for a single transaction.
1 property
1 required
CreateCart
object
Payload that is sent to the Cart service to create a Cart
13 properties
3 required
CartContact
object
Represents buyer information that is associated with the Cart object
5 properties
4 required
CartID
string
CartID associated with a Cart
CheckoutCompleteURL
string
URL that the customer is redirected to following a successful checkout
CallbackURL
string
Where we'll POST the transactionID of the checkout and the orderRef following a successful checkout.
CheckoutErrorURL
string
URL the user is redirected to if checkout fails
CheckoutURL
string
URL to Checkout using the associated Cart
CartStatus
string
The current status of the Cart. Generated when returning a Cart object.
OrderReference
string
Unique identifier provided by the merchant. Appended to the CheckoutCompleteURL after a Cart is complete.
CartListSort
string
The possible sort keys for listing Carts
PageLimit
string
The maximum number of records that will be returned in a result set.
PageOffset
string
The number of records to skip before starting to collect the result set. Used in conjunction with limit query parameter for pagination support
PageTotal
string
The total number of records in the result set
CartUpdate
object
Object to modify an existing Cart
9 properties
CartResponse
object
Cart object
14 properties
ListCart
object
Cart object for list
10 properties
PageInfo
object
Describes the limit, offset and total records in the current request
3 properties
CartListResponse
object
2 properties
CartDisclosure
object
Disclosure object
2 properties
ReportingError
Default error model for Reporting errors.
LoanHistoryReport
object
all metadata and data related to a requested report
7 properties
2 required
DataInsightReport
object
all metadata and data related to a requested report
7 properties
2 required
Schema
object
dictates the Header row of a CSV response
1 property
Field
object
describes a field of data returned
2 properties
1 required
LoanValue
object
the total value of all loans
2 properties
LoanVolume
object
the total volume of all loans
2 properties
1 required
LoanAggregate
object
aggreagtion of transaction loan data
4 properties
DataInsightPoint
object
aggregate data point for the given date or date range
11 properties
8 required
Aggregate
object
aggregate data for the given date or date range
11 properties
8 required
ValuePerPPType
object
shows the total values per payment product type
4 properties
1 required
LoanHistory
object
Loan history for a given merchantID and date range
6 properties
DataInsight
object
Data insight for a given merchantID and date range
4 properties
FundingAggregateSummary
object
A summary of the funding data
7 properties
TransactionError
Default error model for ListTransaction errors.
FundingDailySummaryList
object
A summary of daily funding data
7 properties
TargetingExportList
object
all metadata and data related to a targeting export report
7 properties
SettlementReportList
object
all metadata and data related to a settlement report
7 properties
LegacySettlementReport
object
2 properties
LegacySettlementReportEntry
object
Settlement report entry is a record of an individual funding event.
27 properties
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
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Bread Financial publishes across the network.
