The identity and technical contract details declared by the specification.
AccountLowBalanceThreshold
integer
Sends a low balance notification webhook when the available balance drops below this amount. Currency is inherited from the managed account.
UserCurrencyTransactionDetails
object
The object representing the user transaction's currency, amount and rate.
2 properties
2 required
CurrencyAmount
object
The object representing a monetary amount in a particular currency.
2 properties
2 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…
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…
StatementTransactionType
string
Statement
object
The list of statement entries.
6 properties
TransactionId
object
2 properties
2 required
Error
object
2 properties
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
ManagedAccount
object
9 properties
7 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…
Tag
string
The tag field is a custom field that can be used to search and filter.
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. -…
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.
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…
Currency
string
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
ManagedInstrumentState
object
3 properties
1 required
StatementEntry
object
16 properties
4 required
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
DigitalWalletType
string
The digital wallet type.
CorrespondentBankingSEPABeneficiary
object
CBT-specific beneficiary details for SEPA/IBAN wire transfers with Banking Circle FI-to-FI field limits.
9 properties
3 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…
StatementResponseEntryTransaction
object
Reference to the transaction this statement entry records. The concrete shape is identified by the type discriminator — see the per-type variants for the avail…
1 property
2 required
StatementResponseEntryTransactionType
string
The top-level type of transaction represented by this statement entry.
InstrumentCounterparty
object
Counterparty that is an internal platform instrument (managed account, managed card).
4 properties
2 required
FeeSubtype
string
The category of fee — indicates the activity or instrument-lifecycle event the fee relates to.
ManagedAccountIBAN
object
2 properties
2 required
SWIFTBeneficiary
object
Beneficiary details for SWIFT wire transfers.
9 properties
4 required
CardPaymentEventType
string
Type of event recorded against a CardPayment. The reversal flag on each event distinguishes a reversal from the original action.
ScheduledTimestamp
string
The epoch timestamp at which the transaction is scheduled to be executed.
CorrespondentBankingIndividualAddressAndBirthInfo
object
Birth information for an individual originator.
2 properties
2 required
SEPABeneficiary
object
Beneficiary details for SEPA/IBAN wire transfers.
9 properties
2 required
MerchantCounterparty
object
Counterparty for a card transaction — a merchant.
5 properties
1 required
IncomingWireTransfer
object
An incoming wire transfer received from an external bank account.
14 properties
5 required
FasterPaymentsBankDetailsOrBACSBankDetails
object
Bank details used in case the wire transfer is executed over Faster Payments.
3 properties
2 required
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
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
DateOfBirth
string
The date of birth in ISO 8601 format (YYYY-MM-DD).
StatementResponseEntry
object
A single entry in an instrument statement. Each entry represents a posted transaction that caused the actual balance of the instrument to change.
11 properties
5 required
StatementResponse
object
A financial statement for an instrument over a given period. Contains only posted/completed transactions where funds have definitively moved (actual balance ch…
6 properties
CorrespondentBankingOwt
object
15 properties
9 required
CorrespondentBankingFasterPaymentsBeneficiary
object
CBT-specific beneficiary details for Faster Payments wire transfers with Banking Circle FI-to-FI field limits.
11 properties
5 required
Transfer
object
12 properties
7 required
OutgoingWireTransferValidationOutcome
object
2 properties
2 required
TransactionForex
object
Foreign exchange details when the transaction involved currency conversion.
4 properties
TransactionCancellationReason
string
The reason the scheduled transaction was cancelled.
TransactionState
string
Status of the transaction.
UKConfirmationOfPayeeResult
object
3 properties
1 required
InstrumentId
object
2 properties
2 required
AccessInstrumentType
string
The type of access instrument that initiated a transaction.
SwiftBankDetails
object
Bank details used in case the wire transfer is executed over SWIFT.
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…
CorrespondentBankingOwtValidationOutcome
object
2 properties
2 required
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
RIXBeneficiary
object
Beneficiary details for RIX wire transfers.
9 properties
2 required
Send
object
16 properties
7 required
ExternalAccountType
string
ChallengeExemptionReason
string
The Reason the transaction was exempted from SCA verification
CorrespondentBankingBankAccountDetails
object
Bank account details for the originator.
2 properties
2 required
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
InstrumentTransactionActivityList
object
A paginated list of transaction activity entries scoped to a single instrument.
3 properties
Merchant
object
Information about a merchant — used wherever a merchant appears in card-payment flows, statement entries, and transaction activity.
16 properties
2 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
CorrespondentBankingExternalData
object
External data key-value pair.
2 properties
2 required
StatementResponseEntryExecutingAccessInstrument
object
The access instrument that initiated the transaction. The concrete shape is identified by the type discriminator.
1 property
2 required
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…
TransactionActivityDirection
string
Whether funds were credited to or debited from the instrument.
FeeSummary
object
4 properties
3 required
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
OutgoingWireTransfer
object
18 properties
6 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…
Nationality
string
Nationality of the user - using ISO 3166 alpha-2.
TransactionActivitySortBy
string
The field to sort transaction activity results by: - creationTimestamp: Sort by when the transaction was first created (default). - lastUpdatedTimestamp: Sort…
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
OutgoingWireTransferType
string
The wire transfer rails used, from SEPA, Faster Payments, SWIFT or RIX.
FasterPaymentsBeneficiary
object
Beneficiary details for Faster Payments wire transfers.
11 properties
4 required
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…
ExecutionTimestamp
string
The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.
CorrespondentBankingOwtState
string
The state of the correspondent bank transfer transaction, as follows: - INVALID: The transfer has failed initial validation checks. - PENDINGCHALLENGE: The tra…
SystemTransactionSubtype
string
The specific kind of system-generated transaction.
CorrespondentBankingRIXBeneficiary
object
CBT-specific beneficiary details for RIX wire transfers with Banking Circle FI-to-FI field limits.
9 properties
3 required
IBANDetails
object
Bank details used in case the wire transfer is executed over SEPA or RIX
2 properties
1 required
ExternalAccountId
object
The id of an external account, such as a Linked Account, registered with the Weavr Platform.
2 properties
2 required
BeneficiaryId
object
1 property
1 required
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
CorrespondentBankingBusinessAddressAndIdInfo
object
Business identification for a business originator.
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…
BankAccountCounterparty
object
Counterparty that is a bank account (for wire transfers).
7 properties
InstrumentStatementSortOrder
string
SEPAVerificationOfPayeeResult
object
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…
CorrespondentBankingIndividualAddressAndIdInfo
object
Personal identification for an individual originator.
2 properties
2 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
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…
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…
StringWrappedTypeId
object
2 properties
2 required
ManagedAccountsIwtEventIwtState
string
InstrumentStateLegacy
object
2 properties
ManagedAccountsDepositEvent
object
15 properties
5 required
LegacyManagedAccount
object
11 properties
6 required
ManagedAccountEventType
string
ManagedAccountLowBalanceEvent
object
4 properties
4 required
LegacyCurrencyAmount
object
The object representing a monetary amount in a particular currency.
2 properties
2 required
ManagedAccountEvent
object
3 properties
3 required
BankAccountDetails
object
8 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Weavr publishes across the network.
