Alliance Data Systems (Bread Financial Holdings)

Alliance Data Systems (Bread Financial Holdings) Transactions API

Manage completed Bread Pay transactions.

GitHub OpenAPI

Operations 8

GET /transactions/{transactionID} Bread Classic Get A Transaction #
PUT /transactions/{transactionID} Bread Classic Update A Transaction #
POST /transaction Bread Pay Create A Transaction #
GET /transaction/{transactionID} Bread Pay Get A Transaction #
POST /transaction/{transactionID}/authorize Bread Pay Authorize A Transaction #
POST /transaction/{transactionID}/cancel Bread Pay Cancel A Transaction #
POST /transaction/{transactionID}/settle Bread Pay Settle A Transaction #
POST /transaction/{transactionID}/refund Bread Pay Refund A Transaction #

Documentation

📖
Documentation
https://platform-docs.breadpayments.com/bread-developers
📖
Authentication
https://platform-docs.breadpayments.com/bread-developers/docs/api-access
📖
APIReference
https://platform-docs.breadpayments.com/bread-developers/reference
📖
Documentation
https://docs.breadpayments.com/bread-classic/reference
📖
GettingStarted
https://docs.breadpayments.com/bread-classic/reference/getting-started-with-your-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/alliance-data-systems/refs/heads/main/openapi/alliance-data-systems-transactions-api-openapi.yml

Other Resources

🔗
Concepts
https://platform-docs.breadpayments.com/bread-developers/docs
🔗
SandboxBaseURL
https://api-preview.platform.breadpayments.com/api
🔗
ProductionBaseURL
https://api.platform.breadpayments.com/api
🔗
Checkout
https://docs.breadpayments.com/bread-classic/docs/bread-checkout
🔗
Testing
https://docs.breadpayments.com/bread-classic/docs/testing-bread
🔗
ManagingTransactions
https://docs.breadpayments.com/bread-classic/docs/managing-bread-transactions

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/alliance-data-systems-transactions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

alliance-data-systems-transactions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Alliance Data Systems Transactions API
  version: '1.0'
  description: 'Operations tagged Transactions across 2 of this provider''s published API definitions: bread-classic-merchant-openapi.yml, bread-pay-platform-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.breadpayments.com
  description: Production
- url: https://api-sandbox.breadpayments.com
  description: Sandbox
- url: https://api.platform.breadpayments.com/api
  description: Production
- url: https://api-preview.platform.breadpayments.com/api
  description: Preview / Sandbox
tags:
- name: Transactions
  description: Manage completed Bread Pay transactions.
paths:
  /transactions/{transactionID}:
    get:
      operationId: getTransactionClassic
      summary: Bread Classic Get A Transaction
      description: Return a Bread transaction object.
      tags:
      - Transactions
      parameters:
      - name: transactionID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Transaction returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassicTransaction'
      security:
      - bearerAuth: []
    put:
      operationId: updateTransactionClassic
      summary: Bread Classic Update A Transaction
      description: Update transaction state (e.g. authorize, cancel, settle, refund) via the legacy Merchant API.
      tags:
      - Transactions
      parameters:
      - name: transactionID
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClassicTransactionUpdate'
      responses:
        '200':
          description: Transaction updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassicTransaction'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.breadpayments.com
      description: Production
    - url: https://api-sandbox.breadpayments.com
      description: Sandbox
  /transaction:
    post:
      operationId: createTransaction
      summary: Bread Pay Create A Transaction
      description: Create a new Bread Pay transaction for an authorized buyer.
      tags:
      - Transactions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionRequest'
      responses:
        '201':
          description: Transaction created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Transaction'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
      security:
      - oauth2ClientCredentials: []
    servers:
    - url: https://api.platform.breadpayments.com/api
      description: Production
    - url: https://api-preview.platform.breadpayments.com/api
      description: Preview / Sandbox
  /transaction/{transactionID}:
    get:
      operationId: getTransaction
      summary: Bread Pay Get A Transaction
      description: Retrieve a single transaction by its unique transaction ID.
      tags:
      - Transactions
      parameters:
      - name: transactionID
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Transaction found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Transaction'
        '401':
          description: Unauthorized
        '404':
          description: Not found
      security:
      - oauth2ClientCredentials: []
    servers:
    - url: https://api.platform.breadpayments.com/api
      description: Production
    - url: https://api-preview.platform.breadpayments.com/api
      description: Preview / Sandbox
  /transaction/{transactionID}/authorize:
    post:
      operationId: authorizeTransaction
      summary: Bread Pay Authorize A Transaction
      description: Authorize a single transaction based on its unique transaction ID, either for the full amount or a partial amount.
      tags:
      - Transactions
      parameters:
      - name: transactionID
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthorizeRequest'
      responses:
        '200':
          description: Transaction authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Transaction'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
        '403':
          description: Request cannot be authorized
        '412':
          description: Precondition failed
        '500':
          description: Resource conflict
        '503':
          description: Service unavailable
      security:
      - oauth2ClientCredentials: []
    servers:
    - url: https://api.platform.breadpayments.com/api
      description: Production
    - url: https://api-preview.platform.breadpayments.com/api
      description: Preview / Sandbox
  /transaction/{transactionID}/cancel:
    post:
      operationId: cancelTransaction
      summary: Bread Pay Cancel A Transaction
      description: Cancel an authorized but un-captured transaction.
      tags:
      - Transactions
      parameters:
      - name: transactionID
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Transaction cancelled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Transaction'
        '401':
          description: Unauthorized
      security:
      - oauth2ClientCredentials: []
    servers:
    - url: https://api.platform.breadpayments.com/api
      description: Production
    - url: https://api-preview.platform.breadpayments.com/api
      description: Preview / Sandbox
  /transaction/{transactionID}/settle:
    post:
      operationId: settleTransaction
      summary: Bread Pay Settle A Transaction
      description: Settle (capture) the funds for an authorized transaction.
      tags:
      - Transactions
      parameters:
      - name: transactionID
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SettleRequest'
      responses:
        '200':
          description: Transaction settled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Transaction'
        '401':
          description: Unauthorized
      security:
      - oauth2ClientCredentials: []
    servers:
    - url: https://api.platform.breadpayments.com/api
      description: Production
    - url: https://api-preview.platform.breadpayments.com/api
      description: Preview / Sandbox
  /transaction/{transactionID}/refund:
    post:
      operationId: refundTransaction
      summary: Bread Pay Refund A Transaction
      description: Refund a previously settled transaction in full or in part.
      tags:
      - Transactions
      parameters:
      - name: transactionID
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefundRequest'
      responses:
        '200':
          description: Refund processed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Transaction'
        '401':
          description: Unauthorized
      security:
      - oauth2ClientCredentials: []
    servers:
    - url: https://api.platform.breadpayments.com/api
      description: Production
    - url: https://api-preview.platform.breadpayments.com/api
      description: Preview / Sandbox
