Serialized Form

Package com.broadleafcommerce.paypal.micro.domain.api

Class com.broadleafcommerce.paypal.micro.domain.api.PayPalErrorResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

debugId

String debugId

informationLink

String informationLink

message

String message

name

String name

Package com.broadleafcommerce.paypal.micro.exception

Class com.broadleafcommerce.paypal.micro.exception.PayPalInvalidRequestStateException extends RuntimeException implements Serializable

Package com.broadleafcommerce.paypal.micro.gateway.domain.orders

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.AddressPortable extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

addressLine1

String addressLine1

The first line of the address, such as number and street, for example, "173 Drury Lane". Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.

addressLine2

String addressLine2

The second line of the address, for example, a suite or apartment number.

adminArea1

String adminArea1

The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, "CA" and not "California". Value, by country, is:

• UK. A county.
• US. A state.
• Canada. A province.
• Japan. A prefecture.
• Switzerland. A kanton.

adminArea2

String adminArea2

A city, town, or village. Smaller than "admin_area_level_1".

countryCode

String countryCode

The 2-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is "GB" and not "UK" as used in the top-level domain names for that country. Use the "C2" country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

postalCode

String postalCode

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.AmountBreakdown extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

discount

Money discount

The discount for all items within a given "purchase_unit". "discount.value" can not be a negative number.

handling

Money handling

The handling fee for all items within a given "purchase_unit". "handling.value" can not be a negative number.

insurance

Money insurance

The insurance fee for all items within a given "purchase_unit". "insurance.value" can not be a negative number.

itemTotal

Money itemTotal

The subtotal for all items. Required if the request includes "purchase_units[].items[].unit_amount". Must equal the sum of ("items[].unit_amount * items[].quantity") for all items. "item_total.value" can not be a negative number.

shipping

Money shipping

The shipping fee for all items within a given "purchase_unit". "shipping.value" can not be a negative number.

shippingDiscount

Money shippingDiscount

The shipping discount for all items within a given "purchase_unit". "shipping_discount.value" can not be a negative number.

taxTotal

Money taxTotal

The total tax for all items. Required if the request includes "purchase_units.items.tax". Must equal the sum of ("items[].tax * items[].quantity") for all items. "tax_total.value" can not be a negative number.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.AmountWithBreakdown extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amountBreakdown

AmountBreakdown amountBreakdown

The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.

currencyCode

String currencyCode

The three-character ISO-4217 currency code that identifies the currency.

value

String value

The value, which might be:

• An integer for currencies like "JPY" that are not typically fractional.
• A decimal fraction for currencies like "TND" that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.AuthenticationResult extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

liabilityShift

String liabilityShift

Liability shift indicator. The outcome of the issuer's authentication. The possible values are:

• "YES". Liability has shifted to the card issuer. Available only after order is authorized or captured.
• "NO". Liability is with the merchant.
• "POSSIBLE". Liability may shift to the card issuer. Available only before order is authorized or captured.
• "UNKNOWN". The authentication system is not available.

threeDSecure

ThreeDSecureAuthentication threeDSecure

Results of 3D Secure Authentication.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Authorization extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

Money amount

The amount for this authorized payment.

authorizationStatusDetails

AuthorizationStatusDetails authorizationStatusDetails

The details of the authorized order pending status.

createTime

String createTime

The date and time when the transaction occurred, in Internet date and time format.

customId

String customId

The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

expirationTime

String expirationTime

The date and time when the authorized payment expires, in Internet date and time format.

id

String id

The PayPal-generated ID for the authorized payment.

invoiceId

String invoiceId

The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.

links

List<LinkDescription> links

An array of related HATEOAS links.

sellerProtection

SellerProtection sellerProtection

The level of protection offered as defined by PayPal Seller Protection for Merchants.

status

String status

The status for the authorized payment.

updateTime

String updateTime

The date and time when the transaction was last updated, in Internet date and time format.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.AuthorizationStatusDetails extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

reason

String reason

The reason why the authorized status is "PENDING". The possible values are:

• "PENDING_REVIEW". Authorization is pending manual review.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Bancontact extends CommonPaymentSource implements Serializable

serialVersionUID:

1L

Serialized Fields

cardLastDigits

String cardLastDigits

The last digits of the card used to fund the Bancontact payment.

ibanLastChars

String ibanLastChars

The last characters of the IBAN used to pay.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Blik extends CommonPaymentSource implements Serializable

serialVersionUID:

1L

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Capture extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

Money amount

The amount for this captured payment.

captureStatusDetails

CaptureStatusDetails captureStatusDetails

