Skip to content
/
Upgrade a managed 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

Update a managed account

Request

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

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

The unique identifier of the managed 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 managed account. Leave blank if no change is needed.

curl -i -X PATCH \
  'https://api.weavr.io/_mock/products/multi/openapi/managed_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 a Managed 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 ] charactersrequired

The friendly name given to the managed account.

currencystring(Currency)= 3 characters^[A-Z]*$required

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

balancesobject(ManagedInstrumentBalance)required

Instruments with funds have 2 balances, the availableBalance indicating the funds that are available for transactions such as purchases, and the actualBalance indicating the funds that are actually on the instrument.

balances.​availableBalanceinteger(int64)

The funds available for transactions on the instrument. Funds that are blocked or pending are not included in the available balance.

balances.​actualBalanceinteger(int64)

The funds that are actually on the instrument. Funds that are blocked or pending, due to for example, a purchase authorisation or a pending deposit, are included in the actual balance.

stateobject(ManagedInstrumentState)required
state.​statestring(InstrumentState)required

The state of the instrument indicating what it can and cannot do as follows:

  • ACTIVE: The instrument is in an active state and can be used in transactions.
  • BLOCKED: The instrument is temporarily blocked and cannot be used. Any funds on the instrument are also frozen. The blockedReason provides more information as to why it was blocked.
  • DESTROYED: The instrument has been permanently destroyed. The destroyReason provides more information as to why it was destroyed.
Enum"ACTIVE""BLOCKED""DESTROYED"
state.​blockedReasonstring(BlockedReason)

The reason why the instrument has been blocked:

  • USER: The root, or an authorised user, of the identity owning the instrument has temporarily blocked the instrument.
  • SYSTEM: The platform or an administrator of the platform has temporarily blocked the instrument.
  • LOST: The instrument has been blocked because it was marked as lost.
Enum"USER""SYSTEM""LOST"
state.​destroyedReasonstring(DestroyedReason)

The reason why the instrument has been destroyed:

  • SYSTEM: The platform or an administrator of the platform has destroyed the instrument.
  • USER: The root, or an authorised user, of the identity owning the instrument has destroyed the instrument.
  • LOST: The instrument was automatically destroyed as it was marked as lost.
  • STOLEN: The instrument was automatically destroyed as it was marked as stolen.
  • EXPIRED: The instrument was automatically destroyed as it expired.
  • COMPROMISED: The instrument was automatically destroyed as it was marked as compromised.
Enum"SYSTEM""USER""LOST""STOLEN""EXPIRED""COMPROMISED"
creationTimestampinteger(int64)required

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

Response
application/json
{
  "id": "string",
  "profileId": "string",
  "tag": "string",
  "friendlyName": "string",
  "currency": "str",
  "balances": {
    "availableBalance": 0,
    "actualBalance": 0
  },
  "state": {
    "state": "ACTIVE",
    "blockedReason": "USER",
    "destroyedReason": "SYSTEM"
  },
  "creationTimestamp": 0
}

Upgrade a managed account with IBAN

Request

Assign an IBAN to a Managed Account.

IBANs enable managed accounts to receive and send funds via wire transfers.

Assigning an IBAN to a Managed Account may be done asynchronously, in which case the ManagedAccountIBAN.state will be set to PENDING_ALLOCATION until bank details are ready to use.

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

The unique identifier of the Managed Account.

Headers
idempotency-refstring

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

curl -i -X POST \
  'https://api.weavr.io/_mock/products/multi/openapi/managed_accounts/{id}/iban' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: 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
statestringrequired

The state of the Managed Account's IBAN as follows:

  • UNALLOCATED: The Managed Account has never been assigned an IBAN. Use the managedAccountsIBANUpgrade operation to assign an IBAN to a Managed Account.
  • PENDING_ALLOCATION: The IBAN is being allocated to the Managed Account.
  • ALLOCATED: An IBAN is allocated to the Managed Account.
Enum"UNALLOCATED""PENDING_ALLOCATION""ALLOCATED"
bankAccountDetailsArray of objectsrequired

