Lite SDK (Enrollment)

This page outlines the step-by-step process to enable the Lite SDK enrollment functionalities in your system.

Step 1: Include the library in your project

To enable Enrollment Lite functionality, the first step is to make sure to include the Yuno SDK file in your webpage before closing the <body>. See an example below:

<script src="https://sdk-web.y.uno/v1/static/js/main.min.js"></script>

Step 2: Initialize SDK with the public key

In your JavaScript application, create an instance of the Yuno class by providing a valid PUBLIC_API_KEY. Check the Get your API credentials guide if you do not have your credentials. In the example below, the initialized class is attributed to the yunoconstant.

const yuno = Yuno.initialize(PUBLIC_API_KEY)

Step 3: Create a customer session and an enrollment payment method object

Before continuing with the process, you will need to create a customer session and a payment method object to use in the setup of your SDK Lite integration for enrollment. While creating the payment method object, you will need to define which one is going to be available for your customer to enroll (in the case of SDK Lite, only CARD is available).

Verify

In case you want to verify cards (zero value authorization) before the enrollment, you can complete the verify struct while defining the payment method object for the customer session.

Step 4: Mount the enrollment lite

The configuration and mounting are done in the same step for the Enrollment Lite. To do it, use the yuno.mountEnrollmentLite function and provide the necessary parameters. The following table lists all parameters and their descriptions.

ParameterDescription
customerSessionRefers to the current payment's customer session.
Example: 'e15648b0-fcd5-4799-a14c-cc463ae8a133'
countryCodeThis parameter determines the country for which the payment process is being configured. The complete list of supported countries and their country code is available on the Country coverage page.
languageDefines the language to be used in the payment forms. You can set it to one of the available language options: es (Spanish), en (English), or pt (Portuguese).
showLoadingControl the visibility of the Yuno loading/spinner page during the payment process.
onLoadingRequired to receive notifications about server calls or loading events during the payment process.
renderModeDetermine the mode in which the payment forms will be displayed.
elementSelectorSpecifies the HTML element where you want to mount the Yuno SDK. The SDK will be rendered within this element.
cardDefine specific settings for the credit card form.
yunoEnrollmentStatusDefine a call back to run after the enrollment process ends. It is called with vaultedToken and status parameters. The status returned can be one of:


▪️ CREATED: It is an initial and transitory state, only indicating that it is created and updated to another state.
▪️ EXPIRED: For asynchronous enrollments, such as MercadoPago, where the user has to take an action externally, and may never do so.
▪️ REJECTED: We reject it from our side. It may be because they entered incorrect Yuno credentials or are sending some data incorrectly.
▪️ READY_TO_ENROLL: It follows CREATED if everything is okay, indicating that the enrollment has started.
▪️ ENROLL_IN_PROCESS: For asynchronous enrollments, like MercadoPago, where the user has to take an action externally. It indicates that the user is performing the action.
▪️ UNENROLL_IN_PROCESS: For asynchronous unenrollments, in case the provider has an asynchronous response. Currently, there are none.
▪️ ENROLLED: Successfully enrolled.
▪️ DECLINED: The provider declined the enrollment. Does not include cards.
▪️ CANCELED: The enrollment flow is canceled halfway.
▪️ ERROR: There was an ERROR in the service or credentials.
▪️ UNENROLLED: The previously enrolled payment method has been unenrolled.
issuersFormEnableEnable the issuer's form (bank list).
textsProvide custom text for payment form buttons to match your application's language or branding.

The next code block presents an example of the Enrollment Lite parameter configuration and mounting.