The details of the captured payment status.

createTime

String createTime

The date and time when the transaction occurred, in Internet date and time format.

customId

String customId

The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

disbursementMode

String disbursementMode

The funds that are held on behalf of the merchant.

finalCapture

Boolean finalCapture

Indicates whether you can make additional captures against the authorized payment. Set to true if you do not intend to capture additional payments against the authorization. Set to false if you intend to capture additional payments against the authorization.

id

String id

The PayPal-generated ID for the captured payment.

invoiceId

String invoiceId

The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.

links

List<LinkDescription> links

An array of related HATEOAS links.

processorResponse

ProcessorResponse processorResponse

An object that provides additional processor information for a direct credit card transaction.

sellerProtection

SellerProtection sellerProtection

The level of protection offered as defined by PayPal Seller Protection for Merchants.

sellerReceivableBreakdown

MerchantReceivableBreakdown sellerReceivableBreakdown

The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.

status

String status

The status of the captured payment.

updateTime

String updateTime

The date and time when the transaction was last updated, in Internet date and time format.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.CaptureStatusDetails extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

reason

String reason

The reason why the captured payment status is "PENDING" or "DENIED". The possible values are:

• BUYER_COMPLAINT. The payer initiated a dispute for this captured payment with PayPal.
• CHARGEBACK. The captured funds were reversed in response to the payer disputing this captured payment with the issuer of the financial instrument used to pay for this captured payment.
• ECHECK. The payer paid by an eCheck that has not yet cleared.
• INTERNATIONAL_WITHDRAWAL. Visit your online account. In your **Account Overview**, accept and deny this payment.
• OTHER. No additional specific reason can be provided. For more information about this captured payment, visit your account online or contact PayPal.
• PENDING_REVIEW. The captured payment is pending manual review.
• RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION. The payee has not yet set up appropriate receiving preferences for their account. For more information about how to accept or deny this payment, visit your account online. This reason is typically offered in scenarios such as when the currency of the captured payment is different from the primary holding currency of the payee.
• REFUNDED. The captured funds were refunded.
• TRANSACTION_APPROVED_AWAITING_FUNDING. The payer must send the funds for this captured payment. This code generally appears for manual EFTs.
• UNILATERAL. The payee does not have a PayPal account.
• VERIFICATION_REQUIRED. The payee's PayPal account is not verified.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Card extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

authenticationResult

AuthenticationResult authenticationResult

Results of Authentication such as 3D Secure.

brand

String brand

The card brand or network. Typically used in the response. The possible values are:

• VISA. Visa card.
• MASTERCARD. Mastecard card.
• DISCOVER. Discover card.
• AMEX. American Express card.
• SOLO. Solo debit card.
• JCB. Japan Credit Bureau card.
• STAR. Military Star card.
• DELTA. Delta Airlines card.
• SWITCH. Switch credit card.
• MAESTRO. Maestro credit card.
• CB_NATIONALE. Carte Bancaire (CB) credit card.
• CONFIGOGA. Configoga credit card.
• ELECTRON. Visa Electron credit card.
• CETELEM. Cetelem credit card.
• CHINA_UNION_PAY. China union pay credit card.

expiry

String expiry

The card expiration year and month, in Internet date format.

fromRequest

CardFromRequest fromRequest

Representation of card details as received in the request.

lastDigits

String lastDigits

The last digits of the payment card.

name

String name

The last digits of the payment card.

type

String type

The payment card type.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.CardFromRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

expiry

String expiry

The card expiration year and month, in Internet date format.

lastDigits

String lastDigits

The last digits of the payment card.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Eps extends CommonPaymentSource implements Serializable

serialVersionUID:

1L

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.ExchangeRate extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

sourceCurrency

String sourceCurrency

The source currency from which to convert an amount.

targetCurrency

String targetCurrency

The target currency to which to convert an amount.

value

String value

The target currency amount. Equivalent to one unit of the source currency. Formatted as integer or decimal value with one to 15 digits to the right of the decimal point.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.ExperienceContext extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

brandName

String brandName

The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.

cancelUrl

String cancelUrl

The URL where the customer is redirected after the customer cancels the payment.

landingPage

String landingPage

The type of landing page to show on the PayPal site for customer checkout. The possible values are:

• LOGIN. When the customer clicks PayPal Checkout, the customer is redirected to a page to log in to PayPal and approve the payment.
• GUEST_CHECKOUT. When the customer clicks PayPal Checkout, the customer is redirected to a page to enter credit or debit card and other relevant billing information required to complete the purchase. This option has previously been also called as 'BILLING'
• NO_PREFERENCE. When the customer clicks PayPal Checkout, the customer is redirected to either a page to log in to PayPal and approve the payment or to a page to enter credit or debit card and other relevant billing information required to complete the purchase, depending on their previous interaction with PayPal.

