@paydock/client-sdk/bundles/types/checkout-button/index.d.ts

Paydock client sdk

export { CHECKOUT_BUTTON_EVENT, type IEventCheckoutFinishData } from './checkout-button.interface';
export { ZipmoneyCheckoutButton } from './zipmoney/zipmoney-checkout-button';
export { AfterpayCheckoutButton } from './afterpay/afterpay-checkout-button';
export { PaypalCheckoutButton } from './paypal/paypal-checkout-button';
/**
 * Interface for PayPal checkout meta information
 * @interface IPayPalMeta
 *
 * @param {string} [brand_name] A  label that overrides the business name in the PayPal account on the PayPal hosted checkout pages
 * @param {string} [cart_border_color] The HTML hex code for your principal identifying color
 * @param {string} [reference] Merchant Customer Service number displayed on the PayPal pages
 * @param {string} [email] The consumer’s email
 * @param {string} [hdr_img] URL for the image you want to appear at the top left of the payment page
 * @param {string} [logo_img] A URL to your logo image
 * @param {string} [pay_flow_color] Sets the background color for the payment page. By default, the color is white.
 * @param {string} [first_name] The consumer’s given names
 * @param {string} [last_name] The consumer’s surname
 * @param {string} [address_line] Street address
 * @param {string} [address_line2] Second line of the address
 * @param {string} [address_city] City
 * @param {string} [address_state] State
 * @param {string} [address_postcode] Postcode
 * @param {string} [address_country] Country
 * @param {string} [phone] The consumer’s phone number in E.164 international notation (Example: +12345678901)
 * @param {boolean} [hide_shipping_address] Determines whether PayPal displays shipping address fields on the PayPal pages
 */
/**
 * Interface for ZipMoney checkout meta information
 * @interface IZipmoneyMeta

 * @param {string} first_name First name for the customer
 * @param {string} last_name 	Last name for the customer
 * @param {string} [phone] The consumer’s phone number in E.164 international notation (Example: +12345678901)
 * @param {boolean} [tokenize] Controls whether to tokenize the zip pay / zip money account, defaults to ‘false’
 * @param {string} email The consumer’s email
 * @param {string} [gender] Gender name for the customer
 * @param {string} [date_of_birth] Date of birth name for the customer
 * @param {number} charge.amount Amount to be paid
 * @param {string} [charge.currency] Currency code
 * @param {string} [charge.reference] Reference
 * @param {array} charge.items Collections of orders
 * @param {string} charge.items[].name Name of the item
 * @param {number} charge.items[].amount Amount of the item
 * @param {integer} charge.items[].quantity Quantity of the item
 * @param {string} [charge.items[].type] type of the item, values can be: ‘sku’, ‘tax’, ‘shipping’, ‘discount’
 * @param {string} [charge.items[].reference] reference of the item
 * @param {string} [charge.items[].item_uri] url of the item in your store
 * @param {string} [charge.items[].image_url] url of the image in your store
 * @param {string} [charge.shipping_type] Shipping type, values can be: ‘pickup’, ‘delivery’, defaults to ‘delivery’
 * @param {string} [charge.shipping_address] Object with shipping address details
 * @param {string} [charge.shipping_address.first_name] Shipping first name
 * @param {string} [charge.shipping_address.last_name] Shipping last name
 * @param {string} charge.shipping_address.line1 Shipping address line 1
 * @param {string} charge.shipping_address.line2 Shipping address line 2
 * @param {string} charge.shipping_address.city Shipping city
 * @param {string} charge.shipping_address.state Shipping state
 * @param {string} charge.shipping_address.postcode Shipping postcode
 * @param {string} charge.shipping_address.country Shipping country
 * @param {string} charge.billing_address Object with billing address details
 * @param {string} [charge.billing_address.first_name] Billing first name
 * @param {string} [charge.billing_address.last_name] Billing last name
 * @param {string} charge.billing_address.line1 Billing address line 1
 * @param {string} [charge.billing_address.line2] Billing address line 1
 * @param {string} charge.billing_address.city Billing city
 * @param {string} charge.billing_address.state Billing state
 * @param {string} charge.billing_address.postcode Billing postcode
 * @param {string} charge.billing_address.country Billing country
 */
/**
 * Interface for Afterpay checkout meta information
 * @interface IAfterpayMeta
 * @param {number} [amount]
 * @param {number} [currency]
 * @param {string} [first_name]
 * @param {string} [last_name]
 * @param {string} [email]
 * @param {string} [address_line]
 * @param {string} [address_line2]
 * @param {string} [address_city]
 * @param {string} [address_state]
 * @param {string} [address_postcode]
 * @param {string} [address_country]
 * @param {string} [phone]
 */
//# sourceMappingURL=index.d.ts.map