Serialized Form

Package com.broadleafcommerce.tabby.domain

Class com.broadleafcommerce.tabby.domain.TabbyAttachment

class TabbyAttachment extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

body

Object body

Should be an object containing any of the keys with corresponded sub objects.

contentType

String contentType

Version of used schema.

Default: "application/vnd.tabby.v1+json"

Class com.broadleafcommerce.tabby.domain.TabbyBuyer

class TabbyBuyer extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

dob

String dob

Customer's date of birth; format is YYYY-MM-DD.

email

String email

Customer’s email address.

name

String name

Customer’s full name.

phone

String phone

Customer’s phone number. This must be a valid mobile phone where the consumer can receive text messages.

Class com.broadleafcommerce.tabby.domain.TabbyBuyerHistory

class TabbyBuyerHistory extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

isEmailVerified

boolean isEmailVerified

Is email verified.

isPhoneNumberVerified

boolean isPhoneNumberVerified

Is phone number verified.

isSocialNetworksConnected

boolean isSocialNetworksConnected

Is social network connected.

loyaltyLevel

Integer loyaltyLevel

Customer's loyalty level within your store, should be sent as a number of successfully placed orders in the store with any payment methods. Default: 0.

registeredSince

String registeredSince

Time the customer got registred with you, in UTC, and displayed in ISO 8601 datetime format.

wishlistCount

Integer wishlistCount

Number of items in Customer's wishlist >= 0. Default: 0.

Class com.broadleafcommerce.tabby.domain.TabbyCapturePaymentRequest

class TabbyCapturePaymentRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

String amount

Total payment amount captured, including tax, shipping, and excluding any discounts. Allows to send up to 2 decimals for AED and SAR, QAR and up to 3 decimals for KWD and BHD. Defaults to "0.00".

createdAt

String createdAt

Date and time the capture was created, in UTC, and displayed in ISO 8601 datetime format, assigned by Tabby.

discountAmount

String discountAmount

Total discount for the order. Should be positive or zero. Defaults to "0.00".

items

List<TabbyOrderItem> items

Array of objects representing the order items being captured.

referenceId

String referenceId

Idempotency key. Used to avoid similar capture requests.

shippingAmount

String shippingAmount

Shipping cost captured. Defaults to "0.00".

taxAmount

String taxAmount

Tax amount captured. Defaults to "0.00".

Class com.broadleafcommerce.tabby.domain.TabbyErrorResponse

class TabbyErrorResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

errors

List<TabbyErrorResponse.TabbyError> errors

The list of the errors.

errorType

String errorType

The error type. For example, "bad_data".

status

String status

The status of the response. For example, "error".

Class com.broadleafcommerce.tabby.domain.TabbyErrorResponse.TabbyError

class TabbyError extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

The code of the error. For example, "invalid_value".

field

String field

The invalid field that caused the error. For example, "$.payment.amount"

message

String message

The error message. For example, "should be positive".

Class com.broadleafcommerce.tabby.domain.TabbyOrder

class TabbyOrder extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

discountAmount

String discountAmount

Total discount for the order. Should be positive or zero. Shows up on Tabby App for the Customer's convenience. Default: "0.00".

items

List<TabbyOrderItem> items

Array of objects representing the order items in this payment.

referenceId

String referenceId

Merchant-assigned order or cart ID, usually Merchnat OMS's Order_number.

shippingAmount

String shippingAmount

Total shipping cost for the order. Default: "0.00".

taxAmount

String taxAmount

Total tax for the order. Default: "0.00".

updatedAt

String updatedAt

Time the order was last updated, in UTC, and displayed in ISO 8601 datetime format.

Class com.broadleafcommerce.tabby.domain.TabbyOrderHistory

class TabbyOrderHistory extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

String amount

Total payment amount, including tax, shipping, and excluding any discounts.

buyer

TabbyBuyer buyer

items

List<TabbyOrderItem> items

Array of objects representing the order items in this payment. If you want to offer consumers a discount, use this object to create a “discount order item”, with the unit_price set to the negative value of the discount.

paymentMethod

String paymentMethod

Payment method used. Enum: "card" "cod".

purchasedAt

String purchasedAt

Time the order was placed, in UTC, and displayed in ISO 8601 datetime format.

shippingAddress

TabbyShippingAddress shippingAddress

status

String status

Status of the order. Enum: "new" "processing" "complete" "refunded" "canceled" "unknown"

Class com.broadleafcommerce.tabby.domain.TabbyOrderItem

class TabbyOrderItem extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

brand

String brand

Brand name, e.g. Mango / Dorothy Perkins / Tommy Hilfiger.

category

String category

Required as name of high-level category (Clothes, Electronics,etc.); or a tree of category-subcategory1-subcategory2; or id of the category and table with category-ids data mapped provided.

This field is required.

color

String color

Color name, e.g. white / blue / green.

description

String description

Description for the product.

discountAmount

String discountAmount

Amount of the applied discount if any. Should be positive or zero. Default: "0.00".

gender

String gender

who the goods are designed to.

Enum: "Male" "Female" "Kids" "Other"

imageUrl

String imageUrl

URL of the item image to show in the order information.

productMaterial

String productMaterial

Product material name, e.g. cotton / polyester / synthetic.

productUrl

String productUrl

URL of the item at your store.

quantity

Integer quantity

Quantity of the product ordered >= 1. Default: 1.

This field is required.

referenceId

String referenceId

Merchant’s product identifier. Used for Item refunds.

size

String size

Size of the order item, e.g. L / XL / 12.

sizeType

String sizeType

Size type, e.g. EU / UK.

title

String title

Name of the product.

This field is required.

unitPrice

String unitPrice

Price per unit of the product. Should be positive or zero. Default: "0.00".

This field is required.

Class com.broadleafcommerce.tabby.domain.TabbyPayment

class TabbyPayment extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

String amount

Total payment amount, including tax, shipping and any discounts. Allows to send up to 2 decimals for AED, SAR, QAR; up to 3 decimals for KWD and BHD.

attachment

TabbyAttachment attachment

Extra data (booking info, insurance, flight reservations, ...) as serialized JSON

attributes

Map<String,Object> attributes

Map holding any additional attributes passed in the request not matching any defined properties.

buyer

TabbyBuyer buyer

buyerHistory

TabbyBuyerHistory buyerHistory

captures

List<TabbyPaymentCapture> captures

createdAt

String createdAt

Date and time the payment was created, in UTC, and displayed in ISO 8601 datetime format.

currency

String currency

ISO 4217 currency code for the payment amount. Default: "AED".

Enum: "AED" "SAR" "KWD" "BHD" "QAR"

description

String description

expiresAt

String expiresAt

Date and time the payment expires, in UTC, and displayed in ISO 8601 datetime format.

id

String id

Unique identifier for the payment (UUID), assigned by Tabby.

isTest

boolean isTest

Indicates whether this is a test payment (created using the Test API keys or Production API Keys).

meta

Map<String,Object> meta

Merchant-defined data about the payment. This field is a key-value map.

order

TabbyOrder order

orderHistory

List<TabbyOrderHistory> orderHistory

refunds

List<TabbyPaymentRefund> refunds

shippingAddress

TabbyShippingAddress shippingAddress

status

String status

Current status of this payment object. The payment for a new session has Created staus. A successful payment that was approved by Tabby has a status of AUTHORIZED. A payment that was successfully captured and closed has a status of CLOSED. A payment which was rejected has a status of Rejected. A payment which status wasn't updated within the session lifetime (20 minutes by default) plus payment confirmation time (up to 10 minutes) - within 30 minutes, has a status of Expired.

See Also:

• DefaultTabbyPaymentStatuses

Class com.broadleafcommerce.tabby.domain.TabbyPaymentCapture

class TabbyPaymentCapture extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

String amount

Total payment amount captured, including tax, shipping, and excluding any discounts. Allows to send up to 2 decimals for AED and SAR, QAR and up to 3 decimals for KWD and BHD. Default: "0.00".

createdAt

String createdAt

Date and time the capture was created, in UTC, and displayed in ISO 8601 datetime format, assigned by Tabby.

discountAmount

String discountAmount

Total discount for the order. Should be positive or zero. Default: "0.00".

id

String id

Unique capture ID, assigned by Tabby.

items

List<TabbyOrderItem> items

Array of objects representing the order items being captured.

shippingAmount

String shippingAmount

Shipping cost captured. Default: "0.00".

taxAmount

String taxAmount

Tax amount captured. Default: "0.00".

Class com.broadleafcommerce.tabby.domain.TabbyPaymentRefund

class TabbyPaymentRefund extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

String amount

Amount refunded. Allows to send up to 2 decimals for AED, SAR, QAR and up to 3 decimals for KWD and BHD. Default: "0.00".

createdAt

String createdAt

Date and time the refund was created, in UTC, and displayed in ISO 8601 datetime format, assigned by Tabby.

id

String id

Unique refund ID, assigned by Tabby.

items

List<TabbyOrderItem> items

Array of objects representing the order items being refunded.

reason

String reason

Reason for the refund.

Class com.broadleafcommerce.tabby.domain.TabbyRefundPaymentRequest

class TabbyRefundPaymentRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

String amount

Amount refunded. Allows to send up to 2 decimals for AED, SAR, QAR and up to 3 decimals for KWD and BHD. Defaults to "0.00".

createdAt

String createdAt

Date and time the refund was created, in UTC, and displayed in ISO 8601 datetime format, assigned by Tabby.

items

List<TabbyOrderItem> items

Array of objects representing the order items being refunded.

reason

String reason

Reason for the refund.

referenceId

String referenceId

Idempotency key. Used to avoid similar refund requests.

Class com.broadleafcommerce.tabby.domain.TabbyShippingAddress

class TabbyShippingAddress extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

address

String address

Building name, apartment number.

city

String city

Name of city, municipality, or village.

zip

String zip

Postal code.

Package com.broadleafcommerce.tabby.domain.enums

Package com.broadleafcommerce.tabby.domain.session

Class com.broadleafcommerce.tabby.domain.session.TabbyCheckoutSession

class TabbyCheckoutSession extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

configuration

TabbySessionConfiguration configuration

The Tabby Checkout session configuration.

createToken

boolean createToken

Optional, used for Tokenized Checkout flow only with the Account Manager confirmation. Pass true if you want to get token at the end of checkout session. This field will be read only when authorization was made using secret_key.

id

String id

Unique identifier for the checkout Session, assigned by Tabby.

lang

String lang

Session language, used to launch HPP with desired language.

Enum: "ar" "en"

merchant

TabbyCheckoutSession.TabbyMerchant merchant

merchantCode

String merchantCode

The merchant code.

merchantUrls

TabbyCheckoutSession.TabbyMerchantUrls merchantUrls

Used for redirecting the customer after the tabby HPP flow. Required for Web integration, optional for Mobile App integration.

payment

TabbyPayment payment

The Tabby payment.

status

String status

Status of the current session. It's ok to redirect customer when session is created or approved.

See Also:

• DefaultTabbySessionStatuses

token

String token

If you already have token, you can pass it there. This field will be read only when authorization was made using secret_key. In the response, this field will be filled with token value, that you can use for Tokenized Payments.

Class com.broadleafcommerce.tabby.domain.session.TabbyCheckoutSession.TabbyMerchant

class TabbyMerchant extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

address

String address

logo

String logo

name

String name

Class com.broadleafcommerce.tabby.domain.session.TabbyCheckoutSession.TabbyMerchantUrls

class TabbyMerchantUrls extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Object> attributes

Map holding any additional attributes passed in the request not matching any defined properties.

cancel

String cancel

URL to redirect the customer after cancel payment status. Checkout page recommended.

failure

String failure

URL to redirect the customer after failure payment status (Rejected). Checkout page recommended.

success

String success

URL to redirect the customer after payment is Authorized. 'Thank you' page recommended.

Class com.broadleafcommerce.tabby.domain.session.TabbySessionConfiguration

class TabbySessionConfiguration extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

availableProducts

TabbySessionConfiguration.TabbyAvailableProducts availableProducts

expiresAt

String expiresAt

products

TabbySessionConfiguration.TabbyProducts products

Products and theirs availability

Class com.broadleafcommerce.tabby.domain.session.TabbySessionConfiguration.TabbyAvailableProducts

class TabbyAvailableProducts extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

installments

List<TabbySessionConfiguration.TabbyAvailableProducts.TabbyAvailableProduct> installments

monthlyBilling

List<TabbySessionConfiguration.TabbyAvailableProducts.TabbyAvailableProduct> monthlyBilling

Class com.broadleafcommerce.tabby.domain.session.TabbySessionConfiguration.TabbyAvailableProducts.TabbyAvailableProduct

class TabbyAvailableProduct extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

qrCode

String qrCode

webUrl

String webUrl

Class com.broadleafcommerce.tabby.domain.session.TabbySessionConfiguration.TabbyProducts

class TabbyProducts extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

installments

TabbySessionConfiguration.TabbyProducts.TabbyProduct installments

monthlyBilling

TabbySessionConfiguration.TabbyProducts.TabbyProduct monthlyBilling

Class com.broadleafcommerce.tabby.domain.session.TabbySessionConfiguration.TabbyProducts.TabbyProduct

class TabbyProduct extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

isAvailable

boolean isAvailable

rejectionReason

String rejectionReason

The reason why this product is not available to use Possible values:

• order_amount_too_high - 'This purchase is above your current spending limit with Tabby, try a smaller cart or use another payment method.'
• order_amount_too_low - 'The purchase amount is below the minimum amount required to use Tabby, try adding more items or use another payment method.'
• not_available - 'Sorry, Tabby is unable to approve this purchase, please use an alternative payment method for your order.'
• null - if is_available is true and customer is able to use it.