locale

String locale

The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.

paymentMethodPreference

String paymentMethodPreference

The merchant-preferred payment methods. The possible values are:

• UNRESTRICTED. Accepts any type of payment from the customer.
• IMMEDIATE_PAYMENT_REQUIRED. Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the `pending` status.

returnUrl

String returnUrl

The URL where the customer is redirected after the customer approves the payment.

shippingPreference

String shippingPreference

The location from which the shipping address is derived. The possible values are:

• GET_FROM_FILE. Get the customer-provided shipping address on the PayPal site.
• NO_SHIPPING. Redacts the shipping address from the PayPal site. Recommended for digital goods.
• SET_PROVIDED_ADDRESS. Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages.

userAction

String userAction

Configures a Continue or Pay Now checkout flow. The possible values are:

• CONTINUE. After you redirect the customer to the PayPal payment page, a Continue button appears. Use this option when the final amount is not known when the checkout flow is initiated and you want to redirect the customer to the merchant page without processing the payment.
• PAY_NOW. After you redirect the customer to the PayPal payment page, a Pay Now button appears. Use this option when the final amount is known when the checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.GiroPay extends CommonPaymentSource implements Serializable

serialVersionUID:

1L

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Ideal extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

bic

String bic

The bank identification code (BIC).

countryCode

String countryCode

The two-character ISO 3166-1 country code.

ibanLastChars

String ibanLastChars

The last characters of the IBAN used to pay.

name

String name

The name of the account holder associated with this payment method.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Item extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

category

String category

The item category type. The possible values are:

• "DIGITAL_GOODS". Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the PayPal for Commerce Platform product.
• "PHYSICAL_GOODS". A tangible item that can be shipped with proof of delivery.
• "DONATION". A contribution or gift for which no good or service is exchanged, usually to a not for profit organization.

description

String description

The detailed item description.

name

String name

The item name or title.

quantity

String quantity

The item quantity. Must be a whole number.

sku

String sku

The stock keeping unit (SKU) for the item.

tax

Money tax

The item tax for each unit. If "tax" is specified, "purchase_units[].amount.breakdown.tax_total" is required. Must equal "tax * quantity" for all items. "tax.value" can not be a negative number.

unitAmount

Money unitAmount

The item price or rate per unit. If you specify "unit_amount", "purchase_units[].amount.breakdown.item_total" is required. Must equal "unit_amount * quantity" for all items. "unit_amount.value" can not be a negative number.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.LinkDescription extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

href

String href

The complete target URL.

method

String method

The HTTP method required to make the related call.

rel

String rel

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.MerchantPayableBreakdown extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

grossAmount

Money grossAmount

The amount that the payee refunded to the payer.

netAmount

Money netAmount

The net amount that the payee's account is debited in the transaction currency. The net amount is calculated as "gross_amount" minus "paypal_fee" minus "platform_fees".

netAmountBreakdown

List<NetAmountBreakdownItem> netAmountBreakdown

An array of breakdown values for the net amount. Returned when the currency of the refund is different from the currency of the PayPal account where the payee holds their funds.

netAmountInReceivableCurrency

Money netAmountInReceivableCurrency

The net amount that the payee's account is debited in the receivable currency. Returned only in cases when the receivable currency is different from transaction currency. Example 'CNY'.

paypalFee

Money paypalFee

The PayPal fee that was refunded to the payer in the currency of the transaction. This fee might not match the PayPal fee that the payee paid when the payment was captured.

paypalFeeInReceivableCurrency

Money paypalFeeInReceivableCurrency

The PayPal fee that was refunded to the payer in the receivable currency. Returned only in cases when the receivable currency is different from transaction currency. Example 'CNY'.

platformFee

PlatformFee platformFee

An array of platform or partner fees, commissions, or brokerage fees for the refund.

totalRefundedAmount

Money totalRefundedAmount

The total amount refunded from the original capture to date. For example, if a payer makes a $100 purchase and was refunded $20 a week ago and was refunded $30 in this refund, the "gross_amount" is $30 for this refund and the "total_refunded_amount" is $50.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.MerchantReceivableBreakdown extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

exchangeRate

ExchangeRate exchangeRate

The exchange rate that determines the amount that is credited to the payee's PayPal account. Returned when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds.

grossAmount

Money grossAmount

The amount for this captured payment in the currency of the transaction.

