Skip to main content

Multi API v3.51.1

· 9 min read
Kristina Gauci

Service Updates​

Physical payment card fulfilment centre in EU​

We are glad to announce the availability of card printing and logistics based in the EU.

This will help reduce delivery times for EU-based cardholders compared to the main fulfilment centre in the UK.

If you have queries about card printing and delivery for your programme, including pricing, contact your Account Manager, or open a support ticket, and we’ll be glad to assist.

Digital signature in KYBKYB Know Your Business - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers. forms​

A reminder to EmbeddersEmbedder A company or developer that integrates Weavr's embedded finance services into their own application to provide financial services to their end customers. that digital signatures on PDFs (such as via Docusign or Pandadoc) are acceptable for completion of various forms in the KYBKYB Know Your Business - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers. process such as UBO declarations.

If you have any queries about the KYBKYB Know Your Business - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers. process and documents/steps, contact your Account Manager or open a support ticket and we’ll be glad to assist.

Product Updates​

KYBKYB Know Your Business - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers.: Proof of ID document expiry process changes​

We are making a number of changes in this release to how we handle expiry of proof of ID (PoI) documents in KYCKYC Know Your Customer - the identity verification process for consumer identities. This process allows you to seamlessly and securely verify your user's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers. and KYBKYB Know Your Business - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers.. Expiry refers to the “valid until” or “expires” date shown on the form of ID (such as a passport or national ID card).

The key points are as follows:

  • Any Consumer with an expired PoI document will be restricted from transacting, after a reasonable time to react to support requests, until they return their KYCKYC Know Your Customer - the identity verification process for consumer identities. This process allows you to seamlessly and securely verify your user's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers. to good standing by providing a replacement/valid ID document (all else being in good standing).

  • Any Corporate’s KYBKYB Know Your Business - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers. good standing depends on the individual PoI documents being valid (not expired) for the Root UserRoot user The individual who creates the identity. For corporate identities, the root user needs to be a legal representative of the corporate such as a director or a representative who has the power of attorney over the company. For consumer identities, the root user is the owner of the identity. Every identity must always have one root user. (/appointee), plus ALL of Ultimate Beneficial Owners (UBOs). All of the Corporate’s accounts/cards will be restricted from transacting if any of the required IDs are deemed to be out of date after attempts to alert the stakeholders, until brought back into good standing.

  • In any actual restriction action Weavr will sendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. a webhook and notification email as well as proactive support team engagement.

  • The EmbedderEmbedder A company or developer that integrates Weavr's embedded finance services into their own application to provide financial services to their end customers. has the primary responsibility to communicate with End Customers and their representatives/stakeholders in advance of PoI expiry and in the event of documents having expired. EmbeddersEmbedder A company or developer that integrates Weavr's embedded finance services into their own application to provide financial services to their end customers.' systems should provide one or more advance warnings to the relevant end customer contacts.

  • Weavr will now sendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. webhooks to the EmbedderEmbedder A company or developer that integrates Weavr's embedded finance services into their own application to provide financial services to their end customers.’s endpoint for every soon-to-expire PoI 30 days before expiry, 10 days before, and on the day of expiry. In addition a final warning is sent 10 days after the day of expiry. EmbeddersEmbedder A company or developer that integrates Weavr's embedded finance services into their own application to provide financial services to their end customers. should use these webhooks to construct the relevant notifications for End Customer stakeholders.

  • In addition to the above webhooks, Weavr will sendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. emails directly to the affected Root UserRoot user The individual who creates the identity. For corporate identities, the root user needs to be a legal representative of the corporate such as a director or a representative who has the power of attorney over the company. For consumer identities, the root user is the owner of the identity. Every identity must always have one root user. (or non-director Root UserRoot user The individual who creates the identity. For corporate identities, the root user needs to be a legal representative of the corporate such as a director or a representative who has the power of attorney over the company. For consumer identities, the root user is the owner of the identity. Every identity must always have one root user. plus director appointing them). The email content is as follows and can be customised by the EmbedderEmbedder A company or developer that integrates Weavr's embedded finance services into their own application to provide financial services to their end customers. for their programme, on request via support ticket:

