Breadwinner Payments currently connects with the Stripe, Braintree, and Square Payment gateways.

Breadwinner accepts requests in the form of a Map<String, Object>.

Breadwinner Payments Global API currently supports the creating and updating of Customers and also charging the Customer actions.

See the table below to see actions supported for each processor.

See the related actions in the left menu for exam

Learn how Breadwinner Payments seamlessly integrates with popular payment gateways like Stripe, Braintree, and Square. This document covers the essential keys required to build requests, including version, action, requestJSON, and processorId. Discover su

API Overview

Request

Create Customer

Update Customer

Customer

Breadwinner Payments Docs

App Installation

Connect to Stripe

Connect to Braintree

Connect to Square

Connect to Payment Processor

Customer Match

Update Page Layouts

Getting Started

Create Transaction

Create Subscription - Stripe

Create Subscription - Square

Create Subscription

Create Invoice - Stripe

Create Invoice - Square

Create Invoice

Guided Wizard

Transaction

Invoice

Button URL Structure

Button URL Generator

Custom Guided Wizard

Braintree

Square

Stripe

Auto-match Payment Transactions with Customers

Custom Fields

Additional Configuration

Subscription

Customer Portal Session URL

Checkout URL

Response

Global API

Requirements

ERD / Object Structure

ID Locations

Technical Resources

Getting Help

Key (String)	Value (Object)	Required
version	'1.0'	True
action	See the list of available actions below.	True
requestJSON	Pass the data as a JSON string, based on the specified action	True
processorId	ID of the processor the request should be sent to (Find this)	True

	Stripe	Square	Braintree
createCustomer	Yes	Yes	Yes
updateCustomer	Yes	Yes	Yes
chargeCustomer (createTransaction)	Yes	Yes	Yes
createSubscription	Yes	No	Not supported by processor

Request

Request Types

Building Requests

Actions

Examples