Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.3",
"info": {
"title": "Merchant Operations",
"description": "Merchants Operations enables merchants to manage their transactions including authorizing purchases, settling them as well as additional actions like refund and cancellations.",
"version": "2.0.0",
"contact": {
"email": "partnership-growth@getbread.com"
}
},
"servers": [
{
"url": "https://api-preview.platform.breadpayments.com/",
"description": "Preview environment"
},
{
"url": "https://api.platform.breadpayments.com/",
"description": "Production environment"
}
],
"paths": {
"/api/transaction/application/{applicationID}": {
"get": {
"tags": [
"Transaction"
],
"summary": "Get Transaction by Application ID",
"description": "Get a single transaction based on a provided application ID.",
"operationId": "getTransactionByApplicationID",
"security": [
{
"bearerAuthTransaction": [
"r:tx"
]
}
],
"parameters": [
{
"name": "applicationID",
"in": "path",
"description": "The Application ID used to create the transaction",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
}
],
"responses": {
"200": {
"description": "Data for a single transaction.",
"content": {
"application/json": {
"schema": {
"description": "Transaction is a representation of a single transaction",
"required": [
"adjustedAmount",
"applicationID",
"billingContact",
"buyerID",
"createdAt",
"discountAmount",
"expirationExtended",
"externalID",
"id",
"merchantID",
"metadata",
"paymentAgreementID",
"paymentProductID",
"merchantPaymentProductValuesID",
"productType",
"programID",
"merchantProgramValuesID",
"refundedAmount",
"chargedbackAmount",
"cancelledAmount",
"settledAmount",
"overflowAmount",
"shippingAmount",
"shippingContact",
"status",
"taxAmount",
"tenantID",
"isCarts",
"totalAmount",
"revision",
"updatedAt"
],
"properties": {
"adjustedAmount": {
"description": "The transaction amount after adjustments.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"applicationID": {
"description": "The application ID used to make the transaction",
"allOf": [
{
"type": "string",
"format": "uuid",
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
]
},
"billingContact": {
"description": "The contact information of the person being billed.",
"allOf": [
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"required": [
"familyName",
"givenName"
],
"type": "object",
"properties": {
"givenName": {
"type": "string",
"description": "Given name",
"example": "John"
},
"familyName": {
"type": "string",
"description": "Family name",
"example": "Doe"
},
"additionalName": {
"type": "string",
"description": "Additional name, if any"
}
},
"description": "Represents the full name"
},
"phone": {
"type": "string",
"description": "Telephone number including country code",
"example": "+14539842345"
},
"address": {
"required": [
"address1",
"locality",
"postalCode",
"region",
"country"
],
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "First address line",
"example": "156 5th Avenue"
},
"address2": {
"type": "string",
"description": "Second address line"
},
"locality": {
"type": "string",
"description": "The locality (e.g. City) of the address.",
"example": "New York"
},
"postalCode": {
"type": "string",
"description": "The administrative postal code (e.g. Zip Code)",
"example": "10019"
},
"region": {
"type": "string",
"description": "The region or first-level administration division (e.g. State/Province) of the address.",
"example": "US-NY",
"minLength": 2,
"externalDocs": {
"description": "ISO-3166-2",
"url": "https://en.wikipedia.org/wiki/ISO_3166-2"
}
},
"country": {
"type": "string",
"description": "The two character ISO-3166-1 country code.",
"example": "US",
"minLength": 2,
"maxLength": 2,
"externalDocs": {
"description": "ISO-3166-1",
"url": "https://en.wikipedia.org/wiki/ISO_3166-1"
}
}
},
"description": "Represents a fully defined address for an entity"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address",
"example": "john.doe@gmail.com"
}
},
"description": "Represents contact information for an entity"
}
]
},
"buyerID": {
"description": "The ID of the buyer for the transaction.",
"allOf": [
{
"type": "string",
"format": "uuid",
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
]
},
"createdAt": {
"description": "The date and time the transaction was created.",
"allOf": [
{
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
}
]
},
"discountAmount": {
"description": "The amount by which the transaction was discounted.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"expirationExtended": {
"type": "boolean",
"description": "Whether the expiration has been extended for this transaction"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "The timestamp value formatted per RFC3339. This does not allow nulls.",
"example": "2020-12-31T15:10:55Z",
"externalDocs": {
"description": "RFC3339",
"url": "https://datatracker.ietf.org/doc/html/rfc3339#section-5.6"
}
},
"externalID": {
"type": "string",
"description": "An identifier that has significance to the Merchant allowing the transaction to be associated with the Merchant’s systems.",
"example": "55ed9cfd-f01e-487d-8d1a-6d0608189796"
},
"id": {
"description": "The ID of the transaction",
"allOf": [
{
"type": "string",
"format": "uuid",
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
]
},
"locationID": {
"description": "The location the transaction was fulfilled at.",
"allOf": [
{
"type": "string",
"format": "uuid",
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
]
},
"merchantID": {
"description": "The ID of the merchant that sells the transacted item.",
"allOf": [
{
"type": "string",
"format": "uuid",
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
]
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Metadata is a JSON field available to merchants for storing external data on a Transaction\nMetadata keys have a max size of 128, and there can be up to 50 keys total. The max value size for a key is 5000.",
"example": {
"externalMerchantData": "externalInfo"
}
},
"paymentAgreementID": {
"description": "The ID of the payment agreement.",
"allOf": [
{
"type": "string",
"format": "uuid",
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
]
},
"paymentProductID": {
"description": "The ID of the specific loan product used to make this transaction.",
"allOf": [
{
"type": "string",
"format": "uuid",
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
]
},
"merchantPaymentProductValuesID": {
"description": "The ID of the merchant payment product values that should be used with this transaction.",
"allOf": [
{
"type": "string",
"format": "uuid",
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
]
},
"productType": {
"description": "The kind of the type of loan / payment product used to make this transaction.",
"allOf": [
{
"type": "string",
"description": "The type of payment product",
"enum": [
"INSTALLMENTS",
"SPLITPAY",
"DEBT_CONSOLIDATION",
"PERSONAL_LOAN",
"HYBRID_LINE_OF_CREDIT"
],
"example": "INSTALLMENTS"
}
]
},
"programID": {
"description": "The ID of the program the payment product is under.",
"allOf": [
{
"type": "string",
"format": "uuid",
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
]
},
"merchantProgramValuesID": {
"description": "The ID of the merchant program values that should be used with this transaction.",
"allOf": [
{
"type": "string",
"format": "uuid",
"description": "A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.",
"example": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
"externalDocs": {
"description": "RFC4122",
"url": "https://datatracker.ietf.org/doc/html/rfc4122.html"
}
}
]
},
"refundedAmount": {
"description": "The amount that has been refunded for this transaction.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"chargedbackAmount": {
"description": "The amount that has been chargedback for this transaction.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"cancelledAmount": {
"description": "The amount that has been cancelled for this transaction.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"settledAmount": {
"description": "The amount that's been settled between the buyer and merchant for this transaction.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"overflowAmount": {
"description": "The amount that has been paid on creation of the transaction (i.e., a downpayment).",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
"shippingAmount": {
"description": "The cost of shipping the transacted item.",
"allOf": [
{
"required": [
"currency",
"value"
],
"properties": {
"currency": {
"type": "string",
"description": "The three letter currency code as defined in ISO 4217.",
"example": "USD",
"minLength": 3,
"maxLength": 3,
"externalDocs": {
"description": "ISO 4217",
"url": "https://en.wikipedia.org/wiki/ISO_4217"
}
},
"value": {
"type": "integer",
"description": "Monetary value as an integral number of the currency fractional unit e.g for USD: cents",
"format": "int64",
"example": 100
}
},
"description": "Represents a monetary amount in the specified currency",
"example": {
"currency": "USD",
"value": 50000
}
}
]
},
# --- truncated at 32 KB (2661 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bread-financial/refs/heads/main/openapi/bread-merchant-operations-openapi.json