@tonder.io/ionic-full-sdk v0.0.47

Tonder Ionic Full SDK

Tonder SDK helps to integrate the services Tonder offers in your own mobile app

Table of Contents

1. Installation
2. Usage
3. Configuration Options
4. Styling InlineCheckout
5. Mobile Settings
6. Payment Data Structure
7. API Reference
8. Examples
9. Deprecated Functions
10. License

Installation

You can install using NPM

npm i @tonder.io/ionic-full-sdk

Add dependencies to the root of the app (index.html)

<script src="https://openpay.s3.amazonaws.com/openpay.v1.min.js"></script>
<script src="https://openpay.s3.amazonaws.com/openpay-data.v1.min.js"></script>

Usage

InlineCheckout provides a pre-built, customizable checkout interface.

HTML Setup

<div>
  <h1>Checkout</h1>
  <!-- You have to add an entry point with the ID 'tonder-checkout' -->
  <div id="tonder-checkout"></div>
</div>

Import InlineCheckout class

import { InlineCheckout } from "@tonder.io/ionic-full-sdk";

Create instance

const inlineCheckout = new InlineCheckout({
  publicApiKey,
  returnUrl,
  renderPaymentButton: false // true, if you need render default button of tonder
});

// only if renderPaymentButton is true
inlineCheckout.setPaymentData(checkoutData);

// The configureCheckout function allows you to set initial information,
// such as the customer's email, which is used to retrieve a list of saved cards or the secure token required to save a card.
// You can refer to the Customer interface for the complete object structure that can be passed.
inlineCheckout.configureCheckout({ 
  customer: { 
    email: "example@email.com" 
  },
  secureToken: "e89eb18.." 
});

// Inject the checkout into the DOM
inlineCheckout.injectCheckout();

// To verify a 3ds transaction you can use the following method
// It should be called after the injectCheckout method
// The response status will be one of the following
// ['Declined', 'Cancelled', 'Failed', 'Success', 'Pending', 'Authorized']

inlineCheckout.verify3dsTransaction().then((response) => {
  console.log("Verify 3ds response", response);
});

// Process a payment
const response = await inlineCheckout.payment(checkoutData);

Configuration Options

Important Note about SaveCard functionality: To properly implement the SaveCard feature, you must use a SecureToken. For detailed implementation instructions and best practices, please refer to our official documentation on How to use SecureToken for secure card saving.

Styling InlineCheckout

You can customize the appearance of InlineCheckout by passing a styles object:

const customStyles = {
  inputStyles: {
    base: {
      border: "1px solid #e0e0e0",
      padding: "10px 7px",
      borderRadius: "5px",
      color: "#1d1d1d",
      marginTop: "2px",
      backgroundColor: "white",
      fontFamily: '"Inter", sans-serif',
      fontSize: "16px",
      "&::placeholder": {
        color: "#ccc",
      },
    },
    cardIcon: {
      position: "absolute",
      left: "6px",
      bottom: "calc(50% - 12px)",
    },
    complete: {
      color: "#4caf50",
    },
    empty: {},
    focus: {},
    invalid: {
      border: "1px solid #f44336",
    },
    global: {
      "@import":
        'url("https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;700&display=swap")',
    },
  },
  labelStyles: {
    base: {
      fontSize: "12px",
      fontWeight: "500",
      fontFamily: '"Inter", sans-serif',
    },
  },
  errorTextStyles: {
    base: {
      fontSize: "12px",
      fontWeight: "500",
      color: "#f44336",
      fontFamily: '"Inter", sans-serif',
    },
  },
  labels: {
    nameLabel: "Card Holder Name",
    cardLabel: "Card Number",
    cvvLabel: "CVC/CVV",
    expiryDateLabel: "Expiration Date",
  },
  placeholders: {
    namePlaceholder: "Name as it appears on the card",
    cardPlaceholder: "1234 1234 1234 1234",
    cvvPlaceholder: "3-4 digits",
    expiryMonthPlaceholder: "MM",
    expiryYearPlaceholder: "YY",
  },
};

The styles param is related to the style of the inputs inside the checkout form, to customize the checkout container and the cards list you can use global styles on base to this classes

@import url("https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;700&display=swap");

.container-tonder {
  background-color: #f9f9f9;
  margin: 0 auto;
  padding: 30px 10px 30px 10px;
  overflow: hidden;
  transition: max-height 0.5s ease-out;
  max-width: 600px;
  border: solid 1px #e3e3e3;
}

