Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Weavr Outgoing Wire Transfers API

The Outgoing Wire Transfer transaction is used to transfer funds from managed accounts to an external bank account.

Weavr Outgoing Wire Transfers API is one of 43 APIs that Weavr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Outgoing Wire Transfers. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 8 paths, and defines 41 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.

10 operations 8 paths 41 schemas 3 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v3
Base URL
https://api.weavr.io/multi
Authentication
API Key, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Weavr Outgoing Wire Transfers 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 10

Across 8 paths, the API surfaces 10 operations — 3 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Outgoing Wire Transfers 10

The Outgoing Wire Transfer transaction is used to transfer funds from managed accounts to an external bank account.

POST
/outgoing_wire_transfers
Create an outgoing wire transfer
outgoingWireTransferCreate 1 param body → 200400401403409429500503
GET
/outgoing_wire_transfers
Get all outgoing wire transfer transactions
outgoingWireTransfersGet 12 params → 200400401403429500503
GET
/outgoing_wire_transfers/{id}
Get an outgoing wire transfer transaction
outgoingWireTransferGet 1 param → 200400401403404429500503
PATCH
/outgoing_wire_transfers/{id}
Update the beneficiary name of an outgoing wire transfer
outgoingWireTransferUpdateBeneficiaryName 1 param body → 200409
GET
/outgoing_wire_transfers/{id}/payment_confirmation
Get an outgoing wire transfer payment confirmation
outgoingWireTransferPaymentConfirmation 1 param → 200400401403404409429500
POST
/outgoing_wire_transfers/{id}/cancel
Cancel an outgoing wire transfer transaction
outgoingWireTransferSingleCancel 1 param body → 200400401403404409429500
POST
/outgoing_wire_transfers/{id}/confirm
Confirm an outgoing wire transfer transaction
outgoingWireTransferConfirm 1 param → 200400401403404409429500
POST
/outgoing_wire_transfers/{id}/challenges/otp/{channel}deprecated
Issue a one-time password that can be used to verify an outgoing wire transfer
outgoingWireTransferSCAChallenge 2 params → 204400401403405409429500
POST
/outgoing_wire_transfers/{id}/challenges/otp/{channel}/verifydeprecated
Verify an outgoing wire transfer using a one-time password
outgoingWireTransferSCAVerify 2 params body → 204400401403409429500503
POST
/outgoing_wire_transfers/{id}/challenges/push/{channel}deprecated
Issue a push notification that can be used to verify an outgoing wire transfer
outgoingWireTransferSCAChallengePush 2 params → 204400401403405409429500

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are OutgoingWireTransfer (18 properties), FasterPaymentsBeneficiary (11 properties), OutgoingWireTransferBeneficiary (9 properties), SEPABeneficiary (9 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…
FasterPaymentsBankDetailsOrBACSBankDetails
object
Bank details used in case the wire transfer is executed over Faster Payments.
3 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
DateOfBirth
string
The date of birth in ISO 8601 format (YYYY-MM-DD).
SEPAVerificationOfPayeeResult
object
2 properties 1 required
OutgoingWireTransferUpdateBeneficiaryNameConflict
object
1 property
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.
SourceInstrumentType
string
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
OutgoingWireTransferUpdateBeneficiaryNameConflictSchemaErrorCode
string
BeneficiaryId
object
1 property 1 required
ChallengeExemptionReason
string
The Reason the transaction was exempted from SCA verification
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.
OutgoingWireTransferUpdateBeneficiaryNameRequest
object
2 properties
ExecutionTimestamp
string
The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.
OutgoingWireTransferPaymentConfirmationConflictErrorCode
string
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
ScheduledTimestamp
string
The epoch timestamp at which the transaction is scheduled to be executed.
OutgoingWireTransferPaymentConfirmationConflict
object
1 property 1 required
SEPABeneficiary
object
Beneficiary details for SEPA/IBAN wire transfers.
9 properties 2 required
ExternalAccountType
string
SCAPushChannel
string
- "AUTHY": The push notification is sent on the user's device using [Twilio Authy](https://www.twilio.com/authy) - "BIOMETRIC": The push notification is sent t…
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
SWIFTBeneficiary
object
Beneficiary details for SWIFT wire transfers.
9 properties 4 required
Nationality
string
Nationality of the user - using ISO 3166 alpha-2.
OutgoingWireTransfer
object
18 properties 6 required
TransactionCancellationReason
string
The reason the scheduled transaction was cancelled.
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
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
TransactionSingleCancelRequest
object
1 property
OutgoingWireTransferCreateRequest
object
8 properties 4 required
Nonce
string
A randomly generated one-time use code.
SCAOtpChannel
string
- "SMS": The one-time-password is sent as a text message
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavr-outgoing-wire-transfers-api-openapi.yml Raw ↑

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