type

String type

Type of product.

Enum: "installments" "monthly_billing"

Package com.broadleafcommerce.tabby.domain.webhook

Class com.broadleafcommerce.tabby.domain.webhook.TabbyWebhookEvent

class TabbyWebhookEvent extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

String amount

The payment transaction amount.

captures

List<TabbyPaymentCapture> captures

If the payment is captured, the information about it will be added to this list.

closedAt

String closedAt

Date and time the payment was closed, in UTC, and displayed in ISO 8601 datetime format.

createdAt

String createdAt

Date and time the payment was created, in UTC, and displayed in ISO 8601 datetime format.

currency

String currency

The payment transaction currency.

expiresAt

String expiresAt

Date and time the payment expires, in UTC, and displayed in ISO 8601 datetime format.

id

String id

The Tabby payment ID.

isExpired

boolean isExpired

Indicates whether the payment is expired or not.

isTest

boolean isTest

Indicates whether the webhook is used in the test environment or not.

order

TabbyOrder order

The information about the order.

refunds

List<TabbyPaymentRefund> refunds

If the payment is refunded, the information about it will be added to this list.

status

String status

The status of the payment (lowercase value).

• Authorize. Status "authorized" - It changes the status only.
• Capture. Status "authorized" - The information about your Capture Request is added.
• Close. Status "closed" - Such parameters as "status" and "closed_at" are changed.
• Reject. Status "rejected" - It changes the status only.
• Expire (Optional). Status "expired" - Such parameters as "status", "expired_at" and "is_expired" are changed.
• Refund. Status "closed" - The information about your Refund Request is added.

See Also:

• DefaultTabbyPaymentStatuses

Package com.broadleafcommerce.tabby.provider.domain

Class com.broadleafcommerce.tabby.provider.domain.Address

class Address extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

addressLine1

String addressLine1

Primary address information, typically street name and building number.

city

String city

The city, town or village of this address.

fullName

String fullName

The combined names of the individual at this address. It is considered better UX to use a full name field in place of separate first and last name fields.

jsonMap

Map<String,Object> jsonMap

JSON data for the address object which isn't already stored in other fields.

phonePrimary

Phone phonePrimary

The primary phone number for this address.

postalCode

String postalCode

Postal code or ZIP code for this address.

Class com.broadleafcommerce.tabby.provider.domain.CustomerOrderInfo

class CustomerOrderInfo extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

fulfillments

List<OrderFulfillment> fulfillments

The fulfillments for the order.

jsonMap

Map<String,Object> jsonMap

JSON data which isn't already stored in other fields.

order

Order order

Class com.broadleafcommerce.tabby.provider.domain.OrderFulfillment

class OrderFulfillment extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

address

Address address

The shipping address for this fulfillment.

id

String id

The unique identifier for this fulfillment.

jsonMap

Map<String,Object> jsonMap

JSON data for the fulfillment object which isn't already stored in other fields.

orderFulfillmentNumber

String orderFulfillmentNumber

The number for this individual fulfillment, unique within the order.

status

String status

The status of this fulfillment.

Class com.broadleafcommerce.tabby.provider.domain.OrderPricing

class OrderPricing extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

jsonMap

Map<String,Object> jsonMap

JSON data for the order pricing object which isn't already stored in other fields.

total

javax.money.MonetaryAmount total

The total price of this Order.

Class com.broadleafcommerce.tabby.provider.domain.Phone

class Phone extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

countryCode

String countryCode

The country calling code that acts as a prefix to the main telephone number.

extension

String extension

The internal extension for this phone.

phoneNumber

String phoneNumber

The telephone number, including the area code.

Package com.broadleafcommerce.tabby.provider.exception

Exception com.broadleafcommerce.tabby.provider.exception.ProviderApiException

class ProviderApiException extends RuntimeException implements Serializable

Serialized Fields

receivedException

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

Exception com.broadleafcommerce.tabby.provider.exception.TabbyPreScoringApiException

class TabbyPreScoringApiException extends ProviderApiException implements Serializable

Package com.broadleafcommerce.tabby.service.exception

Exception com.broadleafcommerce.tabby.service.exception.AuthenticationRequiredException

class AuthenticationRequiredException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.tabby.service.exception.TabbyRequestCreationException

class TabbyRequestCreationException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.tabby.service.exception.TabbyResponseInterpretationException

class TabbyResponseInterpretationException extends RuntimeException implements Serializable

Serialized Fields

paymentResponse

com.broadleafcommerce.paymentgateway.domain.PaymentResponse paymentResponse