evertec / athmovil-javascript-api

Technical documentation used to integrate ATH Móvil's Payment Button on websites using HTML and Javascript.
6 stars 0 forks source link

ATH Móvil Payment Button - Javascript Integration and Services

Change Log

Date Changes Comments
08/17/2023 Initial version 1.0
07/17/2024 Version 1.2 General information related to ATH Business & ATH Móvil with instructions on how to open an account.
10/30/2024 Version 1.2.1 General information related to the Javascript configuration.

Table of Contents

Introduction 3******

Prerequisites 3**

Support 4**

Customer Experience 4**

Installation 5**

Usage 8**

Callback Functions 11**

Find Payment Service 14**

Transaction Expired or Canceled Response: Status CANCEL 17**

Refund Payment 17**

Cancel Payment 19**

Error Messages 20**

User Flow 27**

Legal 28**

Reporting 28**

Other information 28**

Introduction

ATH Móvil's Javascript integration provides a simple, secure and fast checkout experience to customers paying on your website. After integrating our Payment Button on your website, you will be able to receive real time payments from more than 1.5 million ATH Móvil users.

The API called for this JavaScript code is build based on JWT protocol to securely authenticate the communication between our services.

Disclaimer: The Payment Button ATH Móvil is not compatible with any major Ecommerce platform. This includes Shopify, Wix, Woocommerce or Stripe.

Disclaimer: We currently do not have a Testing environment. You need to have an active ATH Business account and a active ATH Móvil account.

Prerequisites

Before using the ATH Móvil’s payment you need to have:

ATH Business

1. An active ATH Business account.

2. A card registered in your ATH Business profile.

3. The public and private key assigned to your business.

For instructions on how to open a ATH Business account please refer to: ATHB flyer eng letter 1.pdf

For more information related to ATH Business and how it works please refer to:ATH BUSINESS_Apr2024.pptx

ATH Móvil

To complete the payment for testing purposes you need to have:

1. An active ATH Móvil account.

2. A card registered in your ATH Móvil profile. It can not be the same card that is registered in ATH Business.

For more information related to ATH Móvil and how it works please refer to:ATH Móvil_Apr2024.pptx

To start working with the Javascript for ATH Móvils Payment Button with all its services, it is mandatory to have a Public Token per each business. This Public Token is found in the settings section of the ATH Business app and is assigned one unique token per ATH Business account.

Additionally have the link for athmovil_base.js to add it in your ecommerce platform with a tag.

Production link: https://payments.athmovil.com/api/js/athmovil_base.js

<script>
    var publicToken = "a66ce73d04f2087615f6320b724defc5b4eedc55";
</script>
<script src="https://payments.athmovil.com/api/js/athmovil_base.js"></script>

ATH Business Settings:

image image

Support

If you need help signing up, adding a card or have any other question please refer to https://ath.business.com/preguntas. For technical support please complete the following form: https://ath.business/botondepago.

Customer Experience

The new version of the payment button will introduce more security and synchronization with both the merchant and the customer. Here you can see a brief diagram on the high-level flow of the transaction:

image

Installation

From your ecommerce website identify the checkout page where you will display the payment button, for example: "my_cart.html".

Next add in your tag two scripts using Githubissues.

  • Githubissues is a development platform for aggregating issues.