Weavr
Powered by Redocly

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.

Add a linked account

A Linked Account is an entity in the Weavr system that represents an external bank account or PSP account which the Identity has verified that they own and control. This feature enables users to perform transactions, such as outgoing and incoming wire transfers, between their Linked Accounts and their Managed Accounts in a way that can be recorded as a self-to-self transfer.

Securityauth_token and api_key
Request
header Parameters
idempotency-ref
string

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.

Request Body schema: application/json
required
profileId
string (LinkedAccountProfileId) ^[0-9]+$

The id of the Linked Account Profile which this instrument is linked to.

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

This field is necessary only if you have been provided with multiple Linked Account Profiles.

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

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

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

name
required
string [ 1 .. 100 ] characters

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.

type
required
string (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"
required
Iban (object) or AccountNumberAndSortCode (object)

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

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

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

friendlyName
string <= 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.

Currency (string)
Responses
200

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

409

Conflict

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/linked_accounts
Request samples
application/json
{
  • "profileId": "string",
  • "tag": "string",
  • "name": "string",
  • "type": "BUSINESS",
  • "accountReference": {
    },
  • "country": "st",
  • "friendlyName": "string",
  • "currency": "str"
}
Response samples
application/json
{
  • "id": "string",
  • "profileId": "string",
  • "tag": "string",
  • "friendlyName": "string",
  • "name": "string",
  • "type": "BUSINESS",
  • "currency": "str",
  • "country": "st",
  • "accountReference": {
    },
  • "state": "PENDING_VERIFICATION",
  • "creationTimestamp": 0
}

Get all linked accounts

Retrieves all the Linked Accounts belonging to the logged-in Identity.

Securityauth_token and api_key
Request
query Parameters
offset
integer <int32> >= 0

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

limit
integer <int32> [ 1 .. 100 ]

The limit of the results for paging, starting at the offset. Limit is always capped at 100.

profileId
string (ProfileId) ^[0-9]+$

Filter by the managed account/card profile. Leave out to fetch all managed accounts/card.

friendlyName
string [ 1 .. 50 ] characters

Filter by the managed account/card friendly name. Leave out to fetch all managed accounts/card.

The exact name must be provided, as wildcards are not supported.

state
Array of strings (InstrumentState) unique
Items Enum: "ACTIVE" "BLOCKED" "DESTROYED"
currency
string (Currency) = 3 characters ^[A-Z]*$

Filter by the managed account/card currency.

Currencies are expressed as an ISO 4217 code. Leave out to fetch all managed accounts/card.

createdFrom
integer <int64>

Filter for managed accounts/cards created after createdFrom timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all managed accounts/cards.

createdTo
integer <int64>

Filter for managed accounts/cards created before createdTo timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all managed accounts/cards.

tag
string

Filter by the managed account/card tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all managed accounts/card.

Responses
200

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

get/linked_accounts
Request samples 
Response samples 
application/json
{
  • "accounts": [
    ],
  • "count": 0,
  • "responseCount": 0
}
Get a linked account
Fetch the Linked Account identified by the id in path.


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the Linked Account.


 
Responses 
200
Success


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


404
Not found - The requested resource couldn't be found.


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


get/linked_accounts/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "profileId": "string",
  • "tag": "string",
  • "friendlyName": "string",
  • "name": "string",
  • "type": "BUSINESS",
  • "currency": "str",
  • "country": "st",
  • "accountReference": {
    },
  • "state": "PENDING_VERIFICATION",
  • "creationTimestamp": 0
}
Update a linked account
Update the details for the linked account identified by the id in the path.


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the linked account.


 
Request Body schema: application/json
required
tag
string (Tag)   <= 50 characters ^[a-zA-Z0-9_-]+$
The tag field is a custom field that can be used to search and filter.


 
friendlyName
string  [ 1 .. 50 ] characters 
Updates the friendly name of the linked account. Leave blank if no change is needed.


 
Responses 
200
Success


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


404
Not found - The requested resource couldn't be found.


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


patch/linked_accounts/{id}
Request samples 
application/json
{
  • "tag": "string",
  • "friendlyName": "string"
}
Response samples 
application/json
{
  • "id": "string",
  • "profileId": "string",
  • "tag": "string",
  • "friendlyName": "string",
  • "name": "string",
  • "type": "BUSINESS",
  • "currency": "str",
  • "country": "st",
  • "accountReference": {
    },
  • "state": "PENDING_VERIFICATION",
  • "creationTimestamp": 0
}
Remove a linked account
Removes the linked account identified by the id path parameter. Unlike block, this action is not reversible.


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the linked account.


 
Responses 
204
Success - No Content.


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


404
Not found - The requested resource couldn't be found.


409
Conflict


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/linked_accounts/{id}/remove
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
Block a linked account
Temporarily blocks a linked account.


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the linked account.


 
header Parameters
idempotency-ref
string
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.


 
Responses 
204
Success - No Content.


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


404
Not found - The requested resource couldn't be found.


409
Conflict


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/linked_accounts/{id}/block
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
Unblock a linked account
Unblocks the linked account identified by the id path parameter.


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the linked account.


 
header Parameters
idempotency-ref
string
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.


 
Responses 
204
Success - No Content.


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


404
Not found - The requested resource couldn't be found.


409
Conflict


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/linked_accounts/{id}/unblock
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
Get linked account verifications
Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the linked account.


 
query Parameters
offset
integer <int32>   >= 0 
The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.


 
limit
integer <int32>   [ 1 .. 100 ] 
The limit of the results for paging, starting at the offset. Limit is always capped at 100.


 
state
Array of strings (LinkedAccountVerificationRunState)   unique 
Items Enum: "PENDING" "VERIFIED" "REJECTED"  
Responses 
200
Success


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


get/linked_accounts/{id}/verifications
Request samples 
Response samples 
application/json
{
  • "verificationRuns": [
    ],
  • "count": 0,
  • "responseCount": 0
}
➔ Next to Sends