.collect-row {
  display: flex;
  justify-content: space-between;
  width: 100%;
}

.collect-row > :first-child {
  min-width: 120px;
}

.expiration-year {
  padding-top: 25px;
}

.empty-div {
  height: 80px;
  margin-top: 2px;
  margin-bottom: 4px;
  margin-left: 10px;
  margin-right: 10px;
}

.error-container {
  color: red;
  background-color: #ffdbdb;
  margin-bottom: 13px;
  font-size: 80%;
  padding: 8px 10px;
  border-radius: 10px;
  text-align: left;
}

.message-container {
  color: green;
  background-color: #90ee90;
  margin-bottom: 13px;
  font-size: 80%;
  padding: 8px 10px;
  border-radius: 10px;
  text-align: left;
}

.pay-button {
  font-size: 16px;
  font-weight: bold;
  min-height: 2.3rem;
  border-radius: 0.5rem;
  cursor: pointer;
  width: 100%;
  padding: 1rem;
  text-align: center;
  border: none;
  background-color: #000;
  color: #fff;
  margin-bottom: 10px;
  display: none;
}

.pay-button:disabled,
pay-button[disabled] {
  background-color: #b9b9b9;
}

.lds-dual-ring {
  display: inline-block;
  width: 14px;
  height: 14px;
}

.lds-dual-ring:after {
  content: " ";
  display: block;
  width: 14px;
  height: 14px;
  border-radius: 50%;
  border: 6px solid #fff;
  border-color: #fff transparent #fff transparent;
  animation: lds-dual-ring 1.2s linear infinite;
}

@keyframes lds-dual-ring {
  0% {
    transform: rotate(0deg);
  }
  100% {
    transform: rotate(360deg);
  }
}

@media screen and (max-width: 600px) {
  .payment_method_zplit {
    font-size: 16px;
    width: 100%;
  }

  .payment_method_zplit label img {
    display: none;
  }
}

.cards-list-container {
  display: flex;
  flex-direction: column;
  padding: 0px 10px 0px 10px;
  gap: 33% 20px;
}

.checkbox label {
  margin-left: 10px;
  font-size: 12px;
  font-weight: 500;
  color: #1d1d1d;
  font-family: "Inter", sans-serif;
}

.checkbox {
  margin-top: 10px;
  margin-bottom: 10px;
  width: 100%;
  text-align: left;
}

.pay-new-card {
  display: flex;
  justify-content: start;
  align-items: center;
  color: #1d1d1d;
  gap: 33% 20px;
  margin-top: 10px;
  margin-bottom: 10px;
  padding-left: 10px;
  padding-right: 10px;
  width: 90%;
}

.pay-new-card .card-number {
  font-size: 16px;
  font-family: "Inter", sans-serif;
}

.card-image {
  width: 27px;
  height: 20px;
  text-align: left;
}

.card-item-label {
  display: flex;
  justify-content: start;
  align-items: center;
  color: #1d1d1d;
  gap: 33% 20px;
  margin-top: 10px;
  margin-bottom: 10px;
  padding-left: 10px;
  padding-right: 10px;
  width: 90%;
}

.card_selected {
  width: 10%;
}

.card-item {
  display: flex;
  justify-content: start;
  align-items: center;
  gap: 33% 20px;
}

.card-item .card-number {
  font-size: 16px;
  font-family: "Inter", sans-serif;
}

.card-item .card-expiration {
  font-size: 16px;
  font-family: "Inter", sans-serif;
}

Mobile settings

If you are deploying to Android, edit your AndroidManifest.xml file to add the Internet permission.

<!-- Required to fetch data from the internet. -->
<uses-permission android:name="android.permission.INTERNET" />

Likewise, if you are deploying to macOS, edit your macos/Runner/DebugProfile.entitlements and macos/Runner/Release.entitlements files to include the network client entitlement.

<!-- Required to fetch data from the internet. -->
<key>com.apple.security.network.client</key>
<true>

Payment Data Structure

When calling the payment method, use the following data structure:

Field Descriptions

• customer: Object containing the customer's personal information to be registered in the transaction.

• cart: Object containing the total amount and an array of items to be registered in the Tonder order.

  • total: The total amount of the transaction.
  • items: An array of objects, each representing a product or service in the order.
    • name: name of the product
    • price_unit: valid float string with the price of the product
    • quantity: valid integer string with the quantity of this product

• currency: String representing the currency code for the transaction (e.g., "MXN" for Mexican Peso).

