BreadPay Payments API
Stored payment methods and their access and transient tokens, ACH account unblocking, network token retrieval, payment execution and audit, refunds and payment reversal. 21 operations.
BreadPay Payments 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 Payment Methods, Tokenization, ACH, and Network Tokens. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 21 operations across 19 paths, organized into 3 resource areas, and defines 113 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/.
21 operations
19 paths
113 schemas
1 DELETE10 GET3 POST7 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 21
Across 19 paths, the API surfaces 21 operations — 1 DELETE, 10 GET, 3 POST, 7 PUT. They span 3 resource areas: Payment Methods, Payments, Refunds. Each is listed below with its method, path, parameters, and response codes.
Payment Methods 10
POST
/api/payments/payment-method
Create Payment Method
GET
/api/payments/payment-method
List Payment Methods
GET
/api/payments/payment-method/{paymentMethodID}
Get Payment Method
DELETE
/api/payments/payment-method/{paymentMethodID}
Delete Payment Method
PUT
/api/payments/payment-method/unblock-ach-account
Unblock ACH Account
POST
/api/payments/payment-method/access-token
Create Payment Method Access Token
POST
/api/payments/payment-method/transient-token
Create cybersource transient token
GET
/api/payments/payment-method/failure/
List Payment Method Failures
PUT
/api/payments/payment-method/network-token
Search Network Token in VGS for Card Payment Method
GET
/api/payments/payment-method/bank-account
List bank accounts by routing and last4
Payments 8
GET
/api/payments/payment/{referenceID}
Get Payment
GET
/api/payments/payment/bank-id/{ID}
Get Payment by either transaction id or reconciliation id
PUT
/api/payments/payment/cancel
Cancel a payment
PUT
/api/payments/payment/fail-single-payment
Fail Single Payment
GET
/api/payments/payment/{referenceID}/audit
Lists Payment Audit Records
PUT
/api/payments/payment/receive
Receive a payment
PUT
/api/payments/payment/reverse
Reverse Payment
GET
/api/payments/cybersource
Search Payment in Cybersource
Refunds 3
GET
/api/payments/refund
List Refunds
GET
/api/payments/refund/{refundReferenceID}
Get Refund
PUT
/api/payments/refund/stop-paper-check
stop refund paper check
Schemas 113
The contract defines 113 schemas that model the data the API accepts and returns. The most detailed are Payment (21 properties), PaymentMethod (17 properties), PaymentMethodFailure (17 properties), BankAccount (15 properties). Each schema is shown below with its type and property counts.
AccessTokenProvider
string
This is the access token provider used to interact with third-party payment methods.
BankAccount
object
Details about a bank account payment method.
15 properties
11 required
SetupType
string
Identifies the way funds are transferred.
BankConnection
object
Details about a connection to a third party for this bank account.
11 properties
BankConnectionStatus
string
This is the status of a connection to a bank account from a third party authorization program.
BankProvider
string
This is the third party authorization program used to authorize the bank account.
CardAccount
object
Details about a card account payment method.
12 properties
5 required
CardType
string
The type of card that is being used.
CardConnection
object
Details about the connection to the third party for this card account.
6 properties
CardConnectionStatus
string
This is the status of the card account provided by a third party processor.
CardProvider
string
This is the name of the third party processor that is being used for the card account.
CheckPayment
object
Details about a check payment payment method.
7 properties
ManualPayment
object
Details about a manual payment method.
5 properties
ExternalCollection
object
Details about an external collection payment method.
6 properties
TradeInCredit
object
Details about a trade in credit payment method.
4 properties
PaperCheck
object
PaperCheckDetails
object
11 properties
CreateBankAccount
object
A request to create a bank account. Will be used as part of the CreatePaymentMethodRequest.
7 properties
7 required
CreateBankAccountAuthenticated
object
A request to create a bank account with a third party. Will be used as part of the CreatePaymentMethodRequest.
3 properties
CreateCardAccount
object
A request to create a card account. Will be used as part of the CreatePaymentMethodRequest.
6 properties
CreateCheckPayment
object
A request to create a check payment. Will be used as part of the CreatePaymentMethodRequest.
4 properties
CreateManualPayment
object
A request to create a manual payment. Will be used as part of the CreatePaymentMethodRequest.
2 properties
CreateExternalCollection
object
A request to create an external collection payment method. Will be used as part of the CreatePaymentMethodRequest.
3 properties
CreateTradeInCredit
object
A request to create a trade in credit. Will be used as part of the CreatePaymentMethodRequest.
1 property
CreatePaperCheck
object
A request to create a paper check. Will be used as part of the CreatePaymentMethodRequest.
CreatePaymentMethodRequest
object
A request to create a payment method. Only one of the sub models, BankAccount and CardAccount, should be used, and paymentMethodType should identify which one…
13 properties
2 required
CreatePaymentMethodResponse
object
A response object for a created payment method.
1 property
CreatePaymentMethodAccessTokenRequest
object
A request to create a payment method access token.
5 properties
2 required
CreatePaymentMethodTransientTokenRequest
object
A request to create a payment method transient token.
2 properties
1 required
ReceivePaymentRequest
object
A request to receive a payment based on given referenceId or transactionId
2 properties
FailSinglePaymentRequest
object
A request to fail a payment based on given referenceId or transactionId
3 properties
CancelPaymentRequest
object
A request to cancel a payment based on given referenceId
1 property
GetNetworkTokenRequest
object
A request to retrieve and store VGS network token
1 property
CreatePaymentMethodAccessTokenResponse
object
A response object for a created payment method access token.
1 property
CreatePaymentMethodTransientTokenResponse
object
A response object for a created payment method transient token.
1 property
DeletePaymentMethodResponse
object
A response object for a deleted payment method.
UnblockACHAccountRequest
object
A request to unblock an ACH bank account payment method.
2 properties
2 required
UnblockACHAccountResponse
object
A response object for an unblocked ACH bank account.
GetPaymentResponse
object
A response object for a payment get request.
1 property
GetPaymentMethodResponse
object
A response object for a payment method get request.
1 property
ListPaymentAuditResponse
object
A response object for a payment audit get request.
1 property
ListPaymentMethodsResponse
object
A response object for a payment method list request.
1 property
1 required
ListPaymentsResponse
object
A response object for any request which returns a list of payments.
1 property
1 required
ListPaymentMethodFailuresResponse
object
A response object for a payment method failure list request.
1 property
1 required
FailSinglePaymentResponse
object
A response object for a fail single payment request.
1 property
CancelPaymentResponse
object
A response object for a cancel payment request.
1 property
1 required
ReceivePaymentResponse
object
A response object for a receive payment request.
1 property
ReversePaymentRequest
object
A request to reverse a payment.
3 properties
3 required
StopPaperCheckRequest
object
A request to stop a refund paper check.
1 property
1 required
ReversePaymentResponse
object
A response object for a reverse payment request.
3 properties
SearchCybersourceResponse
object
A JSON string for a search cybersource request.
1 property
Payment
object
An object that represents a payment model.
21 properties
OwnerEntityType
string
Identifies information about the caller making the payment.
SourceType
string
Identifies how the payment was originated.
SubSourceType
string
Identifies additional source type information.
Status
string
Identifies the processing status of a payment. Note: FAILED is deprecated in favor of RETURNED
SubStatus
string
Identifies additional payment status information.
TransactionType
string
Identifies whether the payment was a credit or a debit.
PaymentAudit
object
An object that represents a payment audit model.
9 properties
PaymentMethod
object
An object that represents a payment method model. Only one of the sub models, BankAccount and CardAccount, will exist and will be identified by paymentMethodTy…
17 properties
5 required
PaymentMethodType
string
A high level category of the form of payments.
ScopeType
string
Identifies the owner of the payment method.
PaymentMethodAccessToken
object
An object that represents a payment method access token model.
4 properties
PaymentMethodTransientToken
object
An object that represents a payment method transient token model.
1 property
PaymentMethodFailure
object
An object that represents a recorded request failure to create a payment method, along with its error response. The paymentMethodType field will indicate the t…
17 properties
7 required
BankAccountFailure
object
Details about a bank account payment method failure.
7 properties
CardAccountFailure
object
Details about a card account payment method failure.
3 properties
BankAccountAuthenticatedFailure
object
Details about an authenticated bank account payment method failure.
3 properties
CheckPaymentFailure
object
Details about a check payment payment method failure.
4 properties
ExternalCollectionFailure
object
Details about an external collection payment method failure.
3 properties
TradeInCreditFailure
object
Details about a trade-in credit payment method failure.
1 property
ManualPaymentFailure
object
Details about a manual payment payment method failure.
2 properties
PaperCheckFailure
object
Details about a paper check payment method failure.
ListRefundsResponse
object
A response object for a refund list request.
1 property
Refund
object
An object that represents a refund model.
9 properties
GetRefundResponse
object
A response object for a refund get request.
1 property
RefundSourceType
string
Identifies how the refund was originated.
RefundStatus
string
Identifies the processing status of a refund.
ReversePaymentResultType
string
Identifies the result type of a payment reversal.
CardInfo
object
Details about a card account for creating transient token
5 properties
5 required
PostalCode
string
Postal code for billing address
StopPaperCheckResponse
object
A response object for a stopped paper check.
1 property
GetNetworkTokenResponse
object
Response object for get network token
2 properties
NetworkToken
string
Network token for a card payment method
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
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Bread Financial 12
Other APIs Bread Financial publishes across the network.
BreadPay Platform API
Bread Pay API
Bread SplitPay API
BreadPay Checkout API
Bread SplitPay
BreadPay Merchant Operations API
BreadPay Servicing API
BreadPay Buyer Management API
BreadPay Foundations API
BreadPay Webhook API
BreadPay Program API
BreadPay Tradein API
#Payment Methods#Tokenization#ACH#Network Tokens
Where this information came from
This is an independent, third-party profile of BreadPay Payments 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.