Broadleaf Microservices
  • v1.0.0-latest-prod

PayPal Checkout-js Types

PayPalButtonColor (Enum)

Name Value Description

GOLD

'gold'

BLUE

'blue'

SILVER

'silver'

WHITE

'white'

BLACK

'black'

PayPalButtonLabel (Enum)

Name Value Description

CHECKOUT

'CHECKOUT'

CREDIT

'CREDIT'

PAY

'pay'

BUY_NOW

'buynow'

PAYPAL

'paypal'

INSTALLMENT

'installment'

PayPalButtonLayout (Enum)

Name Value Description

HORIZONTAL

'horizontal'

VERTICAL

'vertical'

PayPalButtonShape (Enum)

Name Value Description

PILL

'pill'

RECT

'rect'

PayPalFundingType (Enum)

Name Value Description

PAYPAL

'PAYPAL'

CARD

'CARD'

PAYLATER

'PAYLATER'

CREDIT

'CREDIT'

VENMO

'VENMO'

PayPalItemCategory (Enum)

Name Value Description

DIGITAL_GOODS

'DIGITAL_GOODS'

PHYSICAL_GOODS

'PHYSICAL_GOODS'

PayPalPaymentDisbursementMode (Enum)

Name Value Description

INSTANT

'INSTANT'

DELAYED

'DELAYED'

PayPalPaymentIntent (Enum)

Name Value Description

AUTHORIZE

'AUTHORIZE'

CAPTURE

'CAPTURE'

PayPalPhoneType (Enum)

Name Value Description

FAX

'FAX'

HOME

'HOME'

MOBILE

'MOBILE'

OTHER

'OTHER'

PAGE

'PAGE'

PayPalShippingSource (Enum)

Name Value Description

GET_FROM_FILE

'GET_FROM_FILE'

NO_SHIPPING

'NO_SHIPPING'

SET_PROVIDED_ADDRESS

'SET_PROVIDED_ADDRESS'

PayPalShippingType (Enum)

Name Value Description

PICKUP_IN_PERSON

'PICKUP_IN_PERSON'

SHIPPING

'SHIPPING'

PayPalTaxIdType (Enum)

Name Value Description

BR_CPF

'BR_CPF'

The individual tax ID type, typically is 11 characters long.

BR_CNPJ

'BR_CNPJ'

The business tax ID type, typically is 14 characters long.

PayPalUserAction (Enum)

Name Value Description

PAY_NOW

'PAY_NOW'

CONTINUE

'CONTINUE'

ShippingDetailWithContactInfo

extends ShippingDetail

Property Type Description

email_address

string

The email address for this shipping detail.

phone_number

{country_code: string, national_number: string}

The phone number for this shipping detail.

PurchaseUnitWithContactInfo

extends PurchaseUnit

Property Type Description

shipping

ShippingDetailWithContactInfo

The shipping detail with contact module information.

CreateOrderRequestBodyWithModules

extends CreateOrderRequestBody

Property Type Description

payment_source

Extension to support all properties of the experience_context for the payment sources. For example, this supports contact_preference for PayPal’s Contact Module, app_switch_preference for App Switch functionality, and order_update_callback_config to support PayPal’s Shipping Module with server-side shipping callbacks. For more details, see PayPal’s experience context definition.

OrderResponseBodyWithModules

extends OrderResponseBody

Property Type Description

purchase_units

PurchaseUnitWithContactInfo[]

The purchase unit with contact module information.