WEB

  • The above email will be sent 30/10/0 days before as well as 10 days after the ID document expiry date.

  • The 30/10 days before and 10 days after expiry timeframes are configurable per EmbedderEmbedder A company or developer that integrates Weavr's embedded finance services into their own application to provide financial services to their end customers. programme: contact Weavr if you wish to make changes in this regard.

  • Note that any accounts currently affected by having one or more PoI documents already expired at the go-live date of this release, will already be subject to compliance case management with EmbedderEmbedder A company or developer that integrates Weavr's embedded finance services into their own application to provide financial services to their end customers. support teams. Any soon-to-expire cases after the go-live date will begin receiving reminders immediately.

Read the full article on Proof of ID expiry to find out more (this requires logging in to the Weavr support portal).

SendsSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. and OWTsOWT Outgoing Wire Transfer - a transaction that moves funds from a Weavr managed account to a bank account held at a third-party financial institution. OWTs require the managed account to have an assigned IBAN and the user to complete Strong Customer Authentication. as bulk operationsBulk Operations The capability of grouping multiple individual API-based actions into a batch. Bulk operations allow you to execute hundreds or thousands of operations by making only one or two API calls, increasing throughput, accomplishing actions in a secure session, and reducing complexity in your application.​

As announced in the last Release Note, we have introduced a capability to group multiple individual API-based actions into a batch of bulk operationsBulk Operations The capability of grouping multiple individual API-based actions into a batch. Bulk operations allow you to execute hundreds or thousands of operations by making only one or two API calls, increasing throughput, accomplishing actions in a secure session, and reducing complexity in your application.; that are then executed and managed through the Bulk ProcessBulk Process A task created when initiating a group of bulk operations. The Bulk Process has a consistent lifecycle (statuses) and management method, regardless of the type of operation being performed. It can be in states such as SUBMITTED, RUNNING, PAUSED, CANCELLED, or completed states.. This new feature is available to try out, on request (via support ticket or your account manager).

We have now added the following actions as bulk operationsBulk Operations The capability of grouping multiple individual API-based actions into a batch. Bulk operations allow you to execute hundreds or thousands of operations by making only one or two API calls, increasing throughput, accomplishing actions in a secure session, and reducing complexity in your application. endpoints:

  • POST bulks/sends - Create SendsSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. in bulk.

  • POST bulks/outgoing_wire_transfers - Create OWTsOWT Outgoing Wire Transfer - a transaction that moves funds from a Weavr managed account to a bank account held at a third-party financial institution. OWTs require the managed account to have an assigned IBAN and the user to complete Strong Customer Authentication. in bulk.

To complete these operations, a transaction confirmation challenge must also be completed, and so we have updated our Bulk ProcessBulk Process A task created when initiating a group of bulk operations. The Bulk Process has a consistent lifecycle (statuses) and management method, regardless of the type of operation being performed. It can be in states such as SUBMITTED, RUNNING, PAUSED, CANCELLED, or completed states. documentation to describe this.

The previous endpoints that specifically served bulk SendsSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. and bulk OWTsOWT Outgoing Wire Transfer - a transaction that moves funds from a Weavr managed account to a bank account held at a third-party financial institution. OWTs require the managed account to have an assigned IBAN and the user to complete Strong Customer Authentication. will be marked as deprecated, since these operations can now be managed as part of the standardised Bulk ProcessBulk Process A task created when initiating a group of bulk operations. The Bulk Process has a consistent lifecycle (statuses) and management method, regardless of the type of operation being performed. It can be in states such as SUBMITTED, RUNNING, PAUSED, CANCELLED, or completed states..

Cancel OWTsOWT Outgoing Wire Transfer - a transaction that moves funds from a Weavr managed account to a bank account held at a third-party financial institution. OWTs require the managed account to have an assigned IBAN and the user to complete Strong Customer Authentication. in state PENDING_CHALLENGE​

