The identity and technical contract details declared by the specification.
CorrespondentBankingOwtValidationOutcome
object
2 properties
2 required
TransactionActivityItem
object
A transaction activity entry returned by the cross-instrument /transactions endpoint. Common fields are surfaced at the top level for easy filtering and sortin…
10 properties
6 required
CorrespondentBankingIndividualAddressAndIdInfo
object
Personal identification for an individual originator.
2 properties
2 required
TransactionActivityDirection
string
Whether funds were credited to or debited from the instrument.
Nationality
string
Nationality of the user - using ISO 3166 alpha-2.
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
Tag
string
The tag field is a custom field that can be used to search and filter.
CorrespondentBankingBusinessAddressAndIdInfo
object
Business identification for a business originator.
2 properties
2 required
Send
object
16 properties
7 required
CorrespondentBankingIndividualAddressAndBirthInfo
object
Birth information for an individual originator.
2 properties
2 required
InstrumentId
object
2 properties
2 required
TransactionForex
object
Foreign exchange details when the transaction involved currency conversion.
4 properties
OutgoingWireTransfer
object
18 properties
6 required
CorrespondentBankingBankAccountDetails
object
Bank account details for the originator.
2 properties
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…
OutgoingWireTransferState
string
The state of the Outgoing wire transfer transaction, as follows: - INVALID: The wire transfer has failed initial validation checks. - PENDINGCHALLENGE: The wir…
ExecutionTimestamp
string
The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.
IBANDetails
object
Bank details used in case the wire transfer is executed over SEPA or RIX
2 properties
1 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
SEPAVerificationOfPayeeResult
object
2 properties
1 required
SystemTransactionSubtype
string
The specific kind of system-generated transaction.
Error
object
2 properties
IncomingWireTransfer
object
An incoming wire transfer received from an external bank account.
14 properties
5 required
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
TransactionActivityType
string
The type of transaction: - transfers: Internal transfer between instruments of the same identity - sends: Transfer between instruments of different identities…
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…
CorrespondentBankingOwt
object
15 properties
9 required
CorrespondentBankingRIXBeneficiary
object
CBT-specific beneficiary details for RIX wire transfers with Banking Circle FI-to-FI field limits.
9 properties
3 required
FasterPaymentsBeneficiary
object
Beneficiary details for Faster Payments wire transfers.
11 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
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
OutgoingWireTransferValidationOutcome
object
2 properties
2 required
TransactionCancellationReason
string
The reason the scheduled transaction was cancelled.
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…
SEPABeneficiary
object
Beneficiary details for SEPA/IBAN wire transfers.
9 properties
2 required
BeneficiaryId
object
1 property
1 required
FeeSummary
object
4 properties
3 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…
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
CorrespondentBankingOwtState
string
The state of the correspondent bank transfer transaction, as follows: - INVALID: The transfer has failed initial validation checks. - PENDINGCHALLENGE: The tra…
ChallengeExemptionReason
string
The Reason the transaction was exempted from SCA verification
UKConfirmationOfPayeeResult
object
3 properties
1 required
Currency
string
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
CorrespondentBankingFasterPaymentsBeneficiary
object
CBT-specific beneficiary details for Faster Payments wire transfers with Banking Circle FI-to-FI field limits.
11 properties
5 required
TransactionState
string
Status of the transaction.
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…
DateOfBirth
string
The date of birth in ISO 8601 format (YYYY-MM-DD).
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
ExternalAccountId
object
The id of an external account, such as a Linked Account, registered with the Weavr Platform.
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…
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…
Transfer
object
12 properties
7 required
OutgoingWireTransferType
string
The wire transfer rails used, from SEPA, Faster Payments, SWIFT or RIX.
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…
CardPaymentEventType
string
Type of event recorded against a CardPayment. The reversal flag on each event distinguishes a reversal from the original action.
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…
CorrespondentBankingExternalData
object
External data key-value pair.
2 properties
2 required
FasterPaymentsBankDetailsOrBACSBankDetails
object
Bank details used in case the wire transfer is executed over Faster Payments.
3 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
SWIFTBeneficiary
object
Beneficiary details for SWIFT wire transfers.
9 properties
4 required
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
FeeSubtype
string
The category of fee — indicates the activity or instrument-lifecycle event the fee relates to.
CorrespondentBankingSEPABeneficiary
object
CBT-specific beneficiary details for SEPA/IBAN wire transfers with Banking Circle FI-to-FI field limits.
9 properties
3 required
CurrencyAmount
object
The object representing a monetary amount in a particular currency.
2 properties
2 required
TransactionActivityList
object
A paginated list of transaction activity entries.
3 properties
RIXBeneficiary
object
Beneficiary details for RIX wire transfers.
9 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
Merchant
object
Information about a merchant — used wherever a merchant appears in card-payment flows, statement entries, and transaction activity.
16 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Weavr publishes across the network.
