# BreadPay Payments API

**Canonical:** https://apis.io/apis/bread-financial/payments-api/  
**Provider:** Bread Financial — https://apis.io/providers/bread-financial/  
**Base URL:** https://api.platform.breadpayments.com  
**Documentation:** https://platform-docs.breadpayments.com/bread-developers/reference/payments-introduction

BreadPay Payments API is one of 13 APIs that [Bread Financial](https://apis.io/providers/bread-financial/) publishes on the [APIs.io](https://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.

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.

## Operations (21)

| Method | Path | Summary |
|---|---|---|
| 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 |
| 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 |
| GET | `/api/payments/refund` | List Refunds |
| GET | `/api/payments/refund/{refundReferenceID}` | Get Refund |
| PUT | `/api/payments/payment/receive` | Receive a payment |
| PUT | `/api/payments/payment/reverse` | Reverse Payment |
| GET | `/api/payments/cybersource` | Search Payment in Cybersource |
| PUT | `/api/payments/refund/stop-paper-check` | stop refund paper check |
| 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 |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/bread-financial/refs/heads/main/openapi/bread-payments-openapi.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/bread-financial/refs/heads/main/overlays/bread-payments-overlay.yaml
- **DeclineCodes** — https://raw.githubusercontent.com/api-evangelist/bread-financial/refs/heads/main/errors/bread-decline-codes.yml

## Other Bread Financial APIs (12)

- [BreadPay Platform API](https://apis.io/apis/bread-financial/breadpay-platform-api/)
- [Bread Pay API](https://apis.io/apis/bread-financial/bread-pay-api/)
- [Bread SplitPay API](https://apis.io/apis/bread-financial/split-pay-api/)
- [BreadPay Checkout API](https://apis.io/apis/bread-financial/bread-pay-api/)
- [Bread SplitPay](https://apis.io/apis/bread-financial/split-pay-api/)
- [BreadPay Merchant Operations API](https://apis.io/apis/bread-financial/merchant-operations-api/)
- [BreadPay Servicing API](https://apis.io/apis/bread-financial/servicing-api/)
- [BreadPay Buyer Management API](https://apis.io/apis/bread-financial/buyer-management-api/)
- [BreadPay Foundations API](https://apis.io/apis/bread-financial/foundations-api/)
- [BreadPay Webhook API](https://apis.io/apis/bread-financial/webhook-api/)
- [BreadPay Program API](https://apis.io/apis/bread-financial/program-api/)
- [BreadPay Tradein API](https://apis.io/apis/bread-financial/tradein-api/)

## Tags

Payment Methods, Tokenization, ACH, Network Tokens

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/bread-financial/payments-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/bread-financial/.