netAmount

Money netAmount

The net amount that the payee receives for this captured payment in their PayPal account. The net amount is computed as gross_amount minus the paypal_fee minus the platform_fees.

paypalFee

Money paypalFee

The applicable fee for this captured payment in the currency of the transaction.

paypalFeeInReceivableCurrency

Money paypalFeeInReceivableCurrency

The applicable fee for this captured payment in the receivable currency. Returned only in cases the fee is charged in the receivable currency. Example 'CNY'.

platformFees

List<PlatformFee> platformFees

An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment.

receivableAmount

Money receivableAmount

The net amount that is credited to the payee's PayPal account. Returned only when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds. The amount is computed as net_amount times exchange_rate.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Money extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

currencyCode

String currencyCode

The three-character ISO-4217 currency code that identifies the currency.

value

String value

The value, which might be:

• An integer for currencies like JPY that are not typically fractional.
• A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.MyBank extends CommonPaymentSource implements Serializable

serialVersionUID:

1L

Serialized Fields

ibanLastChars

String ibanLastChars

The last characters of the IBAN used to pay.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Name extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

fullName

String fullName

When the party is a person, the party's full name.

givenName

String givenName

When the party is a person, the party's given, or first, name.

middleName

String middleName

When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

prefix

String prefix

The prefix, or title, to the party's name.

suffix

String suffix

The suffix for the party's name.

surname

String surname

When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.NetAmountBreakdownItem extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

convertedAmount

Money convertedAmount

The converted payable amount.

exchangeRate

ExchangeRate exchangeRate

The exchange rate that determines the amount that was debited from the merchant's PayPal account.

payableAmount

Money payableAmount

The net amount debited from the merchant's PayPal account.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Order extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createTime

String createTime

The date and time when the transaction occurred, in Internet date and time format.

id

String id

The ID of the order.

intent

String intent

The intent to either capture payment immediately or authorize a payment for an order after order creation. The possible values are:

• "CAPTURE". The merchant intends to capture payment immediately after the customer makes a payment.
• "AUTHORIZE". The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one `purchase_unit` within your order.

links

List<LinkDescription> links

An array of request-related HATEOAS links. To complete payer approval, use the "approve" link to redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include "application_context.return_url" is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment.

paymentSource

PaymentSource paymentSource

The payment source used to fund the payment.

processingInstruction

String processingInstruction

The instruction to process an order. The possible values are:

• "ORDER_COMPLETE_ON_PAYMENT_APPROVAL". API Caller expects the Order to be auto completed (i.e. for PayPal to authorize or capture depending on the intent) on completion of payer approval. This option is not relevant for payment_source that typically do not require a payer approval or interaction. This option is currently only available for the following payment_source: Alipay, Bancontact, BLIK, boletobancario, eps, giropay, GrabPay, iDEAL, Multibanco, MyBank, OXXO, P24, PayU, PUI, SafetyPay, SatisPay, Sofort, Trustly, Verkkopankki, WeChat Pay
• "NO_INSTRUCTION". The API caller intends to authorize "v2/checkout/orders/id/authorize" or capture "v2/checkout/orders/id/capture" after the payer approves the order.

purchaseUnits

List<PurchaseUnit> purchaseUnits

An array of purchase units. Each purchase unit establishes a contract between a customer and merchant. Each purchase unit represents either a full or partial order that the customer intends to purchase from the merchant.

status

String status

The order status. The possible values are:

• "CREATED". The order was created with the specified context.
• "SAVED". The order was saved and persisted. The order status continues to be in progress until a capture is made with "final_capture = true" for all purchase units within the order.
• "APPROVED". The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on.
• "VOIDED". All purchase units in the order are voided.
• "COMPLETED". The payment was authorized or the authorized payment was captured for the order.
• "PAYER_ACTION_REQUIRED". The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing the order.

updateTime

String updateTime

The date and time when the transaction was last updated, in Internet date and time format.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.OrderAuthorizeRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

paymentSource

PaymentSourceRequest paymentSource

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.OrderCaptureRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

paymentSource

PaymentSourceRequest paymentSource

The payment source definition.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.OrderRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

checkoutPaymentIntent

String checkoutPaymentIntent

The intent to either capture payment immediately or authorize a payment for an order after order creation. The possible values are:

• "CAPTURE". The merchant intends to capture payment immediately after the customer makes a payment.
• "AUTHORIZE". The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one `purchase_unit` within your order.

paymentSource

PaymentSource paymentSource

The payment source used to fund the payment.

purchaseUnits

List<PurchaseUnit> purchaseUnits

