Skip to main content

Configuring refund options

Refund options available to the store associates during returns via NewStore Associate App can be configured either for:

  • Each specific store for the retailer
  • All stores configured for the retailer
Important

Set up refund options on a global level (all stores) for retailers currently using NewStore Associate App v1.2.0 or later.

Setting up refund options for specific stores, however, is optional.

Configuring refund options with extension slots​

For retailers that have set up extension slots in their version of NewStore Associate App for refunds, NewStore checks for refund options in this sequence:

  1. Refund options set up in NewStore Associate Appextension slots , in a way that they override all other configurations.
  2. Refund options in extension slots that are set up to work with other refund options configured for the retailer via the support team. Based on how these extensions have been set up, this may include:

For help with such refund options, contact the support team or Team Mobile Apps.

Configuring refund options without extension slots​

For retailers that do not have extension slots configured for refunds, NewStore checks for refund options in this sequence:

  1. NewStore checks the payment_options that have beenconfigured for a store .
  2. If no refund options are specified for a specific store, NewStore uses the refund options configured globally for the retailer.

Unless customized specifically for the retailer, the following refund options are displayed in NewStore Associate App:

  • Returns: All refund options.
  • Blind returns: All refund options except the original payment method.
  • Items returned for an exchange: All refund options.

Configuring refund options for a specific store​

  1. Retrieve the current refund configuration using the Get payment options configuration method.
  2. In the store_mapping > refund_options key, specify the list of refund options that are available to store associates in a specific store in NewStore Associate App.
  3. Use the Update payment options configuration method to update the refund configuration for your business.

For example, specify gift_card instead of adyen as one of the available refund options in refund_options for the store (specified in store_id), where you want associates to use a gift card to issue refunds to the customer. See the example:

[
 {
   "payment_options": [
     "stripe",
     "adyen",
     "cash",
     "gift_card",
     "newstore_checkout",
     "square"
   ],
   "refund_options": [
     "original",
     "credit_card",
     "gift_card"
   ],
   "store_id": "store1_NYC"
 }
]

Gift card is then displayed as one of the available refund options for this specific store during a return in NewStore Associate App.

Configuring global refund options​

  1. Retrieve the current refund configuration using the Get payment options configuration method.
  2. In the refund_options key, specify a list of refund options that are available to store associates for the retailer, during returns via NewStore Associate App.
  3. Use the Update payment options configuration method to update the refund configuration for your business.

For example, specify original, credit_card, and gift_card, for these refund options to be displayed to associates in NewStore Associate App for all stores for the retailer.

Refund options specified for a store overrides the configuration specified at the retailer level.

Configuring and using granular external refund options​

Supported from
This feature is supported from Associate App v1.51.0 and later..
note

Prior to the release of Associate App 1.51.0, retailers using the non_integrated/External Payment and Refund option had only a single payment or refund option in the Associate App. After upgrading to Associate App version 1.51.0, retailers who do not want granular external payment options need not modify their existing configurations.

Retailers who choose to use more granular external refund options as part of the Associate App, along with the ability to track these granular payment options, must make the following configuration changes to enhance their store associate experience and their back office reconciliation data and visibility.

To create granular payment methods for external payments, use the Update Payment Options Configuration and follow the steps below:

  1. Decide whether the configuration levels for non-integrated payment options will be global or store-specific.
  2. Add non_integrated to the list of refund options at the appropriate level.
  3. Define the non_integrated_methods_definition object, which will map custom granular payment/refund methods to a key (used for event stream and payloads).
  4. Now, set up the non_integrated_methods list for each store you want to display granular external methods in, or on the global level if you want to display the same in every store. This list will reference the methods you created definitions for by key.

This configuration adds the External Refund option to the NewStore Associate App's refund options list and enables the user to display and select from a listing of granular refund methods under the External Refund option.

Visibility of external refund transactions {visibility-of-external-refund-transactions}​

Retailers can validate and monitor external refund transactions and the specific granular refund methods used in them. Transactional details are available via the NewStore Omnichannel Manager, event stream, payment APIs, and NewStore Insights.

NewStore Omnichannel Manager visibility

The NewStore Omnichannel Manager provides payment visibility on orders where external payments/refunds have been applied. For these transactions, the user is shown the specific external payment/refund method selected and the amount processed per payment method.

API usage and visibility

In the payment accounts API, the call to get a summary of the payment account uses the “method” and “PSP” objects. The “PSP” object records “non_integrated” as its value, and the “method” object records the “property name” of the non-integrated payment method.

Event stream visibility

As part of the NewStore event stream schema, external payment/refund information can continue to be found under instruments > payment_method.

NewStore insights visibility

Transactions that have external payments/refunds as part of the order are displayed within NewStore insights and use the value from "property name" in the payment configuration. These transactions are reflected in the "Payment Method" column.

Related topics