@1point6/1point6-js

v1.0.1

Published

8 months ago

1point6.js loading wrapper

Downloads

0High
0Medium
0Low

gplumeyget1point6

1point6 1point6js 1point6.js 1point6.js loading wrapper

Functional Perimeter

Accept payment methods from all over the world with an integrated and secure user interface component.

The Payment Element is a user interface component for the Web that accepts more than one payment method, validates input, and manages errors. Use it alone or with other front-end elements of your Web application.

How It Works

Installation

Installation via our 1Point6JS library

1Point6JS is a wrapper that simplifies loading 1point6 on your website. It ensures that it is only loaded once and offers TypeScript autocomplete.

Installation of 1Point6.js

Use npm (for example) to install the 1Point6.js module:

npm install @1point6/1point6-js

Usage

load1Point6

This function returns a promise that resolves with a newly created 1Point6 object once 1Point6.js has been loaded. It takes the same parameters as those passed during the direct initialization of a 1Point6 instance. If necessary, it will load 1Point6.js for you by inserting the 1Point6.js script tag. If you call load1Point6 in a server environment, it will resolve to null.

import { load1Point6 } from "@1point6/1point6-js";

const get1Point6 = await load1Point6(
  publicApiKey, // "public_0b38ef2f95c09ad0aa08"
  'sandbox', // "sandbox" or "production"
  'my-sandbox-instance', // Only required if you are using the sandbox environment
});

publicApiKey: We have placed a random API key in this example. Replace it with your actual publishable API keys to test this code via your 1Point6 account. You can find your API keys in your 1Point6 Dashboard.
env: The environment in which to load 1Point6.js. Can be sandbox or production.

Manual Installation

Manually add the 1Point6.js script tag to the of each page on your site. If an existing script tag is already present, this module will not insert a new one. When you call load1Point6, it will use the existing script tag.

<!-- Somewhere in your site's <head> -->
<script src="https://js.get1point6.com/" async></script>

1) Creating a paymentIntent (Backend)

On the server side, proceed to create a paymentIntent on the route https://api.get1point6.com/payment-intents

Example in PHP:

function createPaymentIntent($items) {
    $username = 'Your private key';
    $password = "";

    // Calculate your product totals on the back-end to avoid any manipulation of object in front
    $calculateOrderAmount = function() use ($items) {
        $itemTotal = 0;
        foreach ($items as $item) {
            $itemTotal += $item['quantity'] * $item['price'];
        }
        return $itemTotal;
    };

    $paymentIntentBody = [
        'amount' => $calculateOrderAmount(),
        'currency' => "EUR",
        'return_url' => "https://www.my-shop.com/order/cart/checkout-onshop",
        'transfer_data' => [
            [
                'destination' => 'Your accountID',
                'amount' => $calculateOrderAmount(),
                'application_fee' => 0,
                'availability_type' => "IMMEDIATE"
            ],
        ],
    ];

    $ch = curl_init("https://api.get1point6.com/payment_intents");
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($paymentIntentBody));
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        "Content-Type: application/json",
        "Authorization: Basic " . base64_encode($username . ":" . $password)
    ]);

    $response = curl_exec($ch);
    curl_close($ch);

    $paymentIntent = json_decode($response, true);
    return $paymentIntent['secret_key'];
}

With $items:

// Replace with your backend product price retrieval logic

$items = [
    [
        'quantity' => 2, // Quantity of item 1
        'price' => 10.00 // Price of item 1
    ],
    [
        'quantity' => 1, // Quantity of item 2
        'price' => 20.00 // Price of item 2
    ],
        ...
];

2) Create a Payment Element (Frontend)

This code creates a Payment Element and mounts it on the DOM:

const get1Point6 = await load1Point6("your public key");

const appearance = {
  /* appearance */
};
const options = {
  /* options */
};
const elements = get1Point6.elements({ clientSecret, appearance }); // Replace clientSecret with your secret returned by the previously created paymentIntent
const paymentElement = await elements.create("payment", options);
paymentElement.mount("#payment-element");

(Optional) Appearance

Use the Appearance API to control the style of all elements. Choose a theme or update specific information.

For example, choose the "flat" theme and replace the main text color.


jsx
const get1Point6 = await load1Point6('your public key');

const appearance = {
  theme: '1point6',
  variables: {
      colorPrimary: '#587a9d',
      colorBackground: '#ff0000',
      colorText: '#515581',
    },
};
const options = { /* options */ };
const elements = get1Point6.elements({ clientSecret, appearance }); // Replace clientSecret with your secret returned by the previously created paymentIntent
const paymentElement = await elements.create('payment', options);
paymentElement.mount('#payment-element');

3) Making the Payment on the Client Side

When your client clicks on the payment button, call confirmPayment() with the PaymentElement and pass a return_url to indicate the page to which 1Point6 should redirect the user once the payment is made. For payments requiring authentication, 1Point6 directly displays the 3DSecure authentication request or redirects the client to an authentication page, depending on the payment method. Once the authentication process is finalized, the client is redirected to the return_url.

document
        .querySelector("#payment-element")!
        .addEventListener("submit", handleSubmit);

      async function handleSubmit(e: any) {
        const { error } = await get1Point6.confirmPayment({
          elements,
          confirmParams: {
            return_url: `https://www.my-shop.com/order/success`,
          },
        });
        // Error handling
        if (error.type === "card_error" or error.type === "validation_error") {
          console.error(error.message);
        } else {
          console.error("An unexpected error occurred.");
        }
      }

Error Handling

In the event of an immediate error (e.g., the card is declined), 1Point6.js returns an error. Display this error directly to your client so they can make another payment attempt.

Displaying a Message on the Payment Status

When 1Point6 redirects the client to the return_url, the query parameter payment_intent_client_secret is added by 1Point6.js. Use it to retrieve the PaymentIntent in order to determine the data to display to your client.