Payment Run Authorisation Component

Overview

The Payment Run Authorisation is an embeddable Secure UI Component that is initiated to perform SCA to authorise a payment run. When initiating the UI Component, users will be prompted to:

Payment Run Overview: The user will be prompted with the 1st step to review the overall details of the Payment run.
Payment Review: The user needs to review all the payments in the Payment Run to ensure that the each line item is reviewed.
Verify SCA Challenge Once all the payments are reviewed and confirmed, the user will be prompted with the final screen to enter the OTP and verify the SCA challenge.

Pre-requisites

To complete a Payment Run authorisation, the user must:

Be logged-in and have the Controller role assigned
Have enrolled their device for SCA
Have a Payment Run in a PENDING_CHALLENGE state

Embed the Payment Run Authorisation UI Component

The Payment Run Authorisation Component requires the below parameters in order to be initialized successfully.

tip

To use Weavr UI components, you must first set up the Weavr UI library in your application and ensure that you have an authentication token set as per instruction.

paymentRunAuthz(paymentRunId, options);

Parameter	Type	Required?	Description
`paymentRunId`	string	Required	The payment run Id that requires payment authorisation.
`options`	object	Optional	Add styling to the component.

const pra = weavrComponents.prompt.paymentRunAuthz(paymentRunId, options);

Mounting

To display the component on the screen, it's necessary to mount it to the DOM. This involves creating a wrapping element that will serve as the container for injecting the secure frame. Be sure to assign an id to the HTML element.

note

Upon mounting to the element target the component will immediately call the necessary API’s in order to populate the necessary data on screen.

<!--pra.html-->
<div id="pra-example"></div>

// secure-pra.js
const pra = weavrComponents.prompt.paymentRunAuthz(paymentRunId, options);
pra.mount("#pra-example");

Look and feel

The options parameter manages the overall appearance of the component. The below defines the options object:

Property	Type	Required?	Description
`classNames`	object	Optional	Defines which classes are to be appended to the wrapping element.
`style`	object	Optional	Defines the look and feel of the components elements.

const pra = weavrComponents.prompt.paymentRunAuthz(paymentRunId, {
  classNames: "pra-class",
  style: {
    // Definition found below
  },
});

Property Definitions

`style`

The specified styles will be implemented on the component when it is mounted. While all key-value pairs are optional, each has a default value assigned. You can customize the default values by passing the desired values accordingly

Property	Type	Required?	Description
`container`	object	Optional	Styles the wrapping element of the component that within the secure frame
`lineColor`	string	Optional	Line color.
`buttons`	object	Optional	Defines the look and feel of the button elements.
`consentFont`	object	Optional	Defines the look and feel of the font used in the consent.
`table`	object	Optional	Defines the styling of the table element for the component in subject.
`smallTextColor`	string	Optional	Defines the look and feel of the font used in the consent.

const sca = weavrComponents.prompt.paymentRunAuthz(paymentRunId, {
    classNames: 'pra-class',
    style: {
        container: {
            height: '900px',
            fontSize: '1rem',
            fontFamily: 'Inter',
            backgroundColor: '#fff',
            padding: '3rem',
            borderRadius: '1rem',
            ...
        },
        lineColor: '#E0E0E0',
        buttons: {
            buttonRadius: '1rem',
            buttonBackgroundColor: '#F4F4F4',
            buttonTextColor: '#0F0B3E'
        },
        consentFont: {
            headingIconColor: '#0F0B3E',
            bodyTextColor: '#595959 ',
        },
        table: {
            alternatingRowColor: '#FEFEFE',
        },
        smallTextColor: '#0F0B3E'
    }
})

`container`

Each property follows the object format outlined below. This object features the following parameters, with each one accepting inputs based on the provided link.

note

The Pseudo-Class Object is a recursive structure composed of the same properties listed below. During recursion, the properties specific to the Pseudo-Class are omitted.

Parameter	Type	Required	Description
`backgroundColor`	string	Optional	Background color
`border`	string	Optional	Border width, style, and color
`borderRadius`	string	Optional	Border rounded corners
`classesNames`	string	Optional	Custom styling, or referencing in your stylesheet
`color`	string	Optional	Text color
`fontFamily`	string	Optional	Text font
`fontSize`	string	Optional	Font size
`fontSmoothing`	string	Optional	Font smoothing (anti-aliasing)
`fontStyle`	string	Optional	Text Style (italic or normal)
`fontVariant`	string	Optional	Text with small caps (or other font variants)
`fontWeight`	string	Optional	Text weight (thickness or boldness)
`height`	string	Optional	Component height
`letterSpacing`	string	Optional	Space between characters in the text
`lineHeight`	string	Optional	Height of text
`margin`	string	Optional	Spacing within component
`padding`	string	Optional	Spacing inside Component (between content & border)
`textAlign`	string	Optional	Horizontal text alignment
`textDecoration`	string	Optional	Text underline or overline
`textIndent`	string	Optional	First line text indentation
`textShadow`	string	Optional	Text shadow effect
`textTransform`	string	Optional	Text capitalization

