Skip to content
/
Update a linked account

Weavr Multi Product API (3.63.5)

Weavr Multi API provides a simple and flexible way to issue cards and accounts to your customers.

By integrating Weavr Multi API in your application you can embed banking capabilities within your app and provide a seamless experience for your customers.

Authentication

Each request to the Multi API must include an api-key that represents your account. You can obtain an API Key by registering for a Multi account here.

Almost all endpoints require a secondary authentication token auth_token that represents the user for whom the request is being executed.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://weavr.io
Languages
Servers
Mock server
https://api.weavr.io/_mock/products/multi/openapi
Weavr Sandbox Environment
https://sandbox.weavr.io/multi

Access

Manage authentication for your users.

Operations

Passwords

Manage your users' passwords.

Operations

Authentication Factors

Operations

Step-up Challenges

Operations

Confirmation Challenges

Operations

Corporates

Corporates are identities representing companies. Once on-boarded, Corporates can create and manage their own instruments via your application.

Operations

Consumers

Consumers are identities representing individuals. Once on-boarded, Consumers can create and manage their own instruments via your application.

Operations

Authorised Users

Corporate and Consumer identities can invite authorised users to access their account. Once on-boarded, authorised users can create and manage instruments and transactions on behalf of the identity they are on-boarded with.

In case of Corporate Identities, authorised users are typically employees who have access to company's banking products such as cards and bank accounts.

In case of Consumer Identities, authorised users are typically children/teens whose parents want them to have access to banking products such as cards and bank accounts.

Note that the /users GET endpoints return all users including root users. However, modification operations (create, update, activate, deactivate) on /users endpoints only apply to authorised users. To modify root user details, use the respective /consumers or /corporates endpoints.

Operations

Beneficiaries

Operations

Managed Accounts

Managed Accounts are a type of financial instrument offered by Weavr.

They hold funds for their owner, and can be upgraded to IBANs so as to receive and send funds to instruments outside of the Weavr Platform, via Wire Transfers.

Managed accounts can also be used as source and destination instruments in the transfer and send transactions.

Operations

Managed Cards

Managed Cards are a type of financial instrument offered by Weavr.

You can create virtual or physical cards that are issued to the consumer or corporate identity.

A card created in prepaid mode has its own balance, whereas a card created in debit mode does not have its own balance but taps into the balance of its parent managed account.

Operations

Linked Accounts

Linked Accounts are external bank accounts that users connect to their profiles within the Weavr Platform.

These accounts allow users to link their existing bank accounts, held at external financial institutions, to the Weavr Platform, enabling secure and efficient transfer of funds between their own accounts.

Linked Accounts are designed to streamline the process of moving money between a user’s various bank accounts, providing a convenient and integrated way to manage personal finances across different financial institutions.

Operations

Get a linked account

Request

Fetch the Linked Account identified by the id in path.

Security
auth_token and api-key
Path
idstring^[0-9]+$required

The unique identifier of the Linked Account.

curl -i -X GET \
  'https://api.weavr.io/_mock/products/multi/openapi/linked_accounts/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
idstring^[0-9]+$required

The unique identifier of the linked account.

profileIdstring(ProfileId)^[0-9]+$required

The profile Id which a specific identity, instrument or transaction type is linked to.

Profiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.

You can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

tagstring(Tag)<= 50 characters^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

friendlyNamestring[ 1 .. 50 ] characters

A user-friendly label assigned to the Linked Account to help end-users easily identify it within the application. This name can be updated at any time using the PATCH endpoint

namestring[ 1 .. 100 ] charactersrequired

The full name or corporate name of the account holder as registered with the external bank or payment service provider. This is the name under which the account is officially held.

typestring(AccountType)

An account can be of two types, Personal or Business:

  • PERSONAL means that the account held at the external bank or PSP is registered under the ownership of a natural person or consumer identity;
  • BUSINESS means that the account held at the external bank or PSP is registered under the ownership of a corporate entity.
Enum"BUSINESS""PERSONAL"
currencystring(Currency)= 3 characters^[A-Z]*$

The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.

countrystring= 2 characters^[A-Z]+$required

The country of the bank or institution at which the account is held.

accountReferenceAccountNumberAndSortCode (object) or Iban (object) or AccountDescriptor (object)

The IBAN or Account Number and Sort Code of the account held at the external bank or payment service provider.

One of:

Bank details

statestring(LinkedAccountState)required

The state of the linked account:

  • PENDING_VERIFICATION: The Linked Account is pending the completion of the required verification steps.
  • ACTIVE: The Linked Account is verified and active, ready to be used for self-to-self wire transfers.
  • BLOCKED: The Linked Account is temporarily blocked, preventing any use of this external account in self-to-self wire transfers. A Linked Account can be unblocked by calling the Multi API endpoint POST /linked_accounts/{id}/unblock.
  • REMOVED: The Linked Account has been removed from the platform and can no longer be used for self-to-self wire transfers unless a new verification is completed in future.
  • REJECTED: The Linked Account failed the verification process and cannot be used for self-to-self wire transfers unless a new verification is completed in future. A Linked Account can transition through these different overall states, starting at the PENDING_VERIFICATION state until all verification steps are followed through.