yuno.mountEnrollmentLite({
  customerSession: 'e15648b0-fcd5-4799-a14c-cc463ae8a133',
  /**
   * The complete list of country codes is available on https://docs.y.uno/docs/country-coverage-yuno-sdk
   */
  countryCode: country,
  /**
  * Language can be one of es, en, pt
  * Default is browser language
  */
  language: 'es',
  /**
   * Hide or show the Yuno loading/spinner page
   * Default is true
   * @optional
   */
  showLoading: true,
  /**
   * Required if you'd like to be informed if there is a server call
   * @param { isLoading: boolean, type: 'DOCUMENT' | 'ONE_TIME_TOKEN'  } data
   * @optional
   */
  onLoading: (args) => {
    console.log(args);
  }
  /**
   * Where the forms will be shown
   * Default { type: 'modal' }
   * @optional
   */
  renderMode: {
    /**
     * Type can be one of `modal` or `element`
     * Default modal
     */
    type: 'modal',
    /**
     * Element where the form will be rendered
     * Only needed if type is element
     */
    elementSelector: '#form-element',
  },
  /**
   *  API card
   *  @optional
   */
  card: {
    /**
     * Mode render card can be step or extends
     * Default extends
     */
    type: "extends",
    /**
     * You can edit card form styles
     * Only you should write css, then it will be injected into the iframe
     * Example 
     * `@import url('https://fonts.googleapis.com/css2?family=Luckiest+Guy&display=swap');
     *  .Yuno-front-side-card__name-label { 
     *    color: red !important;
     *    font-family: 'Luckiest Guy' !important;
     *   }`
     */
    styles: '',
    /** 
     * Show checkbox for save/enroll card 
     * Default is false
     */
    cardSaveEnable: false,
    /**
     * Custom texts in Card forms buttons
     * Example:
     * 
     *  texts: {
     *    cardForm?: {
     *      enrollmentSubmitButton?: string;
     *       paymentSubmitButton?: string;
     *     }
     *     cardStepper?: {
     *       numberCardStep?: {
     *         nextButton?: string;
     *       },
     *       cardHolderNameStep?: {
     *         prevButton?: string;
     *         nextButton?: string;
     *       },
     *       expirationDateStep?: {
     *         prevButton?: string;
     *         nextButton?: string;
     *       },
     *       cvvStep?: {
     *         prevButton?: string;
     *         nextButton?: string;
     *       }
     *     }
     *  }
     */
    texts: {},
    /**
     * Hide or show the document fields into card form
     * Default is true
     * @optional
     */
    documentEnable: true,
  },
  /**
   * Call back is called with the following object
   * @param {{ 
   *  status: 'CREATED'
   *    | 'EXPIRED',
   *    | 'REJECTED',
   *    | 'READY_TO_ENROLL',
   *    | 'ENROLL_IN_PROCESS',
   *    | 'UNENROLL_IN_PROCESS',
   *    | 'ENROLLED',
   *    | 'DECLINED',
   *    | 'CANCELED',
   *    | 'ERROR',
   *    | 'UNENROLLED', 
   *  vaultedToken: string,
   * }}
   */
  yunoEnrollmentStatus: ({ status, vaultedToken}) => {
    console.log('status', { status, vaultedToken})
  },
  /**
   * If this is called the SDK should be mounted again
   * @param { error: 'CANCELED_BY_USER' | any }
   * @optional
   */
  yunoError: (error) => {
    console.log('There was an error', error)
  },
});

Complementary Features

In addition to the code examples provided, you can access the Demo App for a complete implementation of Yuno SDKs or go directly to the HTML and JavaScript checkout demos available on GitHub.

Yuno Web SDK provides additional services and configurations you can use to improve customers' experience:

  • Loader: Control the use of the loader.
ParameterDescription
keepLoaderYou can choose whether to hide or show the Yuno loading/spinner page. Enabling this option ensures that the loading component remains displayed until either the hideLoader() or continuePayment() function is called.
The default value is true.
yuno.startCheckout({
  showLoading: true,
})
  • Mode of form rendering
ParameterDescription
renderModeDetermine the mode in which the payment forms will be displayed.

- type: can be one of modal or element.
- elementSelector: Element where the form will be rendered
* Only needed if type is element.
yuno.startCheckout({
  renderMode: {
    type: 'modal',
    elementSelector: '#form-element',
  },
})
  • Card form configurations
ParameterDescription
cardDefine specific settings for the credit card form

- type: step o extends
- styles: You can edit card form styles. Only you should write css, then it will be injected into the iframe.
- texts: Custom texts in Card forms buttons.
yuno.startCheckout({
  card: {
    type: "extends",
    styles: '',
    cardSaveEnable: false,
    texts: {}
  },
})

Rendering modes: Below you find screenshots presenting the difference between the:

  • Render modes modal and elements for the payment method list.
  • Render modes step and extends for the credit card form.
Element
Modal
  • You also can choose one of the render options for the card form, step and extends:
Extends
Step
  • Text payment form buttons
ParameterDescription
textsProvide custom text for payment form buttons to match your application's language or branding.
yuno.startCheckout({
  texts: {
    customerForm?: {
      submitButton?: string;
    }
    paymentOtp?: {
      sendOtpButton?: string;
    }
  }
})