An array of purchase units. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.P24 extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

countryCode

String countryCode

The two-character ISO 3166-1 country code.

email

String email

The email address of the account holder associated with this payment method.

methodDescription

String methodDescription

Friendly name of the payment scheme or bank used for the payment.

methodId

String methodId

Numeric identifier of the payment scheme or bank used for the payment.

name

String name

The name of the account holder associated with this payment method.

paymentDescriptor

String paymentDescriptor

P24 generated payment description.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Patch extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

from

String from

The JSON Pointer to the target document location from which to move the value. Required for the "move" operation.

op

String op

The operation. The possible values are:

• add. Depending on the target location reference, completes one of these functions:
  • The target location is an array index. Inserts a new value into the array at the specified index.
  • The target location is an object parameter that does not already exist. Adds a new parameter to the object.
  • The target location is an object parameter that does exist. Replaces that parameter's value.
  The value parameter defines the value to add
• remove. Removes the value at the target location. For the operation to succeed, the target location must exist.
• replace. Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist.
• move. Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist.
• copy. Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist.
• test. Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:
  • strings - contain the same number of Unicode characters and their code points are byte-by-byte equal.
  • numbers - Are numerically equal.
  • arrays - Contain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
  • objects - Contain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
  • literals (false, true, and null) - Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.

path

String path

The JSON Pointer to the target document location at which to complete the operation.

value

Object value

The value to apply. The "remove" operation does not require a value.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Payee extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

email

String email

The email address of merchant.

merchantId

String merchantId

The encrypted PayPal account ID of the merchant.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Payer extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

addressPortable

AddressPortable addressPortable

The address of the payer. Supports only the "address_line_1", "address_line_2", "admin_area_1", "admin_area_2", "postal_code", and "country_code" properties. Also referred to as the billing address of the customer.

birthDate

String birthDate

The birth date of the payer in "YYYY-MM-DD" format.

emailAddress

String emailAddress

The email address of the payer.

name

Name name

The name of the payer. Supports only the "given_name" and "surname" properties.

payerId

String payerId

The PayPal-assigned ID for the payer.

phone

PhoneWithType phone

The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The "phone.phone_number" supports only national_number.

taxInfo

TaxInfo taxInfo

The tax information of the payer. Required only for Brazilian payer's. Both "tax_id" and "tax_id_type" are required.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.PaymentCollection extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

authorizations

List<Authorization> authorizations

An array of authorized payments for a purchase unit. A purchase unit can have zero or more authorized payments.

captures

List<Capture> captures

An array of captured payments for a purchase unit. A purchase unit can have zero or more captured payments.

refunds

List<Refund> refunds

An array of refunds for a purchase unit. A purchase unit can have zero or more refunds.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.PaymentInstruction extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

disbursementMode

String disbursementMode

The funds that are held payee by the marketplace/platform. This field is only applicable to merchants that been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. The possible values are:

• "INSTANT". The funds are released to the merchant immediately.
• "DELAYED". The funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration.

payeePricingTierId

String payeePricingTierId

This field is only enabled for selected merchants/partners to use and provides the ability to trigger a specific pricing rate/plan for a payment transaction. The list of eligible 'payee_pricing_tier_id' would be provided to you by your Account Manager. Specifying values other than the one provided to you by your account manager would result in an error.

payeeReceivableFxRateId

String payeeReceivableFxRateId

FX identifier generated returned by PayPal to be used for payment processing in order to honor FX rate (for eligible integrations) to be used when amount is settled/received into the payee account.

platformFees

List<PlatformFee> platformFees

An array of various fees, commissions, tips, or donations. This field is only applicable to merchants that been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.PaymentSource extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

bancontact

Bancontact bancontact

Information used to pay Bancontact.

blik

Blik blik

Information used to pay using BLIK.

card

Card card

The payment card to use to fund a payment. Card can be a credit or debit card.

eps

Eps eps

Information used to pay using eps.

giropay

GiroPay giropay

Information needed to pay using giropay.

ideal

Ideal ideal

Information used to pay using iDEAL.

mybank

MyBank mybank

Information used to pay using MyBank.

p24

P24 p24

Information used to pay using P24(Przelewy24).

paypal

Paypal paypal

The PayPal Wallet response.

sofort

Sofort sofort

Information used to pay using Sofort.

trustly

Trustly trustly

Information needed to pay using Trustly.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Paypal extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

accountId

String accountId

The PayPal-assigned ID for the PayPal account holder.

address

AddressPortable address