Enum"PENDING_VERIFICATION""BLOCKED""ACTIVE""REJECTED""REMOVED"
creationTimestampinteger(int64)

The timestamp when the linked account was created, expressed in Epoch timestamp using millisecond precision.

ownerobject(StringWrappedTypeId)
Response
application/json
{
  "id": "string",
  "profileId": "string",
  "tag": "string",
  "friendlyName": "string",
  "name": "string",
  "type": "BUSINESS",
  "currency": "str",
  "country": "st",
  "accountReference": {
    "accountNumber": "string",
    "sortCode": "string",
    "secondaryReference": "string"
  },
  "state": "PENDING_VERIFICATION",
  "creationTimestamp": 0,
  "owner": {
    "type": "string",
    "id": "string"
  }
}

Update a linked account

Request

Update the details for the linked account identified by the id in the path.

Security
auth_token and api-key
Path
idstring^[0-9]+$required

The unique identifier of the linked account.

Bodyapplication/jsonrequired
tagstring(Tag)<= 50 characters^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

friendlyNamestring[ 1 .. 50 ] characters

Updates the friendly name of the linked account. Leave blank if no change is needed.

curl -i -X PATCH \
  'https://api.weavr.io/_mock/products/multi/openapi/linked_accounts/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "tag": "string",
    "friendlyName": "string"
  }'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
idstring^[0-9]+$required

The unique identifier of the linked account.

profileIdstring(ProfileId)^[0-9]+$required

The profile Id which a specific identity, instrument or transaction type is linked to.

Profiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.

You can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

tagstring(Tag)<= 50 characters^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

friendlyNamestring[ 1 .. 50 ] characters

A user-friendly label assigned to the Linked Account to help end-users easily identify it within the application. This name can be updated at any time using the PATCH endpoint

namestring[ 1 .. 100 ] charactersrequired

The full name or corporate name of the account holder as registered with the external bank or payment service provider. This is the name under which the account is officially held.

typestring(AccountType)

An account can be of two types, Personal or Business:

  • PERSONAL means that the account held at the external bank or PSP is registered under the ownership of a natural person or consumer identity;
  • BUSINESS means that the account held at the external bank or PSP is registered under the ownership of a corporate entity.
Enum"BUSINESS""PERSONAL"
currencystring(Currency)= 3 characters^[A-Z]*$

The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.

countrystring= 2 characters^[A-Z]+$required

The country of the bank or institution at which the account is held.

accountReferenceAccountNumberAndSortCode (object) or Iban (object) or AccountDescriptor (object)

The IBAN or Account Number and Sort Code of the account held at the external bank or payment service provider.

One of:

Bank details

statestring(LinkedAccountState)required

The state of the linked account:

  • PENDING_VERIFICATION: The Linked Account is pending the completion of the required verification steps.
  • ACTIVE: The Linked Account is verified and active, ready to be used for self-to-self wire transfers.
  • BLOCKED: The Linked Account is temporarily blocked, preventing any use of this external account in self-to-self wire transfers. A Linked Account can be unblocked by calling the Multi API endpoint POST /linked_accounts/{id}/unblock.
  • REMOVED: The Linked Account has been removed from the platform and can no longer be used for self-to-self wire transfers unless a new verification is completed in future.
  • REJECTED: The Linked Account failed the verification process and cannot be used for self-to-self wire transfers unless a new verification is completed in future. A Linked Account can transition through these different overall states, starting at the PENDING_VERIFICATION state until all verification steps are followed through.
Enum"PENDING_VERIFICATION""BLOCKED""ACTIVE""REJECTED""REMOVED"
creationTimestampinteger(int64)

The timestamp when the linked account was created, expressed in Epoch timestamp using millisecond precision.

ownerobject(StringWrappedTypeId)
Response
application/json
{
  "id": "string",
  "profileId": "string",
  "tag": "string",
  "friendlyName": "string",
  "name": "string",
  "type": "BUSINESS",
  "currency": "str",
  "country": "st",
  "accountReference": {
    "accountNumber": "string",
    "sortCode": "string",
    "secondaryReference": "string"
  },
  "state": "PENDING_VERIFICATION",
  "creationTimestamp": 0,
  "owner": {
    "type": "string",
    "id": "string"
  }
}

Remove a linked account

Request

Removes the linked account identified by the id path parameter. Unlike block, this action is not reversible.

Security
auth_token and api-key
Path
idstring^[0-9]+$required

The unique identifier of the linked account.

curl -i -X POST \
  'https://api.weavr.io/_mock/products/multi/openapi/linked_accounts/{id}/remove' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success - No Content.

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Response
No content

Sends

The Send transaction is used to send funds between managed accounts and managed cards belonging to different identities.

Operations

Transfers

The Transfer transaction is used to transfer funds between managed accounts and managed cards belonging to same identity.

Operations

Outgoing Wire Transfers

The Outgoing Wire Transfer transaction is used to transfer funds from managed accounts to an external bank account.

Operations

Incoming Wire Transfers

Webhooks

Operations

Operations

Manage

Operations