Offline Refund elements

Learn how to use the offline refund element.

Collecting details from your customer may be necessary to facilitate a refund with certain payment flows such as Konbini, Online Banking, or Wire Transfer.

For integration details, refer to Refunding asynchronous payment methods.

Creating an Offline Refund element

You should use the createElement function exposed through the DigitalRiver Object. This object follows the same pattern and allows for the same custom classes and styles as other elements.

With this element, you must provide a refundToken, which is provided in the refund response from our APIs.

Example

var offlineOptions = {
    classes: {
        base: "DRElement",
        complete: "offline-refund-complete",
        invalid: "offline-refund-invalid"
    },
    style: {
        base: {
            color: '#495057',
            height: '35px',
            fontSize: '1rem',
            fontFamily: 'apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,sans-serif',
            fontWeight: 'lighter',
            ':hover': {
                color: '#ccc',
            },
            '::placeholder': {
                color: '#495057'
            }
        },
        focus: {
            ':hover': {
                color: '#495057',
            },
        },
        empty: {
            ':hover': {
                color: '#495057',
            },
        },
        complete: {
            ':hover': {
                color: '#495057',
            },
        }
    },
    refundToken: 'fb19fceb-a5e7-454d-af1a-017b7bd73d5b'
};


let offlineRefund = digitalriverpayments.createElement('offlinerefund', offlineOptions);

Offline Refund element functions

offlineRefund.mount();

Call this function to place the created offline refund element on your page.

Example

<div id="offline-refund"></div>

offlineRefund.mount('offline-refund')

offlineRefund.unmount();

Call this function to remove the offline refund element from your page. The element may be re-added to your page by calling mount().

Example

offlineRefund.unmount();

offlineRefund.destroy();

Call this function to remove the offline refund element from your page as well as remove its functionality. You cannot re-add an element that has been destroyed to your page via mount().

Example

offlineRefund.destroy();

Offline Refund element events - offlineRefund.on('event', handler);

Use this function to listen to events that can be used to build and enhance your purchase flow.

Event	Triggered When
ready	The created element is loaded and ready to accept input.
change	The element's state has changed.

Ready

The Ready event triggers when the element loads and is available to take user input.

Example

offlineRefund.on('ready', function(event) {
    //offline refund element is ready and can accept user input
});

Response object

{
    elementType: "offlinerefund"
}

Change

A change event triggers when the offline refund element's state has changed. If using this element, you will only receive this event when the customer has filled out the form and the data has been accepted. At this point, you may remove the element from your screen by calling unmount() or destroy().

Example

offlineRefund.on('change', function(event) {
    console.log('offline refund change', event);
});

Key	Value Description
complete	Whether the element is in a complete state.
elementType	The type of element.

Response object

{
    complete: true,
    empty: false,
    elementType: "offlinerefund",
    error: null
}