The address of the PayPal account holder. Supports only the "address_line_1", "address_line_2", "admin_area_1", "admin_area_2", "postal_code", and "country_code" properties. Also referred to as the billing address of the customer.

birthDate

String birthDate

The birth date of the PayPal account holder in "YYYY-MM-DD" format.

emailAddress

String emailAddress

The email address of the PayPal account holder.

experienceContext

ExperienceContext experienceContext

Customizes the payer experience during the approval process for the payment.

name

Name name

The name of the PayPal account holder. Supports only the "given_name" and "surname" properties.

phoneNumber

Phone phoneNumber

The phone number, in its canonical international E.164 numbering plan format. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. Supports only the "national_number" property.

phoneType

String phoneType

The phone type. The possible values are:

• FAX. A fax machine.
• HOME. A home phone.
• MOBILE. A mobile phone.
• OTHER. Other.
• PAGER. A pager.
• WORK. A work phone.

taxInfo

TaxInfo taxInfo

The tax information of the PayPal account holder. Required only for Brazilian PayPal account holder's. Both tax_id and tax_id_type are required.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Phone extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

countryCode

String countryCode

The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

extensionNumber

String extensionNumber

The extension number.

nationalNumber

String nationalNumber

The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.PhoneWithType extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

phoneNumber

Phone phoneNumber

The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.

phoneType

String phoneType

The phone type. Possible values: FAX, HOME, MOBILE, OTHER, PAGER.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.PlatformFee extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

Money amount

The fee for this transaction.

payee

Payee payee

The recipient of the fee for this transaction. If you omit this value, the default is the API caller.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.ProcessorResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

avsCode

String avsCode

The address verification code for Visa, Discover, Mastercard, or American Express transactions.

cvvCode

String cvvCode

The card verification value code for for Visa, Discover, Mastercard, or American Express.

paymentAdviceCode

String paymentAdviceCode

The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes.

responseCode

String responseCode

Processor response code for the non-PayPal payment processor errors.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.PurchaseUnit extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amountWithBreakdown

AmountWithBreakdown amountWithBreakdown

The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any. If you specify "amount.breakdown", the amount equals "item_total" plus "tax_total" plus "shipping" plus "handling" plus "insurance" minus "shipping_discount" minus discount. The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.

customId

String customId

The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

description

String description

The purchase description.

id

String id

The PayPal-generated ID for the purchase unit. This ID appears in both the payer's transaction history and the emails that the payer receives. In addition, this ID is available in transaction and settlement reports that merchants and API callers can use to reconcile transactions. This ID is only available when an order is saved by calling "v2/checkout/orders/id/save".

invoiceId

String invoiceId

The API caller-provided external invoice ID for this order.

items

List<Item> items

An array of items that the customer purchases from the merchant.

payee

Payee payee

The merchant who receives payment for this transaction.

paymentInstruction

PaymentInstruction paymentInstruction

Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.

payments

PaymentCollection payments

The comprehensive history of payments for the purchase unit.

referenceId

String referenceId

The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through "PATCH". If you omit this value and the order contains only one purchase unit, PayPal sets this value to "default".

shippingDetail

ShippingDetail shippingDetail

The name and address of the person to whom to ship the items.

softDescriptor

String softDescriptor

The soft descriptor is the dynamic text used to construct the statement descriptor that appears on a payer's card statement. If an Order is paid using the "PayPal Wallet", the statement descriptor will appear in following format on the payer's card statement: "PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptor". Note: The merchant descriptor is the descriptor of the merchant’s payment receiving preferences which can be seen by logging into the merchant account https://www.sandbox.paypal.com/businessprofile/settings/info/edit. The "PAYPAL" prefix uses 8 characters. Only the first 22 characters will be displayed in the statement. For example, if: The PayPal prefix toggle is PAYPAL . The merchant descriptor in the profile is "Janes Gift". The soft descriptor is "800-123-1234". Then, the statement descriptor on the card is PAYPAL Janes Gift 80.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Refund extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

Money amount

The amount that the payee refunded to the payer.

createTime

String createTime

The date and time when the transaction occurred, in Internet date and time format.

id

String id

The PayPal-generated ID for the refund.

invoiceId

String invoiceId

The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.

links

List<LinkDescription> links

An array of related HATEOAS links.

noteToPayer

String noteToPayer

The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.

refundStatusDetails

RefundStatusDetails refundStatusDetails

The details of the refund status.

sellerPayableBreakdown

MerchantPayableBreakdown sellerPayableBreakdown

The breakdown of the refund.

status

String status

The status of the refund.

updateTime

String updateTime

