Full SDK

Below, we outline the step-by-step process to enable the full SDK functionalities in your system:

Step 1: Include the library in your project.

Ensure the Yuno SDK file is included in your webpage before closing the tag. Refer to the 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.

Like the example below, use the initialized class that is attributed to the yunoconstant.

const yuno = Yuno.initialize(PUBLIC_API_KEY)

Step 3: Start the checkout process

You will start the checkout process. To do it, use the function yuno.startCheckout and provide the necessary parameters.

The following table lists all required parameters and their descriptions. For optional parameters go to Complementary Features.

yuno.startCheckout({
  checkoutSession: '438413b7-4921-41e4-b8f3-28a5a0141638',
  elementSelector: '#root', 
  countryCode: 'CO',
  language: 'es',
  onLoading: (args) => {
    console.log(args);
  }
  async yunoCreatePayment(oneTimeToken) {
    await createPayment({ oneTimeToken, checkoutSession })
    yuno.continuePayment()
  },
})

Step 4: Mount the SDK

Display the payment methods by using the function yuno.mountCheckout() by selecting an HTML element and using a valid CSS selector (#, ., [data-*])

/**
 * Mount checkout in browser DOM
 */
yuno.mountCheckout()

If you want to set a default payment method, use the following code to mount it:

/**
 * Mount checkout in browser DOM with a payment method selected by default
 * @optional
 */
yuno.mountCheckout({
  /**
   * Optional, only needed if you would like this method type selected by default
   * Can be one of 'BANCOLOMBIA_TRANSFER' | 'PIX' | 'ADDI' | 'NU_PAY' | 'MERCADO_PAGO_CHECKOUT_PRO
   */
  paymentMethodType: PAYMENT_METHOD_TYPE,
  /**
   * Optional
   * Vaulted token related to payment method type
   */
  vaultedToken: VAULTED_TOKEN,
})

Step 5: Initiate the payment process

After the user has selected a payment method remember to call yuno.startPayment() to initiate the payment flow. Below you will find an example where yuno.startPayment() is called when the user clicks on button-pay:

const PayButton = document.querySelector('#button-pay')

PayButton.addEventListener('click', () => {
  yuno.startPayment()
})

Step 6: Get the OTT (One Time Token)

Once the customer fills out the requested data in Yuno's payment forms, the SDK provides the OTT. The configuration function yuno.CreatePayment(oneTimeToken) is then triggered with the OTT (One Time Token).

 yunoCreatePayment(oneTimeToken)

You can also use tokenWithInformation to receive any additional info given by the customer in the checkout such as installments or document type/number.

yunoCreatePayment(oneTimeToken, tokenWithInformation)

Step 7: Create the Payment

Once you have completed the steps described before, you can create a payment. The back-to-back payment creation must be carried out using the Create Payment endpoint. The merchant should call their backend to create the payment within Yuno, using the OTT (One Time Token) and the checkout session.

• Continue: We recommend integrating the method continuePayment of the SDK after the payment is created because certain asynchronous payment methods require additional action from the customer to complete it. The API will inform you of this scenario via the field sdk_action_required of the response, which will be returned as true. The function yuno.continuePayment() will display the additional screens to the customers, where they can carry out the necessary actions to complete the payment. Otherwise, this step is not necessary.

After this step, you can complete the end-to-end integration by referencing back to the Step by Step integration of the Full SDK

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:

• Form loader
• Render mode
• Card form configurations
  • Save Card for future payments
  • Render mode
  • Text payment form buttons
  • External Payment Buttons
  • Persist credit card form to retry payments
• Bank Issuer List
• SDK Customizations: Change the SDK appearance to match your brand.
• Payment Status: Update the user about the payment process.
• 3DS Setup SDK: Integrate 3DS into your payment flow.

• Loader

  Control the use of the loader.

yuno.startCheckout({
  showLoading: true,
})

• Issuer´s form (bank list)

yuno.startCheckout({
  issuersFormEnable: true,
})

• Mode of form rendering

yuno.startCheckout({
  renderMode: {
    type: 'modal',
    elementSelector: '#form-element',
  },
})

• Card form configurations

yuno.startCheckout({
  card: {
    type: "extends",
    styles: '',
    cardSaveEnable: false,
    texts: {}
  },
})

Save card for future payments:

In addition, you can display a checkbox for save or enroll cards using cardSaveEnable: true. Below you can find examples of the checkbox for both card form renders.

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

yuno.startCheckout({
  texts: {
    customerForm?: {
      submitButton?: string;
    }
    paymentOtp?: {
      sendOtpButton?: string;
    }
  }
})

External Payment Buttons

yuno.startCheckout({
  externalPaymentButtons: {
    paypal: {
      elementSelector: '#paypal',
    },
  },
})

Persist credit card form to retry payments

In case a a transaction is rejected, you can persist the credit card form to retry a payment after the customer has entered the credit card details. In order to do that, you will need to:

1. Add the following parameter while initializing the SDK to persist the credit card form after the one time use token is created:
   JavaScript

   yuno.startCheckout({
     automaticallyUnmount: false,
   })
   

2. In case the transaction is rejected, you will need to:
   1. Execute the method yuno.notifyError() to delete the previously entered CVV for the first transaction.
   2. Create a new checkout session and update the SDK with the new one by executing yuno.updateCheckoutSession(checkoutsession)
3. Continue with the new checkout and one time use token with the regular payment flow.