Weavr Managed Accounts API
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.These accounts can also be used as sources and destinations in the `transfer` transaction.With the `access_token` representing the identity and the consent of the identity, you will be able to operations on the identity's managed accounts, such as getting a managed account's details and retrieving its statement.
Weavr Managed Accounts API is one of 43 APIs that Weavr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Managed Accounts. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 13 operations across 10 paths, and defines 88 schemas. It is described by OpenAPI 3.1.0, at version v3.
Requests are made against a single base URL, https://sandbox.weavr.io/multi/backoffice.
13 operations
10 paths
88 schemas
7 GET1 PATCH5 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Weavr Managed Accounts API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as api-key (api_key).
It accepts HTTP bearer tokens (JWT) (auth_token).
api_key— The API Key representing your Multi account.auth_token— The authentication token representing the user. This will be included in the login response object.
Paths & Operations 13
Across 10 paths, the API surfaces 13 operations — 7 GET, 1 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.
Managed Accounts 13
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…
GET
/managed_accounts/{id}
Get a managed account
PATCH
/managed_accounts/{id}
Update a managed account
GET
/managed_accounts/{id}/statement
Get a managed account statement
GET
/managed_accounts
Get all managed accounts
POST
/managed_accounts
Create a managed account
POST
/managed_accounts/{id}/iban
Upgrade a managed account with IBAN
GET
/managed_accounts/{id}/iban
Get a managed account IBAN
POST
/managed_accounts/{id}/block
Block a managed account
POST
/managed_accounts/{id}/unblock
Unblock a managed account
GET
/deprecated/managed_accounts/{id}/statementdeprecated
Get a managed account statement (deprecated)
GET
/managed_accounts/{id}/transactions
Get transaction activity for a managed account
GET
/managed_accounts/{id}/transactions/{transactionId}
Get a specific transaction for a managed account
POST
/managed_accounts/{id}/remove
Remove a managed account
Schemas 88
The contract defines 88 schemas that model the data the API accepts and returns. The most detailed are OutgoingWireTransfer (18 properties), StatementEntry (16 properties), Send (16 properties), Merchant (16 properties). Each schema is shown below with its type and property counts.
OutgoingWireTransferRejectedInfo
string
Additional info when the outgoing wire transfer has been rejected, as follows: - SYSTEM: The wire transfer was rejected by the system. - USER: The wire transfe…
CardPaymentEventType
string
Type of event recorded against a CardPayment. The reversal flag on each event distinguishes a reversal from the original action.
FasterPaymentsBankDetailsOrBACSBankDetails
object
Bank details used in case the wire transfer is executed over Faster Payments.
3 properties
2 required
CorrespondentBankingOwtState
string
The state of the correspondent bank transfer transaction, as follows: - INVALID: The transfer has failed initial validation checks. - PENDINGCHALLENGE: The tra…
CorrespondentBankingExternalData
object
External data key-value pair.
2 properties
2 required
ExternalAccountId
object
The id of an external account, such as a Linked Account, registered with the Weavr Platform.
2 properties
2 required
UKConfirmationOfPayeeResult
object
3 properties
1 required
CorrespondentBankingIndividualAddressAndBirthInfo
object
Birth information for an individual originator.
2 properties
2 required
Transfer
object
12 properties
7 required
SwiftBankDetails
object
Bank details used in case the wire transfer is executed over SWIFT.
2 properties
2 required
CorrespondentBankingIndividualAddressAndIdInfo
object
Personal identification for an individual originator.
2 properties
2 required
DateOfBirth
string
The date of birth in ISO 8601 format (YYYY-MM-DD).
SEPAVerificationOfPayeeResult
object
2 properties
1 required
FeeSummary
object
4 properties
3 required
Merchant
object
Information about a merchant — used wherever a merchant appears in card-payment flows, statement entries, and transaction activity.
16 properties
2 required
StatementEntry
object
16 properties
4 required
IncomingWireTransfer
object
An incoming wire transfer received from an external bank account.
14 properties
5 required
FasterPaymentsBeneficiary
object
Beneficiary details for Faster Payments wire transfers.
11 properties
4 required
OutgoingWireTransferType
string
The wire transfer rails used, from SEPA, Faster Payments, SWIFT or RIX.
Tag
string
The tag field is a custom field that can be used to search and filter.
CurrencyAmount
object
The object representing a monetary amount in a particular currency.
2 properties
2 required
FeeSubtype
string
The category of fee — indicates the activity or instrument-lifecycle event the fee relates to.
ScaledAmount
object
A floating point number, represented as a value and its scale. Its actual value can be obtained using the equation: value pow(10, -scale).
2 properties
Send
object
16 properties
7 required
BeneficiaryId
object
1 property
1 required
InstrumentState
string
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. -…
BlockedReason
string
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 inst…
InstrumentTransactionActivityItem
object
A transaction activity entry returned by the per-instrument transactions endpoints (e.g. /managedaccounts/{id}/transactions). The instrument is omitted because…
9 properties
5 required
Statement
object
The list of statement entries.
6 properties
ChallengeExemptionReason
string
The Reason the transaction was exempted from SCA verification
CardPaymentEvent
object
An event in a card payment's lifecycle, lean — used nested inside CardPayment.events[]. The parent card payment provides cardPaymentId, card, and merchant, so…
1 property
1 required
InstrumentId
object
2 properties
2 required
ManagedInstrumentState
object
3 properties
1 required
RIXBeneficiary
object
Beneficiary details for RIX wire transfers.
9 properties
2 required
Currency
string
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
ManagedAccountIBAN
object
2 properties
2 required
CorrespondentBankingIndividualOriginator
object
An individual (natural person) originator of the transfer. Travel Rule Requirements: - Mandatory: Full name and account number (via bankAccountDetails) - Manda…
6 properties
4 required
SendState
string
The state of the send transaction, as follows: - INVALID: The send transaction has failed initial validation checks. - INITIALISED: The initial state of a send…
ExecutionTimestamp
string
The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.
ManagedInstrumentBalance
object
Instruments with funds have 2 balances, the availableBalance indicating the funds that are available for transactions such as purchases, and the actualBalance…
2 properties
CardPaymentStatus
string
Lifecycle status of a CardPayment. - SETTLEMENTINPROGRESS — authorised, not yet (or not fully) settled. The hold is still on the card. - SETTLED — fully settle…
TransactionActivityDirection
string
Whether funds were credited to or debited from the instrument.
AccountLowBalanceThreshold
integer
Sends a low balance notification webhook when the available balance drops below this amount. Currency is inherited from the managed account.
ValidationError
array
Is returned as part of an HTTP error response whenever a validation error is detected. A list of the fields together with their syntax error will be provided.
ManagedAccount
object
9 properties
7 required
TransactionState
string
Status of the transaction.
OutgoingWireTransferBeneficiary
object
Details of the beneficiary of the outgoing wire transfer. Deprecated: Use SEPABeneficiary for SEPA/IBAN transfers or FasterPaymentsBeneficiary for Faster Payme…
9 properties
2 required
OutgoingWireTransferValidationOutcome
object
2 properties
2 required
TransactionActivityType
string
The type of transaction: - transfers: Internal transfer between instruments of the same identity - sends: Transfer between instruments of different identities…
Card
object
Information about a managed card — used wherever a card appears (the card on a card payment, or the access instrument that initiated a transaction).
10 properties
2 required
ScheduledTimestamp
string
The epoch timestamp at which the transaction is scheduled to be executed.
TransactionActivitySortBy
string
The field to sort transaction activity results by: - creationTimestamp: Sort by when the transaction was first created (default). - lastUpdatedTimestamp: Sort…
TransactionId
object
2 properties
2 required
DestroyedReason
string
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…
CorrespondentBankingOwt
object
15 properties
9 required
SEPABeneficiary
object
Beneficiary details for SEPA/IBAN wire transfers.
9 properties
2 required
IncomingWireTransferMultiState
string
The state of an incoming wire transfer: - PENDING: The transfer has been received and is being processed. Funds have not yet been credited to the destination a…
ExternalAccountType
string
FeeTransaction
object
A fee charged or reversed on an instrument. Surfaced through GET /fees, GET /transactions (Transaction Activity), and as line items on statements.
9 properties
6 required
StatementEntryState
string
The transaction entry state, as follows: - PENDING: The transaction has started and some of the fund movements have completed, however additional fund movement…
ProfileId
string
The profile Id which a specific identity, instrument or transaction type is linked to. Profiles contain configuration and determine behavioral aspects of the n…
Id
string
CorrespondentBankingSEPABeneficiary
object
CBT-specific beneficiary details for SEPA/IBAN wire transfers with Banking Circle FI-to-FI field limits.
9 properties
3 required
SWIFTBeneficiary
object
Beneficiary details for SWIFT wire transfers.
9 properties
4 required
StatementTransactionType
string
CorrespondentBankingFasterPaymentsBeneficiary
object
CBT-specific beneficiary details for Faster Payments wire transfers with Banking Circle FI-to-FI field limits.
11 properties
5 required
CorrespondentBankingBusinessAddressAndIdInfo
object
Business identification for a business originator.
2 properties
2 required
Nationality
string
Nationality of the user - using ISO 3166 alpha-2.
CorrespondentBankingRIXBeneficiary
object
CBT-specific beneficiary details for RIX wire transfers with Banking Circle FI-to-FI field limits.
9 properties
3 required
UserCurrencyTransactionDetails
object
The object representing the user transaction's currency, amount and rate.
2 properties
2 required
OutgoingWireTransfer
object
18 properties
6 required
TransactionCancellationReason
string
The reason the scheduled transaction was cancelled.
SystemTransaction
object
A system-generated transaction applied to an instrument by the platform (balance adjustments, account closures, dispute outcomes, replacement balance transfers…
9 properties
5 required
SyntaxError
object
Is returned as part of an HTTP error response whenever a syntax error is detected. A list of the fields together with their syntax error will be provided.
1 property
CardPaymentType
string
High-level type of card payment, derived from the first event. - PURCHASE — standard purchase at a merchant. - REFUND — refund from a merchant to the cardholde…
CorrespondentBankingOwtValidationOutcome
object
2 properties
2 required
OutgoingWireTransferState
string
The state of the Outgoing wire transfer transaction, as follows: - INVALID: The wire transfer has failed initial validation checks. - PENDINGCHALLENGE: The wir…
IBANDetails
object
Bank details used in case the wire transfer is executed over SEPA or RIX
2 properties
1 required
FeeTransactionStatus
string
Lifecycle status of a fee transaction: - PENDING: Fee accompanies a transaction that is still processing; it may still be cancelled. - COMPLETED: Fee was charg…
TransactionForex
object
Foreign exchange details when the transaction involved currency conversion.
4 properties
InstrumentTransactionActivityList
object
A paginated list of transaction activity entries scoped to a single instrument.
3 properties
SystemTransactionSubtype
string
The specific kind of system-generated transaction.
CardPayment
object
One card transaction's full lifecycle — authorisation, settlement, refunds — as a single resource that the platform keeps up to date as scheme events arrive. D…
11 properties
8 required
CorrespondentBankingBusinessOriginator
object
A business (legal entity) originator of the transfer. Travel Rule Requirements: - Mandatory: Full legal name and account number (via bankAccountDetails) - Mand…
6 properties
4 required
InstrumentType
string
Error
object
2 properties
CorrespondentBankingBankAccountDetails
object
Bank account details for the originator.
2 properties
2 required
TransactionActivityStatus
string
Normalised lifecycle status of a transaction: - DRAFT: Transaction ID has been created. There are additional user-actions required before the transaction is co…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Weavr 12
Other APIs Weavr publishes across the network.
Weavr Access Token API
Weavr Access Tokens API
Weavr Accounts API
Weavr Additional Factors API
Weavr Authentication Factors API
Weavr Authorised Signatories API
Weavr Authorised Users API
Weavr Buyer Authorised Users API
Weavr Buyers API
Weavr Card Payments API
Weavr Cards API
Weavr Confirmation Challenges API
#Managed Accounts