The date and time when the transaction was last updated, in Internet date and time format.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.RefundStatusDetails extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

reason

String reason

The reason why the refund has the "PENDING" or "FAILED" status. The possible values are:

• "ECHECK". The customer's account is funded through an eCheck, which has not yet cleared.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.SellerProtection extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

disputeCategories

List<String> disputeCategories

An array of conditions that are covered for the transaction.

status

String status

Indicates whether the transaction is eligible for seller protection. For information, see PayPal Seller Protection for Merchants The possible values are:

• "ELIGIBLE". Your PayPal balance remains intact if the customer claims that they did not receive an item or the account holder claims that they did not authorize the payment.
• "PARTIALLY_ELIGIBLE". Your PayPal balance remains intact if the customer claims that they did not receive an item.
• "NOT_ELIGIBLE". This transaction is not eligible for seller protection.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.ShippingDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

addressPortable

AddressPortable addressPortable

The address of the person to whom to ship the items. Supports only the "address_line_1", "address_line_2", "admin_area_1", "admin_area_2", "postal_code", and "country_code" properties.

name

Name name

The name of the person to whom to ship the items. Supports only the "full_name" property.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Sofort extends CommonPaymentSource implements Serializable

serialVersionUID:

1L

Serialized Fields

ibanLastChars

String ibanLastChars

The last characters of the IBAN used to pay.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.TaxInfo extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

taxId

String taxId

The customer's tax ID value.

taxIdType

String taxIdType

The customer's tax ID type. The possible values are:

• BR_CPF. The individual tax ID type, typically is 11 characters long.
• BR_CNPJ. The business tax ID type, typically is 14 characters long.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.ThreeDSecureAuthentication extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

authenticationStatus

String authenticationStatus

The outcome of the issuer's authentication. The possible values are:

• "Y". Successful authentication.
• "N". Failed authentication / account not verified / transaction denied.
• "U". Unable to complete authentication.
• "A". Successful attempts transaction.
• "C". Challenge required for authentication.
• "R". Authentication rejected (merchant must not submit for authorization).
• "D". Challenge required; decoupled authentication confirmed.
• "I". Informational only; 3DS requestor challenge preference acknowledged.

enrollmentStatus

String enrollmentStatus

Status of authentication eligibility. The possible values are:

• "Y". Yes. The bank is participating in 3-D Secure protocol and will return the ACSUrl.
• "N". No. The bank is not participating in 3-D Secure protocol.
• "U". Unavailable. The DS or ACS is not available for authentication at the time of the request.
• "B". Bypass. The merchant authentication rule is triggered to bypass authentication.

Class com.broadleafcommerce.paypal.micro.gateway.domain.orders.Trustly extends CommonPaymentSource implements Serializable

serialVersionUID:

1L

Serialized Fields

ibanLastChars

String ibanLastChars

The last characters of the IBAN used to pay.

Package com.broadleafcommerce.paypal.micro.gateway.domain.payments

Class com.broadleafcommerce.paypal.micro.gateway.domain.payments.CaptureRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

Money amount

The amount to capture. To capture a portion of the full authorized amount, specify an amount. If amount is not specified, the full authorized amount is captured. The amount must be a positive number and in the same currency as the authorization against which the payment is being captured.

finalCapture

Boolean finalCapture

Indicates whether you can make additional captures against the authorized payment. Set to true if you do not intend to capture additional payments against the authorization. Set to false if you intend to capture additional payments against the authorization.

invoiceId

String invoiceId

The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.

noteToPayer

String noteToPayer

An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.

paymentInstruction

PaymentInstruction paymentInstruction

Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.

softDescriptor

String softDescriptor

The payment descriptor on the payer's account statement.

Class com.broadleafcommerce.paypal.micro.gateway.domain.payments.CardRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

billingAddress

AddressPortable billingAddress

The billing address for this card. Supports only the "address_line_1", "address_line_2", "admin_area_1", "admin_area_2", "postal_code", and "country_code" properties.

expiry

String expiry

The card expiration year and month, in Internet date and time format.

name

String name

The card holder's name as it appears on the card.

number

String number

The primary account number (PAN) for the payment card.

securityCode

String securityCode

The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when "payment_initiator=MERCHANT".

storedCredential

CardStoredCredential storedCredential

Provides additional details to process a payment using a "card" that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file). Parameter compatibility:

• "payment_type=ONE_TIME" is compatible only with "payment_initiator=CUSTOMER".
• "usage=FIRST" is compatible only with "payment_initiator=CUSTOMER".
• "previous_transaction_reference" or "previous_network_transaction_reference" is compatible only with "payment_initiator=MERCHANT".
• Only one of the parameters - "previous_transaction_reference" and "previous_network_transaction_reference" - can be present in the request.