• metadata: Object for including any additional information about the transaction. This can be used for internal references or tracking.

const paymentData = {
  customer: {
    firstName: "John",
    lastName: "Doe",
    country: "USA",
    address: "123 Main St",
    city: "Anytown",
    state: "CA",
    postCode: "12345",
    email: "john.doe@example.com",
    phone: "1234567890",
  },
  cart: {
    total: "100.00",
    items: [
      {
        description: "Product description",
        quantity: 1,
        price_unit: "100.00",
        discount: "0.00",
        taxes: "0.00",
        product_reference: "PROD123",
        name: "Product Name",
        amount_total: "100.00",
      },
    ],
  },
  currency: "MXN",
  metadata: {
    order_id: "ORDER123",
  },
};

API Reference

• configureCheckout(data): Set initial checkout data
• injectCheckout(): Initialize the checkout
• payment(data): Process a payment
• verify3dsTransaction(): Verify a 3DS transaction
• saveCard(): Save a new card. This is useful when using sdk as an enrollment card isEnrollmentCard
• removeCheckout(): Removes the checkout from the DOM and cleans up associated resources.
• setPaymentData(data): Set the payment data, such as customer, cart, and metadata. This is useful when using the default Tonder payment button renderPaymentButton.

Examples

Here are examples of how to implement Tonder SDK:

Ionic Angular - Checkout

For Angular, we recommend using a service to manage the Tonder instance:

// tonder.service.ts
import { Injectable } from "@angular/core";
import { InlineCheckout } from "@tonder.io/ionic-full-sdk";
import {IInlineCheckout} from "@tonder.io/ionic-full-sdk/dist/types/inlineCheckout";

@Injectable({
  providedIn: "root",
})
export class TonderService {
  private inlineCheckout: IInlineCheckout;

  constructor(@Inject(Object) private sdkParameters: IInlineCheckoutOptions) {
    this.initializeInlineCheckout();
  }

  private initializeInlineCheckout(): void {
    this.inlineCheckout = new InlineCheckout({ ...this.sdkParameters });
  }

  configureCheckout(customerData: IConfigureCheckout): void {
    return this.inlineCheckout.configureCheckout({ ...customerData });
  }

  async injectCheckout(): Promise<void> {
    return await this.inlineCheckout.injectCheckout();
  }

  verify3dsTransaction(): Promise<ITransaction | IStartCheckoutResponse | void> {
    return this.inlineCheckout.verify3dsTransaction();
  }

  payment(
      checkoutData: IProcessPaymentRequest
  ): Promise<IStartCheckoutResponse> {
      return this.inlineCheckout.payment(checkoutData);
  }
  
  removeCheckout(): void {
      return this.inlineCheckout.removeCheckout();
  }
}

// checkout.component.ts
import { Component, OnInit, OnDestroy } from "@angular/core";
import { TonderService } from "./tonder.service";

@Component({
  selector: "app-tonder-checkout",
  template: `
    <div id="tonder-checkout"></div>
    <button (click)="pay()" [disabled]="loading">
      {{ loading ? "Processing..." : "Pay" }}
    </button>
  `,
  providers: [
    {
      provide: TonderInlineService,
        // Initialization of the Tonder Inline SDK.
        // Note: Replace these credentials with your own in development/production.
      useFactory: () =>
        new TonderInlineService({
          apiKey: "11e3d3c3e95e0eaabbcae61ebad34ee5f93c3d27",
          returnUrl: "http://localhost:8100/tabs/tab1",
          mode: "stage",
        }),
    },
  ],
})

export class TonderCheckoutComponent implements OnInit, OnDestroy {
  loading = false;
  checkoutData: IProcessPaymentRequest;

  constructor(private tonderService: TonderService) {
      this.checkoutData = {
          customer: {
              firstName: "Jhon",
              lastName: "Doe",
              email: "john.c.calhoun@examplepetstore.com",
              phone: "+58452258525"
          },
          cart: {
              total: 25,
              items: [
                  {
                      description: "Test product description",
                      quantity: 1,
                      price_unit: 25,
                      discount: 1,
                      taxes: 12,
                      product_reference: 89456123,
                      name: "Test product",
                      amount_total: 25
                  }
              ]
          },
          metadata: {},
          currency: "MXN"
      }
  }

  ngOnInit() {
    this.initCheckout();
  }

  ngOnDestroy() {
    // Clear the checkout upon destroying the component.
    this.tonderService.removeCheckout();
  }