`:hover`	object*	Optional	Pseudo-Class Triggered when a user interacts with an element using a pointed device e.g. cursor

`buttons`

Describes the look and feel of the buttons found in the Payment Run Authorisation component.

Property	Type	Required?	Description
`buttonRadius`	string	Optional	The radius of the buttons.
`buttonBackgroundColor`	string	Optional	The background color of the buttons.
`buttonTextColor`	string	Optional	The buttons text color.

`consentFont`

The Payment Run Authorisation component will prompt for acceptance of consents. The below describes the consent font style

Property	Type	Required?	Description
`headingIconColor`	string	Optional	Any heading found in the component.
`bodyTextColor`	string	Optional	Any consent related text in the component.

`table`

Describes the Payment's table look and feel.

Property	Type	Required?	Description
`alternatingRowColor`	string	Optional	The background color of the alternating row found in the payment's table.

Functions

You can interact with the library's components by utilizing the exposed functions. The below is a list of functions exposed for the Payment Run Authorisation component

`mount`

The mount function is called in order to mount a component into the defined selector.

paymentRunAuthz.mount(selector);

`unmount`

The unmount function is called in order to unmount a component from its selector.

note

Once a component is unmounted it can be remounted. One can remount the component utilizing the mount function.

paymentRunAuthz.unmount();

`destroy`

The destroy function can be used to remove the element and its references from the DOM.

note

Once a component is destroyed it cannot be remounted. The component will be removed from Document Object Model (DOM) alongside any references and will need to be re-initialised

paymentRunAuthz.destroy();

`on`

This function makes event listeners available for interacting with the component during events.

paymentRunAuthz.on(event, listener);

`off`

This function provides the capability to detach event listeners from the component.

paymentRunAuthz.off(event, listener);

Events

The component will trigger the following events. You can listen to these events by attaching event listeners.

Event	Trigger condition
`ready`	Component has been initialisation successfully.
`change`	When component's state changes.
`error`	An error is returned during API requests. If not handled, an error is returned.
`accept`	Triggered when the Payment Run Authorisation is fulfilled.
`decline`	Triggered the decline button is clicked.

// Example - listen for ready event
paymentRunAuthz.on("ready", (event) => {
  // do something
});

// Example - listen for accept event
paymentRunAuthz.on("accept", (event) => {
  // do something
});

Examples

1. Show Payment Run Authorisation

<!--pra.html-->
<div id="pra-example"></div>

// pra.js
const options = {
  classNames: "pra-class",
  style: {
    container: {
      height: "900px",
      fontSize: "1rem",
      fontFamily: "Fuggles",
      backgroundColor: "#F0EDDE",
      padding: "3rem",
      borderRadius: "1rem",
    },
    lineColor: "#3CF7CA",
    buttons: {
      buttonRadius: "1rem",
      buttonBackgroundColor: "#7C1869",
      buttonTextColor: "#3CF7CA",
    },
    consentFont: {
      bodyTextColor: "#7C1869",
      headingIconColor: "#2A2B44",
    },
    table: {
      alternatingRowColor: "#FEFEFE",
    },
    smallTextColor: "#3CF7CA",
  },
};

const pra = weavrComponents.prompt.paymentRunAuthz(paymentRunId, options);
pra.mount("#pra-example");

pra.on("decline", (event) => {
  console.log("Decline", event);
  pra.destroy();
});

pra.on("accept", (event) => {
  console.log("Accept", event);
  pra.destroy();
});

Overview​

Embed the Payment Run Authorisation UI Component​

Mounting​

Look and feel​

Property Definitions​

style​

container​

buttons​

consentFont​

table​

Functions​

mount​

unmount​

destroy​

on​

off​

Events​

Examples​

1. Show Payment Run Authorisation​

Overview

Embed the Payment Run Authorisation UI Component

Mounting

Look and feel

Property Definitions

`style`

`container`

`buttons`

`consentFont`

`table`

Functions

`mount`

`unmount`

`destroy`

`on`

`off`

Events

Examples

1. Show Payment Run Authorisation