Previously, an Outgoing Wire TransferWire Transfer A transaction that moves funds between accounts. An incoming wire transfer moves funds from a third-party bank account to a Weavr managed account, while an outgoing wire transfer moves funds from a Weavr managed account to a third-party bank account. Wire transfers require the managed account to have an assigned IBAN (for EUR) or sort code and account number (for GBP). (OWTOWT Outgoing Wire Transfer - a transaction that moves funds from a Weavr managed account to a bank account held at a third-party financial institution. OWTs require the managed account to have an assigned IBAN and the user to complete Strong Customer Authentication.) could be cancelled only if it was a scheduled (i.e. future-dated) transaction, at any time before the execution time. This is done by selecting the scheduled OWTOWT Outgoing Wire Transfer - a transaction that moves funds from a Weavr managed account to a bank account held at a third-party financial institution. OWTs require the managed account to have an assigned IBAN and the user to complete Strong Customer Authentication. transaction ID and cancelling it, optionally adding a cancellation reason.

With the updated POST /outgoing_wire_transfers/bulk/cancel endpoint, an OWTOWT Outgoing Wire Transfer - a transaction that moves funds from a Weavr managed account to a bank account held at a third-party financial institution. OWTs require the managed account to have an assigned IBAN and the user to complete Strong Customer Authentication. can be cancelled while it is still in the state PENDING_CHALLENGE, i.e. before the completion of the SCASCA Strong Customer Authentication - a two-factor authentication solution required by PSD2 regulations for when end-users are accessing their payment account sensitive information or initiating transactions. SCA requires at least two of the following: something you know (password), something you have (device), or something you are (biometrics). challenge.

A single OWTOWT Outgoing Wire Transfer - a transaction that moves funds from a Weavr managed account to a bank account held at a third-party financial institution. OWTs require the managed account to have an assigned IBAN and the user to complete Strong Customer Authentication. or batch of OWTsOWT Outgoing Wire Transfer - a transaction that moves funds from a Weavr managed account to a bank account held at a third-party financial institution. OWTs require the managed account to have an assigned IBAN and the user to complete Strong Customer Authentication. can be cancelled in this way.

Therefore, EmbeddersEmbedder A company or developer that integrates Weavr's embedded finance services into their own application to provide financial services to their end customers. can now add functionality to their OWTOWT Outgoing Wire Transfer - a transaction that moves funds from a Weavr managed account to a bank account held at a third-party financial institution. OWTs require the managed account to have an assigned IBAN and the user to complete Strong Customer Authentication. UX flow to offer account holders the ability to cancel an OWTOWT Outgoing Wire Transfer - a transaction that moves funds from a Weavr managed account to a bank account held at a third-party financial institution. OWTs require the managed account to have an assigned IBAN and the user to complete Strong Customer Authentication. at this stage, e.g. to go back, change details of the OWTOWT Outgoing Wire Transfer - a transaction that moves funds from a Weavr managed account to a bank account held at a third-party financial institution. OWTs require the managed account to have an assigned IBAN and the user to complete Strong Customer Authentication., and start again.

Shared fees for SendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. transactions​

Currently, it is possible to configure and test various transaction fees in the Embedder PortalEmbedder Portal A web-based portal where embedders can access their Weavr account, manage API credentials, configure settings, view dashboards, and access documentation. The portal provides access to both sandbox and production environments, with separate credentials for each. within the Sandbox environment. These fees are subject to checks and approval before they are applied in a live programme.