  async initCheckout() {
    this.tonderService.configureCheckout({
      customer: { email: "example@email.com" },
    });
    await this.tonderService.injectCheckout();
    this.tonderService.verify3dsTransaction().then((response) => {
      console.log("Verify 3ds response", response);
    });
  }

  async pay() {
    this.loading = true;
    try {
      const response = await this.tonderService.payment(this.checkoutData);
      console.log("Payment successful:", response);
      alert("Payment successful");
    } catch (error) {
      console.error("Payment failed:", error);
      alert("Payment failed");
    } finally {
      this.loading = false;
    }
  }
}

Ionic Angular - Enrollment Card

For Angular, we recommend using a service to manage the Tonder instance:

// tonder.service.ts
import { Injectable } from "@angular/core";
import { InlineCheckout } from "@tonder.io/ionic-full-sdk";
import {IInlineCheckout} from "@tonder.io/ionic-full-sdk/dist/types/inlineCheckout";

@Injectable({
  providedIn: "root",
})
export class TonderService {
  private inlineCheckout: IInlineCheckout;

  constructor(@Inject(Object) private sdkParameters: IInlineCheckoutOptions) {
    this.initializeInlineCheckout();
  }

  private initializeInlineCheckout(): void {
    this.inlineCheckout = new InlineCheckout({ ...this.sdkParameters });
  }

  configureCheckout(customerData: IConfigureCheckout): void {
    return this.inlineCheckout.configureCheckout({ ...customerData });
  }

  async injectCheckout(): Promise<void> {
    return await this.inlineCheckout.injectCheckout();
  }

  async saveCard(): Promise<string> {
    return await this.inlineCheckout.saveCard();
  }
  
  removeCheckout(): void {
      return this.inlineCheckout.removeCheckout();
  }
}

// enrollment.component.ts
import { Component, OnInit, OnDestroy } from "@angular/core";
import { TonderService } from "./tonder.service";

@Component({
  selector: "app-tonder-enrollment",
  template: `
    <div id="container">
      <form id="payment-form">
        <div id="tonder-checkout-enrollment"></div>
      </form>
      <button class="external-payment-button" (click)="onSave($event)">Guardar</button>
    </div>
  `,
  providers: [
    {
      provide: TonderInlineService,
        // Initialization of the Tonder Inline SDK.
        // Note: Replace these credentials with your own in development/production.
      useFactory: () =>
        new TonderInlineService({
          apiKey: "11e3d3c3e95e0eaabbcae61ebad34ee5f93c3d27",
          returnUrl: "http://localhost:8100/tabs/tab1",
          mode: "stage",
        }),
    },
  ],
})

export class TonderCheckoutComponent implements OnInit, OnDestroy {
  loading = false;
  customerData: IProcessPaymentRequest;

  constructor(private tonderService: TonderService) {
      this.customerData = {
          customer: {
              firstName: "Pedro",
              lastName: "Perez",
              country: "Finlandia",
              street: "The street",
              city: "The city",
              state: "The state",
              postCode: "98746",
              email: "jhon.doe@example.com",
              phone: "+58 4169855522"
          }
      }
  }

  ngOnInit() {
    this.initCheckout();
  }

  ngOnDestroy() {
    // Clear the checkout upon destroying the component.
    this.tonderService.removeCheckout();
  }

  async initCheckout() {
    this.tonderService.configureCheckout({
      customer: { email: "example@email.com" },
    });
    await this.tonderService.injectCheckout();
  }

  async onSave(event: any) {
      await this.tonderService.saveCard()
  }
}

Deprecated Functions

The following functions have been deprecated and should no longer be used. Consider using the recommended alternatives:

setCustomerEmail

• Deprecated Reason: This function have been replaced by the configureCheckout function.
• Alternative: Use the configureCheckout function.

setCartTotal

• Deprecated Reason: It is no longer necessary to use this method is now automatically handled during the payment process.

Notes

General

• Replace apiKey, mode, returnUrl with your actual values.
• Remember to use the configureCheckout function after creating an instance of InlineCheckout. This ensures that functions such as payment processing, saving cards, deleting cards, and others work correctly.

Script Dependencies

For all implementations, ensure you include the necessary scripts:

<script src="https://openpay.s3.amazonaws.com/openpay.v1.min.js"></script>
<script src="https://openpay.s3.amazonaws.com/openpay-data.v1.min.js"></script>

License

MIT