BreadwinnerPaymentsAPI is a global class that can be used to make requests to Payment Processors via Breadwinner. As it is a part of the managed package, you must prepend the namespace “bw_payments”.

A method call(Map<String, Object> request) is a static global method within the BreadwinnerPaymentsAPI class, which can be used to make an API request.

bw_payments.BreadwinnerPaymentsAPI.call(Map<String, Object> request);

Breadwinner accepts the request data in the form of Map<String, Object>, and even returns the response data as a Map<String, Object>, thus making the requests and responses dynamic.

For more information, please refer to the Example Requests and Responses section.


Learn about the BreadwinnerPaymentsAPI, a versatile global class for seamless integration with Payment Processors via Breadwinner. Discover how to utilize the static method "call" to effortlessly make API requests, with request and response data in the fl

API Overview

Create Customer

Update Customer

Customer

Create Transaction

Create 3D Secure Transaction

Transaction

Invoice - Stripe

Invoice - Square

Invoice

Subscription - Stripe

Subscription - Square

Subscription

Stripe

Customer Portal Session URL

Checkout URL - Stripe

Checkout URL - Square

Checkout URL

Request

Response

Global API

Create and Charge

Create and Send

Change Status

Delete Draft

Create

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 Subscription - Stripe

Create Subscription - Square

Create Subscription

Create Invoice - Stripe

Create Invoice - Square

Create Invoice

Guided Wizard

Button URL Structure

Button URL Generator

Custom Guided Wizard

Braintree

Square

Auto-match Payment Transactions with Customers

Custom Fields

Additional Configuration

Requirements

ERD / Object Structure

ID Locations

Technical Resources

Getting Help

API Overview

Global Class

Methods