With this release we are adding a new fee mechanism for SendsSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. (i.e. e-money payments between two different Identities' Managed AccountsManaged Account An account held at a financial institution that can be created and managed through the Weavr platform. Each account has a balance where customers can hold funds. Optionally, an IBAN can be assigned to enable wire transfers to bank accounts outside of Weavr. under the same programme). Instead of a fee for a SendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. only being charged to the sender (the source account), some or all of the fee can now be shifted to the recipient (destination account).

New configuration is available in the Sandbox Portal to set up this kind of split/shared fees on SendsSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary.:

  • Charge full fee to the source account,
  • Charge full fee to the destination account, or
  • Split fee between the source and the destination account: with the split being 50/50, or any percentage weighting you chose.

WEB

Fees that have been charged to End Customers in this way will be shown in their statements and transaction history - now, for both source and destination accounts.

Fees on SendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. transactions are specified on a SendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. Profile. The SendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. Profile is specified in the API call to initiate the transaction: therefore it is possible to have different SendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. Profiles for different fee approaches, and select the right one at the time of a transaction.

EmbeddersEmbedder A company or developer that integrates Weavr's embedded finance services into their own application to provide financial services to their end customers. wishing to apply fee changes to a live programme should raise a change request via a support ticket.

Updating card spend rules as a bulk operation​

As announced in the last Release Note, one of the bulk operationsBulk Operations The capability of grouping multiple individual API-based actions into a batch. Bulk operations allow you to execute hundreds or thousands of operations by making only one or two API calls, increasing throughput, accomplishing actions in a secure session, and reducing complexity in your application. to be included in the launch of the Bulk ProcessBulk Process A task created when initiating a group of bulk operations. The Bulk Process has a consistent lifecycle (statuses) and management method, regardless of the type of operation being performed. It can be in states such as SUBMITTED, RUNNING, PAUSED, CANCELLED, or completed states. was the ability to bulk update spend rules across Managed CardsManaged Card A payment card (virtual or physical) that can be created and managed through the Weavr platform. Cards can operate in prepaid mode (with their own balance) or debit mode (linked to a managed account). All cards must be assigned to a card assignee who is an Authorised User..

The Bulk ProcessBulk Process A task created when initiating a group of bulk operations. The Bulk Process has a consistent lifecycle (statuses) and management method, regardless of the type of operation being performed. It can be in states such as SUBMITTED, RUNNING, PAUSED, CANCELLED, or completed states., and specifically the ability to bulk update spend rules across Managed CardsManaged Card A payment card (virtual or physical) that can be created and managed through the Weavr platform. Cards can operate in prepaid mode (with their own balance) or debit mode (linked to a managed account). All cards must be assigned to a card assignee who is an Authorised User., is now also available in the Back Office API.

The endpoint introduced is POST bulks/managed_cards/_id_/spend_rules.

Contact Weavr support for guidance in testing out the new bulk operationsBulk Operations The capability of grouping multiple individual API-based actions into a batch. Bulk operations allow you to execute hundreds or thousands of operations by making only one or two API calls, increasing throughput, accomplishing actions in a secure session, and reducing complexity in your application. features during this Beta phase.

Creation and delivery details for physical cardsPhysical Card A payment card that is printed or embedded in wearables and sent to customers directly. Physical cards are created by first creating a virtual card and then upgrading it to a physical card. They are sent in an inactive state and must be activated by the card assignee before first use. in Embedder PortalEmbedder Portal A web-based portal where embedders can access their Weavr account, manage API credentials, configure settings, view dashboards, and access documentation. The portal provides access to both sandbox and production environments, with separate credentials for each.​

We have improved the Managed CardsManaged Card A payment card (virtual or physical) that can be created and managed through the Weavr platform. Cards can operate in prepaid mode (with their own balance) or debit mode (linked to a managed account). All cards must be assigned to a card assignee who is an Authorised User. detailed view in the Embedder PortalEmbedder Portal A web-based portal where embedders can access their Weavr account, manage API credentials, configure settings, view dashboards, and access documentation. The portal provides access to both sandbox and production environments, with separate credentials for each. for programme administrators and support teams. This update provides more details about physical payment cards, which are set up by first creating a virtual cardVirtual Card A payment card that is created instantly and can be used for e-commerce and online purchases. Virtual cards are issued through the Mastercard network and are automatically enrolled in the 3D Secure program for increased security and limited fraud risk. They can be created in prepaid or debit mode. and then upgrading to physical:

  • A timestamp indicating when the Managed CardManaged Card A payment card (virtual or physical) that can be created and managed through the Weavr platform. Cards can operate in prepaid mode (with their own balance) or debit mode (linked to a managed account). All cards must be assigned to a card assignee who is an Authorised User. was upgraded to a physical cardPhysical Card A payment card that is printed or embedded in wearables and sent to customers directly. Physical cards are created by first creating a virtual card and then upgrading it to a physical card. They are sent in an inactive state and must be activated by the card assignee before first use.,
  • The manufacturing state of the card, and
  • Delivery tracking details, if available.

WEB

The manufacturing states of a Card can be:

  • REQUESTED: The upgrade of the card to physical has been requested.
  • SENT_FOR_FULFILLMENT: The card has been sent for printing.
  • DISPATCHED: The card has been manufactured and dispatched.
  • DELIVERED: The card has been received and activated by the recipient.

Delivery tracking details are added when the manufacturing state is either DISPATCHED or DELIVERED.

Reminder: A Managed CardManaged Card A payment card (virtual or physical) that can be created and managed through the Weavr platform. Cards can operate in prepaid mode (with their own balance) or debit mode (linked to a managed account). All cards must be assigned to a card assignee who is an Authorised User. can be upgraded to a physical cardPhysical Card A payment card that is printed or embedded in wearables and sent to customers directly. Physical cards are created by first creating a virtual card and then upgrading it to a physical card. They are sent in an inactive state and must be activated by the card assignee before first use. by calling the MultiMulti Weavr Multi is an embedded finance solution that allows you to integrate financial services into your own application, providing a seamless experience for your customers. It enables you to offer managed accounts, managed cards, and transactions without requiring financial expertise. API endpoint POST /managed_cards/{id}/physical. For more information on setting up physical cards, refer to our API guides.

Indication of which API key is used for webhook signing​

In previous release notes we noted how we are strengthening the mechanism of signing webhooks. Webhooks are signed using the Primary API Key of a programme. This key is now highlighted in the API Credentials list in the Embedder PortalEmbedder Portal A web-based portal where embedders can access their Weavr account, manage API credentials, configure settings, view dashboards, and access documentation. The portal provides access to both sandbox and production environments, with separate credentials for each.:

WEB

The key marked as Primary is the one that has been active for longest. This applies to both Sandbox and live applications.

We recommend all EmbeddersEmbedder A company or developer that integrates Weavr's embedded finance services into their own application to provide financial services to their end customers. move over to the new webhook signing / validation mechanism as soon as convenient.

Additional endpoints now supporting idempotency​

As mentioned in previous Release Notes, we are extending the list of endpoints in the MultiMulti Weavr Multi is an embedded finance solution that allows you to integrate financial services into your own application, providing a seamless experience for your customers. It enables you to offer managed accounts, managed cards, and transactions without requiring financial expertise. API which can be called idempotently. This can be achieved by including the idempotency-ref header in the requests.

WEB

In this release, the following MultiMulti Weavr Multi is an embedded finance solution that allows you to integrate financial services into your own application, providing a seamless experience for your customers. It enables you to offer managed accounts, managed cards, and transactions without requiring financial expertise. API endpoints can (optionally) be called idempotently:

  • POST/corporates to create a Corporate Identity

  • POST /consumers to create an Consumer Identity

  • POST /multi/users/invite to sendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. a user invite

  • POST users/{user_id}/invite/consume to consume an invitation previously sent to the user

  • PATCH /users/{user_id} to update details of a User

  • POST users/verification/email/send to sendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary. an email verification code to an Authorised User

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

SSO for Embedder PortalEmbedder Portal A web-based portal where embedders can access their Weavr account, manage API credentials, configure settings, view dashboards, and access documentation. The portal provides access to both sandbox and production environments, with separate credentials for each.​

We are now offering Single Sign-On (SSO) for the Embedder PortalEmbedder Portal A web-based portal where embedders can access their Weavr account, manage API credentials, configure settings, view dashboards, and access documentation. The portal provides access to both sandbox and production environments, with separate credentials for each. on a Beta basis. Users will be able to log in to the portal using their company-provided authentication e.g. Google Workspace or Microsoft account.

This provides enhanced security and convenience for controlling access and adding/removing users from your organisation to work with the portal.

If you would like to participate in this Beta, contact Weavr (via support ticket or your account manager).

Partner Notice​

Security reminder from Twilio Authy​

Note that Twilio has recently announced an important update for Authy.

If your programme uses Authy for SCASCA Strong Customer Authentication - a two-factor authentication solution required by PSD2 regulations for when end-users are accessing their payment account sensitive information or initiating transactions. SCA requires at least two of the following: something you know (password), something you have (device), or something you are (biometrics). or other 2FA help communicate this to your end users with a reminder to update their app as soon as possible.