vaultId

String vaultId

The PayPal-generated ID for the saved card payment source. Typically stored on the merchant's server.

Class com.broadleafcommerce.paypal.micro.gateway.domain.payments.CardStoredCredential extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

paymentInitiator

String paymentInitiator

The person or party who initiated or triggered the payment. The possible values are:

• "CUSTOMER". Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a merchant website.
• "MERCHANT". Payment is initiated by merchant on behalf of the customer without the active engagement of customer. e.g. a merchant charging the monthly payment of a subscription to the customer.

paymentType

String paymentType

Indicates the type of the stored payment_source payment. The possible values are:

• "ONE_TIME". One Time payment such as online purchase or donation. (e.g. Checkout with one-click).
• "RECURRING". Payment which is part of a series of payments with fixed or variable amounts, following a fixed time interval. (e.g. Subscription payments).
• "UNSCHEDULED". Payment which is part of a series of payments that occur on a non-fixed schedule and/or have variable amounts. (e.g. Account Topup payments).

previousNetworkTransactionReference

NetworkTransactionReference previousNetworkTransactionReference

Reference values used by the card network to identify a transaction.

usage

String usage

Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file). The possible values are:

• "FIRST". Indicates the Initial/First payment with a payment_source that is intended to be stored upon successful processing of the payment.
• "SUBSEQUENT". Indicates a payment using a stored payment_source which has been successfully used previously for a payment.
• "DERIVED". Indicates that PayPal will derive the value of `FIRST` or `SUBSEQUENT` based on data available to PayPal.

Class com.broadleafcommerce.paypal.micro.gateway.domain.payments.NetworkTransactionReference extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

date

String date

The date that the transaction was authorized by the scheme. For MasterCard, this is the "BankNet reference date" field in response.

id

String id

Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response.

network

String network

Name of the card network through which the transaction was routed. The possible values are: "VISA". Visa card. "MASTERCARD". Mastecard card. "DISCOVER". Discover card. "AMEX". American Express card. "SOLO". Solo debit card. "JCB". Japan Credit Bureau card. "STAR". Military Star card. "DELTA". Delta Airlines card. "SWITCH". Switch credit card. "MAESTRO". Maestro credit card. "CB_NATIONALE". Carte Bancaire (CB) credit card. "CONFIGOGA". Configoga credit card. "CONFIDIS". Confidis credit card. "ELECTRON". Visa Electron credit card. "CETELEM". Cetelem credit card. "CHINA_UNION_PAY". China union pay credit card.

Class com.broadleafcommerce.paypal.micro.gateway.domain.payments.PaymentSourceRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

card

CardRequest card

The payment card to use to fund a payment. Can be a credit or debit card. Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance. PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide.

paypal

Paypal paypal

Indicates that PayPal Wallet is the payment source. Main use of this selection is to provide additional instructions associated with this choice like vaulting.

token

Token token

The tokenized payment source to fund a payment.

Class com.broadleafcommerce.paypal.micro.gateway.domain.payments.RefundRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

Money amount

The amount to refund. To refund a portion of the captured amount, specify an amount. If amount is not specified, an amount equal to "captured amount - previous refunds" is refunded. The amount must be a positive number and in the same currency as the one in which the payment was captured.

invoiceId

String invoiceId

The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.

noteToPayer

String noteToPayer

The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.

paymentInstruction

PaymentInstruction paymentInstruction

Any additional refund instructions to be set during refund payment processing. This object is only applicable to merchants that have been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. Please speak to your account manager if you want to use this capability.

Class com.broadleafcommerce.paypal.micro.gateway.domain.payments.Token extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

The PayPal-generated ID for the token.

type

String type

The tokenization method that generated the ID. The possible values are:

• "BILLING_AGREEMENT". The PayPal billing agreement ID. References an approved recurring payment for goods or services.

Package com.broadleafcommerce.paypal.micro.gateway.service

Class com.broadleafcommerce.paypal.micro.gateway.service.DefaultPayPalCheckoutRetryPolicyClassifier extends Object implements Serializable

Serialized Fields

retryPolicy

org.springframework.retry.RetryPolicy retryPolicy

Package com.broadleafcommerce.paypal.micro.gateway.service.provider.exception

Class com.broadleafcommerce.paypal.micro.gateway.service.provider.exception.PayPalProviderApiException extends RuntimeException implements Serializable

Serialized Fields

receivedException

org.springframework.web.reactive.function.client.WebClientResponseException receivedException