Skip to main content

55 posts tagged with "Multi-v3"

View All Tags

· 3 min read

Simplified Step-Up flow for new mobile enrolment

Previously, when an End Customer enrolled their mobile phone for multifactor authentication via SMS OTP (POST/authentication_factors/otp/{channel}), they would have to request and input OTPs twice, once for the enrolment and again for the first Step-Up login to continue their session.

Now, the initial SMS OTP input that enrols the device also serves as the authentication to keep the user’s session Stepped Up. This reduces the required user steps in this initial enrolment workflow as well as reducing costs of SMS delivery.

All enrolment interactions and session Step-Up changes are sent in Webhooks to the Embedder's endpoint.

Update to User Profile interface in Embedder Portal

The Embedder Portal allows staff of the Embedder’s team to manage various aspects of their programme. The Portal Root User’s details were previously displayed to all users viewing the User Profile interface.

Since multiple different staff members can be given Embedder Portal access via unique logins as Additional Portal Users, we have now updated this interface to show profile details of the current logged-in user.

The ability to edit the “business name” in the profile interface is now restricted to only the Portal Root User.

All Embedder Portal users viewing their own profile can follow a link to initiate a self-service password change.

Additional characters allowed in cardholder names

In response to feedback we have extended the allowed character set on the nameOnCard and nameOnCardLine2 fields in the Multi API.

Previously the regex pattern for both fields was:


We are now extending the regex to allow cardholder names with the following characters:


Therefore the complete regex pattern will be:

^[a-zA-Z0-9ßÀÁ ÃÄÅÆÇÈÉÊËÌÍÎÏÒÓÔÕÖØŠÙÚÛÜŸÝĄĆČĎĘĹĽŁŃŇÑŐŔŚȘȚŤŰŹŻŽàáâãäåæçèéêëìíîïòóôõöøšùúûüÿýąćčďęĺľłńňñőŕśșțťűźżž\\-^. '-]*$

This new regex pattern applies in the following Multi API endpoints:

  • POST /managed_cards

  • GET /managed_cards

  • GET /managed_cards/{id}

  • PATCH /managed_cards/{id}

  • POST /managed_cards/{id}/physical

  • POST /managed_cards/assign

Additional endpoints now supporting idempotency

As mentioned in previous Release Notes, we are extending the list of endpoints in the Multi API which can be called idempotently. This can be achieved by including the idempotency-ref header in the requests.


In this release, the following Multi API endpoints can (optionally) be called idempotently:

  • POST /managed_accounts/{id}/iban to attach an IBAN to a Managed Account;

  • POST /managed_cards/{id}/physical to upgrade a virtual card to physical;

  • PATCH /managed_cards/{id}/spend_rules to update the spend rules for a managed card; and

  • POST /managed_cards/assign to assign a Managed Card.

Further information on idempotency is provided in our API Docs here.

· 3 min read

Enrolling new biometrics auth factor now has additional security requirement

When enrolling a mobile device for the biometrics authentication factor, an additional step is now required to corroborate the link between the legitimate user and the device. The user will need to have a successfully registered mobile number to use for SMS OTP prior to starting the biometrics enrolment.

As part of the biometrics enrolment flow, the user will need to pass an SMS OTP challenge.

When the end user requests to enrol their device, we check if there is a mobile number associated to that user:

  • If there is a verified number, Weavr will send an OTP over SMS to the user’s registered mobile number, which they can input in the request screen (provided in our biometrics SDK). If this OTP is valid, enrolment is successful.

  • if there is a number available, but not verified, Weavr will send an OTP over SMS to the user’s registered mobile number, which they can input in the request screen (provided in our biometrics SDK). If this OTP is valid, enrolment is successful and mobile number is automatically verified.

  • If the user does not have a mobile number or would like to change with another mobile number, the Embedder needs to call

PATCH/corporates PATCH/consumers

before triggering the SMS challenge for biometrics enrolment flow.

When a user tries to enrol his device for biometrics without having a mobile number, we are returning 409 - Mobile_Number_Not_Available

Other scenarios when PATCH should be called are:

  • user has an invalid format of the mobile number - 409 Mobile_Number_Invalid
  • user has a mobile number with a country code not supported - 409 Mobile_Country_Not_Supported

All these changes will be part of our future mobile SDKs releases.

Default complexity level for passwords is now set to 4

As part of a wider series of changes to enhance security for End Customers, we are increasing the default complexity level of the passwords to level 4. This means, that the password must be:

  • between 8 and 30 characters
  • include a lowercase character
  • include an uppercase character
  • include a digit and a special character
  • different from any of the 5 last such passwords used

If your users are having a Level 1 complexity password, they will be allowed to continue using Level 1 password until:

  • password expires - Level 4 complexity will be required for the new password
  • user triggers Forgot password flow - Level 4 complexity will be required for the new password
  • user changes the current password - Level 4 complexity will be required for the new password

· 5 min read

Biometrics for 3-D Secure card purchases in Android and iOS apps

Previously we’ve made biometrics in mobile apps available as a multifactor authentication option in Strong Customer Authentication (SCA) flows for account access and authorising financial transactions, excluding card payments. We are now extending biometrics support so that card payments can be confirmed by End Customers via face recognition or fingerprints in Embedder Android and iOS mobile apps, in line with 3-D Secure (3DS) standards.

Using biometrics for 3DS/SCA provides an excellent blend of security and convenience. Integration with biometrics is available for any Embedder with an Android or iOS app who has already implemented a baseline SCA solution (with SMS OTP or push authentication).

Our biometrics SDK is available for native iOS, native Android, React Native, and Flutter.

Find out more info on how to set up 3DS in our documentation.

Security notification email to End User on password change

As part of a wider series of changes to enhance security for End Customers, Weavr will now send an email directly to any End User who has changed their password. This ensures they are notified of a successful change in normal circumstances, and alerts them to unwanted changes in the event of a security breach.

End Users of Corporates and Consumer Identities can change their password via:

  • the "reset password/forgot password" flow
  • when logged in, in a "change password" flow


As with other transactional emails sent by Weavr directly to End Users, as the Embedder you have the option to apply your own brand design and potentially wording changes to this email template, subject to approval.

To create or change customised email templates, please open a support ticket.

Notification for rejected Incoming Wire Transfers

When an Incoming Wire Transfer (IWT) is received Weavr will send the Embedder a webhook to confirm its status. As all IWTs are screened in accordance with compliance and risk rules, some IWTs may be held in a suspended state pending a review, or immediately rejected back to the payer.

Previously, an “Account deposit” webhook was only sent for IWTs that reached the states PENDING and COMPLETED. This meant that there was a gap in communication for IWTs that ultimately reached the final state of REJECTED.

Weavr will now send an “Account deposit” notification via webhook with the state: REJECTED where applicable.

IWTs that have been rejected are also currently displayed in Data Insights in the Embedder Portal.

Webhook impacted: Account deposit

FAQ - Why are IWTs rejected?

The most common situation in which an IWT would be rejected is if a compliance review is initiated, and subsequently finds the IWT cannot be accepted (for example if the End Customer failed to provide the requested Source of Funds declaration in time).

In addition to manual compliance reviews, IWTs can be rejected according to automated criteria only. This particularly applies to SEPA Instant IWTs, which are subject to compliance and risk screening but cannot be held for manual review.

In both instances of the IWT rejection, funds will be returned to sender.

Additional digitalWalletType in in card purchase webhooks

In a previous release we introduced a digitalWalletDetails object in the Card Authorisation and Card Settlement webhooks that notes the digitalWalletType (GOOGLE_PAY or APPLE_PAY).

We are now introducing a third enum to digitalWalletType - MERCHANT_TOKEN - which is used when the transaction was conducted via a merchant tokenised version of the card. This refers to a card on file and is typically used for recurring transactions such as subscriptions.

Extending idempotency support to additional endpoints in Weavr Multi API

To help improve the resiliency of integrations with the Weavr Multi API, we’re extending support for idempotency to the following endpoints:

  • POST/users- Create and Authorised User
  • Post/stepup/challenge/otp/channel- Issue a one-time passcode that can be used to Step Up a token
  • POST/stepup/challenge/otp/{channel}/verify- Verify a Step-Up token using a one-time passcode
  • POST/managed_cards/{id}/spend_rules - Create spend rules for a Managed Card

The updated documentation regarding idempotency in the Multi API can be found here. We strongly recommend you review this documentation if you are planning to make use of idempotency, or indeed even if you are already doing so.

Weavr plans to extend idempotency support to most endpoints in the Multi API over a number of upcoming releases

Additional information provided when a user is INACTIVE

Users with an INACTIVE state are already displayed in the portal. A common reason why a Root User may reach this state is because during onboarding, they did not verify their email address (via the email verification process described in our documentation) within the time limit.

We have added additional information to the portal when a user is INACTIVE because of this reason.

You now have the option to filter users ABANDONED.


If an ABANDONED user registers again with the same email address (and completes the verification), the user becomes ACTIVE and will no longer be considered ABANDONED.

· 12 min read

SEPA OWTs now require description text from end user

In order to comply with European regulation, a payment reference must be provided by the payer when instructing a SEPA Outgoing Wire Transfer (OWT) regardless of the purpose of that OWT. As such, the description field will become mandatory for SEPA OWTs (the field exists but before this change was not mandatory). This requirement applies to both single OWTs and those created in bulk transactions.

(NB currently adding a description/reference is not mandatory on UK Faster Payments - i.e. for OWTs in GBP.)

The End Customer is required to provide the text during the UX flow of creating an OWT. Therefore, as the Embedder, if you have not previously made this field available in your application, you must now add it and make it mandatory to complete, in order to proceed with the OWT flow.

Here is example text for labelling the field in your application:

“Reference - Add text which to pass to the payee as the reason for payment or any payment reference”

End Customers may use this field as appropriate to the scenarios in which they are creating OWTs in your application, e.g. to add an invoice number or customer number on the payment to a business payee.

This text must be provided and confirmed by the End Customer. Therefore if your application suggests text for the End Customer to use, there must still be the option for them to edit it and accept the final text when proceeding with their OWT.

The field currently accepts a maximum of 35 alphanumeric characters, observing the SEPA extended character set (SEPA Requirements for an Extended Character Set (UNICODE Subset) - Best Practices)

The endpoints impacted are:

POST /outgoing_wire_transfers

POST /outgoing_wire_transfers/bulk/create

If the field is left empty or invalid, and your application attempts to submit the OWT to the Weavr system, our API will return a 400 error noting the description field is “REQUIRED”.

For successfully completed OWTs, the description is currently returned in the GET Outgoing Wire transfer Transaction APIs, and the GET Managed Account Statement API.

OTP retries are now limited

We will limit the number of times an OTP can be submitted incorrectly, to reduce the risk of fraud or abuse. This applies to all scenarios where an OTP is submitted by any kind of user.

For the example below, the number of attempts is 5. However, Embedders should handle the error appropriately rather than assume a fixed number of attempts.


After the 4th incorrect attempt a 409 Failed will be returned with error - "ONE_CHALLENGE_LIMIT_REMAINING"

After the 5th incorrect attempt a 409 Failed will be returned with error - "CHALLENGE_LIMIT_EXCEEDED"

If the challenge is being performed to verify a transaction (such as an OWT or a Send), after the 5th incorrect attempt, the state of the corresponding transaction will be updated to "REJECTED" and no further challenges can be triggered against this transaction.

Submitting another verify call will return Failed 409 - "STATE_INVALID"

Endpoints affected: /multi/challenges/otp/{channel}





The time limits for submitting an OTP to complete an action remain the same regardless of the timings of one or more errors or retries.

Phone numbers must now have standard country code for SMS delivery

In order to improve SMS deliverability we are making it mandatory to include the country code with the '+' symbol in the phone number.

Please ensure your users are entering the mobile number in the following format: [+Country Code] [ Mobile Number]

For existing Identities, Embedders do not need to amend data manually or ask End Customers to take any action, as Weavr will standardise existing data.

Creation of Authorised Users now requires Step-Up

Creation of an Authorised User linked to an Identity is a key moment in the integrity of the security for that Identity.

Therefore we are now requiring a session Step-Up when creating a new Authorised User. A new Authorised User can be created by the Root User or by another Authorised User. The active user can Step Up their token by completing a second authentication factor.

Weavr Multi supports the following methods:

  • One-time password via SMS
  • Biometrics
  • Twilio Authy Push Notification More details on how to step-up a token are available on our documentation.

KYC and KYB now require email verification at start of process

Previously it has been possible to start the KYC and KYB processes with an unverified email address, and validate it later. Now we require the email address of the Root User in Consumer and Corporate scenarios to be verified by an end user action before the KYC or KYB process can begin.

Email verification begins as described in our documentation for creating a Consumer or Corporate Identity.

  • An email verification link is valid for 60 minutes - we recommend Embedders provide clear instructions to end users to explain the time limit

  • The Embedder’s application can offer UI to the end user to “resend email verification link”.

  • Call the “Send an email verification code to the root user” API endpoint again

  • If the Embedder’s application requests to re-send the verification link, the new link will again be available for 60 minutes from the time it is created (and the previous link cannot be used)

  • If the user does not verify the email address within the time limit, and the link expires, the user will not be able to login (Weavr returns “403 Forbidden”) and therefore the Embedder’s application will need to prompt the end user to start the onboarding process again

  • If the user tries to start KYC/KYB without having the email verified, we will respond with 409 - Email_Unverified

API handling Step-Ups now uses consistent error code

In the situation when an API is called, and a Stepped-Up token is required but has not been provided, we currently respond with STEP_UP_REQUIRED, but sometimes as a message, and sometimes as an error. We have now aligned all our APIs to provide the response as an error code rather than a message. The endpoints impacted are:

GET /managed_cards

POST /managed_account

POST /managed_cards

GET /managed_accounts

GET /managed_accounts/{id}

GET /managed_cards

GET /managed_cards/{id}

PATCH /managed_accounts

PATCH /managed_cards

POST /managed_cards/assign

POST /managed_cards/{id}/physical

POST /managed_cards/{id}/physical

GET /managed_cards/{id}/physical/pin

POST /managed_cards/{id}/physical/replace_damaged

POST /managed_cards/{id}/physical/replace_lost_stolen

POST authentication_factors/push/{channel}

POST /users

In all cases if the session is not Stepped Up validly, we will respond with the error above.

New feature: payment card renewals

Payment cards issued across Weavr embedded finance programmes carry expiry dates. Up till now, if a cardholder needed to replace an expiring card, and the embedded finance use case called for it, the new card issued would have a new card number. This can cause inconvenience for cardholders because a new card number begins a new transaction history in terms of statements, reporting, and (where applicable) balances.

We are now introducing payment card renewals which allow the cardholder to be issued a new card with the same card number as before, with a new expiry date and CVV.

Here are some key points:

  • Renewal of a card, keeping the original card number, is an optional setting at the card level;

  • Cards not set to renew will still, as before, expire and not be automatically replaced;

  • When a card is set to renew, Weavr will automatically issue the new card;

  • This is available for both virtual and physical cards;

  • Automatic advance warning of upcoming card expiry is now available for all payment cards.

The option to enable automatic renewal of cards can be set at the point of creation for new cards, or can be updated at any point before the renewal date for existing cards.

Embedders can choose to expose this choice to the End Customers. If the Embedder chooses to enable automatic renewal for a specific card or more generally, we advise seeking agreement from the End Customer, although technically no end user interaction or confirmation is required in the current setup.

In the case of physical cards, lead time is required to allow for delivery to the cardholder. Where renewal is enabled on a physical card, the new card will be sent out with the process starting (currently by default) 30 days ahead of the expiry date, based on an internal “renewal date” for the card.

With this lead time in mind, Embedders should take the opportunity to check with the End Customer, further in advance of this renewal process, that their address for delivery of the card(s) is still up-to-date.

By default cards that are currently issued, and new cards issued from now on, will not automatically be set to renew. Therefore the Embedder needs to take a decision in general on their programme, and specifically within subsets of cardholders, whether to take advantage of this feature.

Key points about a new card on a renewal basis:

  • The long card number of the new card is the same as the original card

  • The expiry date is updated

  • The card has a new CVV

  • The PIN on the card remains the same as set by the cardholder, and they can update the PIN any time

  • The spend control rules applied to the original card are applied to the new card

  • New physical cards must be activated (via the API as per activating any new card), while new virtual cards are renewed with updated details immediately

  • Cards provisioned in mobile wallets (Google and Apple) are expected to continue working without the cardholder having to update or replace the original card they added

  • Soon-to-expire cards remain active and usable until the new card is activated

Please note: renewal of expiring cards is a different scenario from replacement of a lost or stolen card. In those scenarios the original card would be blocked immediately and a new card would be issued with a different long card number, as a security measure.

Notifications are sent via webhook relating to upcoming card renewals and expiry events:

CARD_ABOUT_TO_EXPIRE (60 days, 30 days, and 1 day before expiry date)



The Embedder’s system will need to listen on a new webhook:


New simulator tools have been added Sandbox area of the Embedder Portal to enable developers to test events related to card renewals and expiry.

Further developer documentation is available here.

Mobile wallet type (Google Pay / Apple Pay) included in card purchase webhooks

Embedded finance programmes with cards can apply to enable mobile wallet provisioning, allowing cardholders to add their card(s) to Google Pay or Apple Pay. Thanks to the dual benefit to users of enhanced security and convenience, programmes taking advantage of mobile wallet provisioning typically see a strong uplift in product engagement, card spend frequency, average transaction values, and overall card spend volume.

In order to help Embedders track these KPIs we are introducing a digitalWalletDetails object in the Card Authorisation and Card Settlement webhooks that notes the digitalWalletType (GOOGLE_PAY or APPLE_PAY). This makes it possible to tell, for any card purchase, if it was used through one of these mobile wallets.

Embedders whose programmes already allow End Customers to provision cards to mobile wallets can immediately start using this information for business intelligence, as well as making the data available for End Customers e.g. for use in accounting and business spend monitoring.

Webhooks impacted:

  • Card authorisations

  • Card settlements

In some business purchasing situations with commercial cards of Corporates, a merchant may seek a single cardholder authorisation for a total amount for a purchase and then break down a purchase into individual items (such as travel tickets). These will then appear to the cardholder as multiple smaller settlements. Previously only the first relatedAuthorisationId or relatedSettlementId was returned by Weavr in the ‘Card authorisation’ or ‘Card settlement' webhooks. This meant that references for any additional related transactions were omitted.

We have now introduced new fields in that can accommodate an array of related transaction IDs, so that the Embedder’s system, and through this the End Customer can correctly view a group of settlement transactions which relate to an original authorisation.

The fields added are:

  • Card authorisation webhook - relatedAuthorisationIds

  • Card settlement webhook - relatedAuthorisationIds and relatedSettlementIds

Alphanumeric SMS Sender ID for Finland and UAE

A few months ago, we implemented an enhancement to the Sender ID used in the SMS messages containing One Time Passwords (OTPs) and Strong Customer Authentication (SCA) for users with UK phone numbers. This was aimed at telecoms rules and deliverability of SMS.

The enhancement involved transitioning from the alphanumeric Sender ID "AUTHMSG" to the default "WEAVR" - or a customised one, for some Embedder programmes on request. This change only affected SMS messages sent to UK numbers, while other countries continued to receive messages with numeric Sender IDs.

We are now introducing a similar change for Finland and the United Arab Emirates (UAE). Regulators in these countries require that Sender IDs in SMS messages be alphanumeric to prevent blocking. As a result, users with phone numbers in these countries will now receive SMS messages with the default "WEAVR" Sender ID or the custom one specified by the Embedder.

This enhancement is automated and users with the country codes +358 (Finland) and +971 (UAE) will automatically receive the new Sender ID when requesting an OTP or SCA.

Managed Account Root Email and Processor Token added to Data Insights

As Embedder operations teams managing B2B programmes in production, you’ll often want to drill down into certain details for support cases for Corporate End Customers, or create reports to help with proactive customer success monitoring.

To help with this, we have added two new fields as columns in the details view of the Managed Accounts dashboard in the Embedder Portal:

  • Root Email, i.e. the email address of the Root User Identity owning each Managed Account

  • Processor Token, i.e. an identifier for a Managed Account in our underlying payment system that can be useful for Embedders and Weavr in support cases where we need to track a transaction state or exception

· 4 min read

New Data Insights

We provide Embedders with data reports and dashboards in the Embedder Portal, collectively referred to as Data Insights. With this release we’re launching a significant wave of improvements and additions across Data Insights.

Key changes include:

  • dashboards have a fresh new look, with charts split across focused tabs; tabs have different purposes, including an overview, analytical tabs and more detailed tabs with transactional information

  • all charts within Data Insights (except for KPIs and tables) now offer an interactive drill-down functionality, allowing Embedder staff a way to see a detailed view of a particular bar/segment

  • an informational tooltip has been introduced within each chart, providing definitions and granularity details pertaining to that chart

  • filters have been enhanced to offer a drop-down menu, making it easier to find what you are searching for

  • improvements to performance

Detailed documentation around Data Insights is now available within the knowledge base section of the Weavr support portal here. This is also linked via the Help button within the Embedder Portal.

We’d like to hear your feedback about Data Insights. Please speak with your Weavr contacts to share your ideas.

Data Insights enhancement - reporting on Authorisations in mobile wallets

We have introduced a new Authorisation Details tab within the XPay Enabled Cards dashboard (formerly known as the Apple Pay/Google Pay Overview dashboard).

This new tab will help Embedder programme operations and support staff identify whether a card payment Authorisation has been done with a card that is provisioned in Apple Pay or Google Pay mobile wallets. The detailed view includes various details such as merchant details, device details, and instrument amounts.

New error message if new Step-Up is retried too fast after initial attempt

We are always looking to improve the error messages returned by the Weavr APIs. Within the Step-Up flow, if the Embedder’s application attempts to start a new Step-Up for a user before the first one has been completed or timed out, we have replaced the error “400 Invalid_request” with the more specific “409 Retry_in_15sec”.

The flow works like this:

  • Embedder’s application calls Weavr API to start Step-Up flow
  • Weavr awaits a response showing the user has not completed the challenge
  • Before any response it received, the Embedder’s application begins a new Step-Up attempt within 15 seconds of the first
  • This results in the error “409 Retry_in_15sec”

If a new Step-Up is started after 15 seconds from the first attempt, then the first attempt will be invalidated and the user will need to respond to the new challenge.

In general, Embedders must provide reasonable times for users to complete multifactor authentication challenges and not make repeat requests on the API for Step-Up in a short space of time.

New error message for a step-up called twice

We have improved the response for the scenario when the Step-up verify endpoint was called twice. If by mistake, you were calling twice the Verify endpoint for the same token that has been already stepped-up, we returned error State_invalid. In order to become more clear on the situation, for the above scenario we are changing the error from State_invalid to Already_verified. More details on step-up authentication is available here.

Ensuring emails are unique in your programme

In some programmes, Embedders have encountered problems when legacy sign up flows allowed the same email to be used for a Consumer Identity at the same time as a Corporate Identity. In these types of programme we are now enforcing that the email address of a user has to be unique at the programme level.

Custom tags for Authorised Users

Authorised Users can multiply in programmes with lots of cardholders. As an Embedder you’ll want to manage interactions and data around Authorised Users, so we’ve introduced an optional tag field which allows you to store custom information against those records.

The Authorised User Tag can be included in API calls as follows:

  • POST/users
  • GET/users
  • PATCH/users{user_id}

The tag is available when filtering Authorised Users in the Embedder Portal: