Global API

Request

4min

Request Types
Breadwinner Payments currently connects with the Stripe, Braintree, and Square Payment gateways.
Building Requests
Breadwinner accepts requests in the form of a Map<String, Object>.
These are the supported keys:
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
﻿
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.
Actions
﻿
Stripe
Square
Braintree
﻿
createCustomer
                Yes
                Yes
                 Yes
updateCustomer
                Yes
                Yes
                 Yes
chargeCustomer (createTransaction)
                Yes
                Yes
                 Yes
createSubscription
                Yes
                No
No supported by processor
Examples
﻿See the related actions in the left menu for examples.

Updated 22 Feb 2023

Did this page help you?

TABLE OF CONTENTS

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	No supported by processor