Weavr
Powered by Redocly

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.

Get all managed accounts

Retrieves all managed 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"
state.blockedReason
Array of strings (BlockedReason) unique
Items Enum: "USER" "SYSTEM" "LOST"
state.destroyedReason
Array of strings (DestroyedReason) unique
Items Enum: "SYSTEM" "USER" "LOST" "STOLEN" "EXPIRED"
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/managed_accounts
Request samples 
Response samples 
application/json
{
  • "accounts": [
    ],
  • "count": 0,
  • "responseCount": 0
}
Create a managed account
Creates a managed account for the consumer or corporate identity.
The Managed Account Profile (configured in the Multi Portal) specified determines the behavior and restrictions that the managed account will have."


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
required
string (ProfileId) ^[0-9]+$
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.


 
friendlyName
required
string  [ 1 .. 50 ] characters 
The friendly name to be given to the managed account.


 
currency
required
string (Currency)   = 3 characters ^[A-Z]*$
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.


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


 
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/managed_accounts
Request samples 
application/json
{
  • "profileId": "string",
  • "friendlyName": "string",
  • "currency": "str",
  • "tag": "string"
}
Response samples 
application/json
{
  • "id": "string",
  • "profileId": "string",
  • "tag": "string",
  • "friendlyName": "string",
  • "currency": "str",
  • "balances": {
    },
  • "state": {
    },
  • "creationTimestamp": 0
}
Get a managed account
Fetch the managed 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 Managed 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/managed_accounts/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "profileId": "string",
  • "tag": "string",
  • "friendlyName": "string",
  • "currency": "str",
  • "balances": {
    },
  • "state": {
    },
  • "creationTimestamp": 0
}
Update a managed account
Update the details for the managed 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 managed 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 managed 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/managed_accounts/{id}
Request samples 
application/json
{
  • "tag": "string",
  • "friendlyName": "string"
}
Response samples 
application/json
{
  • "id": "string",
  • "profileId": "string",
  • "tag": "string",
  • "friendlyName": "string",
  • "currency": "str",
  • "balances": {
    },
  • "state": {
    },
  • "creationTimestamp": 0
}
Upgrade a managed account with IBAN
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.


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the Managed 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 
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.


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/managed_accounts/{id}/iban
Request samples 
Response samples 
application/json
{
  • "state": "UNALLOCATED",
  • "bankAccountDetails": [
    ]
}
Get a managed account IBAN
Fetch the IBAN details associated with the Managed Account identified by the id in the path.


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
 
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/managed_accounts/{id}/iban
Request samples 
Response samples 
application/json
{
  • "state": "UNALLOCATED",
  • "bankAccountDetails": [
    ]
}
Block a managed account
Temporarily blocks a managed account.


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the managed 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/managed_accounts/{id}/block
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
Unblock a managed account
Unblocks the managed account identified by the id path parameter.
The managed account must have state.blockedReason as USER so that it can be unblocked.
If the managed account was blocked by SYSTEM, users cannot unblock it.


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the managed 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/managed_accounts/{id}/unblock
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
Get a managed account statement
Returns a list of transactions against the managed account identified by the id path parameter, matching the criteria provided in the request.


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the managed 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.


 
orderByTimestamp
string
Orders the result in ascending or descending order.


    

  • ASC: Ascending order, oldest transactions first.
    • 

  • DESC: Descending order, most recent transactions first.
    • 



If not specified, the transactions will be returned in descending order.


 Enum: "ASC" "DESC"  
fromTimestamp
integer <int64> 
Filter for transactions having transaction timestamp after fromTimestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all managed accounts.


 
toTimestamp
integer <int64> 
Filter for transactions having transaction timestamp before toTimestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all managed accounts.


 
showFundMovementsOnly
boolean
Returns only the entries which contain fund movements.


 
header Parameters
accept
string
A request parameter specifying the type of response the client would like. Must be one of application/json, application/pdf or text/csv.


The default response type (application/json) will be returned if specified incorrectly or not specified.


 
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/managed_accounts/{id}/statement
Request samples 
Response samples 
{
  • "entry": [
    ],
  • "count": 0,
  • "responseCount": 0,
  • "startBalance": {
    },
  • "endBalance": {
    },
  • "footer": "string"
}
Remove a managed account
Destroys the managed account identified by the id path parameter. Unlike block, this action is not reversible.


A managed account must be emptied from any remaining funds before it can be destroyed.


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the managed 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/managed_accounts/{id}/remove
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
➔ Next to Managed Cards