components:
  schemas:
    ClassicTransaction:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        status:
          type: string
          enum:
          - PENDING
          - AUTHORIZED
          - SETTLED
          - CANCELLED
          - REFUNDED
        amount:
          type: integer
        currency:
          type: string
        merchantId:
          type: string
        createdAt:
          type: string
          format: date-time
    ClassicTransactionUpdate:
      type: object
      properties:
        type:
          type: string
          enum:
          - authorize
          - cancel
          - settle
          - refund
        amount:
          type: integer
    SettleRequest:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/Amount'
        merchantNote:
          type: string
          maxLength: 512
    AuthorizeRequest:
      type: object
      required:
      - amount
      properties:
        amount:
          $ref: '#/components/schemas/Amount'
        isVirtualCard:
          type: boolean
          default: false
        merchantOfRecordID:
          type: string
          format: uuid
        merchantNote:
          type: string
          maxLength: 512
    RefundRequest:
      type: object
      required:
      - amount
      properties:
        amount:
          $ref: '#/components/schemas/Amount'
        reason:
          type: string
    TransactionRequest:
      type: object
      required:
      - amount
      - buyerId
      properties:
        amount:
          $ref: '#/components/schemas/Amount'
        buyerId:
          type: string
          format: uuid
        merchantOfRecordID:
          type: string
          format: uuid
        merchantNote:
          type: string
          maxLength: 512
    Transaction:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
          - PENDING
          - AUTHORIZED
          - SETTLED
          - CANCELLED
          - REFUNDED
          - EXPIRED
        amount:
          $ref: '#/components/schemas/Amount'
        buyerId:
          type: string
          format: uuid
        merchantOfRecordID:
          type: string
          format: uuid
        createdOn:
          type: string
          format: date-time
        modifiedOn:
          type: string
          format: date-time
    Amount:
      type: object
      required:
      - value
      - currency
      properties:
        value:
          type: integer
          description: Amount in minor units (e.g. cents).
        currency:
          type: string
          example: USD
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bread Merchant Portal access token (legacy scheme).
    oauth2ClientCredentials:
      type: oauth2
      description: OAuth 2.0 Client Credentials flow using API + Secret keys issued from the Bread Merchant Portal.
      flows:
        clientCredentials:
          tokenUrl: https://auth.platform.breadpayments.com/auth/sso/token
          scopes:
            transactions:read: Read transactions
            transactions:write: Create, authorize, settle, refund transactions
            buyers:read: Read buyer records
x-refined-from:
- bread-classic-merchant-openapi.yml
- bread-pay-platform-openapi.yml