Installation
Tonder’s Ionic SDK can be installed using our npm package. To do so, use the following command:Requirements
To configure our SDK you need to add the following script tags to your HTML:You can also install each one with their respective npm packages
Configuration
With Tonder’s SDK installed, and requirements met, you are ready to configure and use the SDK. The following step-by-step process takes you through everything, from starting a new instance, to performing a new transaction using the needed methods:1
Mobile settings
Follow the instructions below to configure your mobile application for Android and iOS devices.
- Android
- iOS
To deploy your app on Android, you must add the Internet permission to your
AndroidManifest.xml file. Add the following code to your XML:2
Add the required ID to your HTML
Tonder’s Ionic SDK Full requires a
tonder-checkout ID to work, which needs to be added to an empty div as shown below:3
Initialize Tonder's SDK Instance
Initialize Tonder’s Ionic SDK Full instance:Below is a table of all parameters available, including the required ones for initialization:
| Property | Type | Required | Description |
|---|---|---|---|
mode | string | ➖ | Environment mode. Options: stage, production, sandbox. Default: stage |
apiKey | string | ✔️ | The API key used for authentication and authorization. |
returnUrl | string | ✔️ | The URL to which the user is redirected after the checkout process, regardless of success or failure. |
renderPaymentButton | boolean | ➖ | Use this flag if you need render Tonder’s default payment button. Default: false |
style | object | ➖ | The custom styles object to customize the checkout |
containerId | string | ➖ | If a custom checkout container ID is required. Default value: tonder-checkout. |
collectorIds | object | ➖ | If you require custom div container IDs.Default value: |
callBack | function | ➖ | Callback function to be invoked after the payment process ends successfully. |
isOpenpaySandbox | boolean | ➖ | Defines if Openpay works on the sandbox. Default value: true. |
isEnrollmentCard | boolean | ➖ | Use the SDK as an enrollment card. |
customization | object | ➖ | Object to customize the checkout behavior and UI. Default value: |
4
Inject checkout method
Call the This method will use the element with id 
With this, you can render the checkout to your customers.
injectCheckout method with your inlineCheckout instance, with the code below:tonder-checkout added in Step 2 to render the checkout elements, as exemplified by the image below:
Class Methods
After properly configuring your Full SDK instance, you have at your hand various methods to work with Tonder. Below you will find a detailed information about the checkout data needed with an example, and all the available methods in the SDK.Configure Checkout
Inject Checkout
Payment
3DS Verification
Save Card
Remove Checkout
Set Payment Data
Configure Checkout
You can use theconfigureCheckout method to set initial customer information, such as their email address, allowing to retrieve the respectives user’s saved cards.
Inject Checkout
TheinjectCheckout method is a function that allows you to incorporate Tonder’s Checkout feature into your application. This function leverages the element with the ID tonder-checkout that was added in Step 1 to display the checkout components on your page. To use this method, use the following code:
Payment
To create a new payment with the Lite SDK, use thepayment method. This method requires an object as parameter with the following data:
customer
customer
cart
cart
Item Object Structure:
card
card
Alternatively, if using a saved card, replace the
card object with the saved card’s identifier:payment_method
payment_method
Specify this key if using a different payment method instead of a card.
metadata
metadata
Create Payment response
Create Payment response
The response to this method will be the following:
3DS Verification
You can use theverify3dsTransaction() method to validate if a 3DS challenge was successful or not. Use the example below to call the method and handle the response as needed:
Save Card
You can use this method when using the SDK instance as an enrollment card feature withisEnrollmentCard.
Remove Checkout
Removes the checkout from the DOM and cleans up associated resources.Set Payment Data
ThesetPaymentData method requires a checkoutData object as a parameter to pass checkout data to Tonder. This is useful when using the default Tonder payment button renderPaymentButton. Use the code example below to call it:
Checkout Data
The payment function payload needs to be an object with detailed information about the customer, currency and cart. Below you find details abou each needed field:Customer
Customer
Currency
Currency
Cart
Cart
Checkout Data Example
Below you find an example of a checkout data object:checkoutData example
checkoutData example
Styles
You can customize your checkout in two ways using Ionic SDK Full. You can either include a style parameter when creating theInlineCheckout instance or use HTML and CSS.

Include a Style Parameter
To include the checkout styles, add an object with the desired styles to thestyles parameter when creating the instance, like presented below:
customStyles example
customStyles example
HTML and CSS
To customize your checkout using HTML and CSS, you can use predefined classes in your HTML and customize them in the CSS. The styles parameter is related to the style of the inputs inside the checkout form. To customize the checkout container and the cards list, you can use the global styles and classes presented below:CSS
CSS
Form
Form
Cards list
Cards list
Full Integration Example
Below you find full example codes to integrate the Ionic SDK Full:Ionic Angular - Checkout
Ionic Angular - Checkout
For Angular, we recommend using a service to manage the Tonder instance:Checkout component:
Ionic Angular - Enrollment Card
Ionic Angular - Enrollment Card
For Angular, we recommend using a service to manage the Tonder instance:Enrollment component:

