Global API
Request

Customer

2min

When processing a Customer, use the requestJSON to pass in the Customer data. The returned response will contain a responseJSON section with the Customer response returned by Breadwinner Payments.

The Customer object has the following properties.

Customer

Field Name

Data Type

Description

customerName

String

Supported by Stripe only

firstName

String



lastName

String



email

String



customerPhone

String



description

String



company

String



processorCustomerId

String

Required while updating the Customer (Find this).

billingStreetAddress1

String



billingStreetAddress2

String



billingCity

String



billingState

String



billingCountry

String



billingPostalCode

String



salesforceAccount

String



invoicePrefix

String

Supported by Stripe only

language

String

Supported by Stripe only

taxType

String

Supported by Stripe only

taxId

String

Supported by Stripe only

taxExempt

String

Supported by Stripe only

salesforceId

String

readOnly field

processorType

String

readOnly field

processorOrgName

String

readOnly field

processorOrgId

String

readOnly field

liveMode

Boolean

readOnly field

createdVia

String

readOnly field

readOnly field

createdDateInProcessor

DateTime

readOnly field

shippingStreetAddress1

String

readOnly field

shippingStreetAddress2

String

readOnly field

shippingState

String

readOnly field

shippingCity

String

readOnly field

shippingCountry

String

readOnly field

shippingPhone

String

readOnly field

shippingPostalCode

String

readOnly field

  • company is supported for Square and Braintree, not for Stripe.
  • Address fields are not supported for Braintree.
  • Currently, Only Billing address fields can be updated to Processor.



Updated 05 Dec 2023
Doc contributor
Did this page help you?