A list of bank account details associated with the IBAN. Multiple details can be provided if multiple IBAN providers are supported by your payment model.

bankAccountDetails[].​beneficiaryNameAndSurnamestringrequired

The beneficiary name and surname details to be used when initiating a deposit onto the IBAN.

bankAccountDetails[].​beneficiaryBankstringrequired

The beneficiary bank name to be used when initiating a deposit onto the IBAN.

bankAccountDetails[].​beneficiaryBankAddressstringrequired

The beneficiary bank address to be used when initiating a deposit onto the IBAN.

bankAccountDetails[].​paymentReferencestring

A reference required by the partner bank to execute a deposit on the managed account.

If provided, make sure that this is included as part of the wire transfer details when initiating a deposit.

bankAccountDetails[].​detailsIBANDetails (object) or FasterPaymentsBankDetailsOrBACSBankDetails (object) or SwiftBankDetails (object)required

The bank details required to initiate a deposit on the managed account.

The details required to deposit on the IBAN vary depending on the wire transfer channel that will be used.

Any of:

Bank details used in case the wire transfer is executed over SEPA or RIX

bankAccountDetails[].​details.​ibanstring[ 15 .. 34 ] characters^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$required

International Bank Account Number, required for wire transfer over SEPA or RIX

bankAccountDetails[].​details.​bankIdentifierCodestring[ 8 .. 11 ] characters^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA...

BIC, for wire transfer over SEPA or RIX

Response
application/json
{
  "state": "UNALLOCATED",
  "bankAccountDetails": [
    { … }
  ]
}

Get a managed account IBAN

Request

Fetch the IBAN details associated with the Managed Account identified by the id in the path.

Security
auth_token and api-key
Path
idstring^[0-9]+$required
curl -i -X GET \
  'https://api.weavr.io/_mock/products/multi/openapi/managed_accounts/{id}/iban' \
  -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
statestringrequired

The state of the Managed Account's IBAN as follows:

  • UNALLOCATED: The Managed Account has never been assigned an IBAN. Use the managedAccountsIBANUpgrade operation to assign an IBAN to a Managed Account.
  • PENDING_ALLOCATION: The IBAN is being allocated to the Managed Account.
  • ALLOCATED: An IBAN is allocated to the Managed Account.
Enum"UNALLOCATED""PENDING_ALLOCATION""ALLOCATED"
bankAccountDetailsArray of objectsrequired

A list of bank account details associated with the IBAN. Multiple details can be provided if multiple IBAN providers are supported by your payment model.

bankAccountDetails[].​beneficiaryNameAndSurnamestringrequired

The beneficiary name and surname details to be used when initiating a deposit onto the IBAN.

bankAccountDetails[].​beneficiaryBankstringrequired

The beneficiary bank name to be used when initiating a deposit onto the IBAN.

bankAccountDetails[].​beneficiaryBankAddressstringrequired

The beneficiary bank address to be used when initiating a deposit onto the IBAN.

bankAccountDetails[].​paymentReferencestring

A reference required by the partner bank to execute a deposit on the managed account.

If provided, make sure that this is included as part of the wire transfer details when initiating a deposit.

bankAccountDetails[].​detailsIBANDetails (object) or FasterPaymentsBankDetailsOrBACSBankDetails (object) or SwiftBankDetails (object)required

The bank details required to initiate a deposit on the managed account.

The details required to deposit on the IBAN vary depending on the wire transfer channel that will be used.

Any of:

Bank details used in case the wire transfer is executed over SEPA or RIX

bankAccountDetails[].​details.​ibanstring[ 15 .. 34 ] characters^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$required

International Bank Account Number, required for wire transfer over SEPA or RIX

bankAccountDetails[].​details.​bankIdentifierCodestring[ 8 .. 11 ] characters^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA...

BIC, for wire transfer over SEPA or RIX

Response
application/json
{
  "state": "UNALLOCATED",
  "bankAccountDetails": [
    { … }
  ]
}

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

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