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 Correspondent Bank Transfers API

Correspondent bank transfers allow financial institutions to initiate wire transfers on behalf of originators (third parties).These transfers comply with travel rule requirements by capturing and transmitting originator information.

Weavr Correspondent Bank 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 Correspondent Bank Transfers. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 4 paths, and defines 29 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.

5 operations 4 paths 29 schemas 2 GET3 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 Correspondent Bank 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 5

Across 4 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Correspondent Bank Transfers 5

Correspondent bank transfers allow financial institutions to initiate wire transfers on behalf of originators (third parties). These transfers comply with travel rule requirements…

POST
/correspondent_bank_transfers
Create a correspondent bank transfer
correspondentBankTransferCreate 1 param body → 200400401403409429500503
GET
/correspondent_bank_transfers
Get all correspondent bank transfer transactions
correspondentBankTransfersGet 14 params → 200400401403429500503
GET
/correspondent_bank_transfers/{id}
Get a correspondent bank transfer transaction
correspondentBankTransferGet 1 param → 200400401403404429500503
POST
/correspondent_bank_transfers/{id}/cancel
Cancel a correspondent bank transfer transaction
correspondentBankTransferCancel 1 param body → 200400401403404409429500
POST
/correspondent_bank_transfers/{id}/confirm
Confirm a correspondent bank transfer transaction
correspondentBankTransferConfirm 1 param → 200400401403404409429500

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are CorrespondentBankingOwt (15 properties), CorrespondentBankingFasterPaymentsBeneficiary (11 properties), CorrespondentBankingOwtCreateRequest (10 properties), CorrespondentBankingSEPABeneficiary (9 properties). Each schema is shown below with its type and property counts.

CorrespondentBankingRIXBeneficiary
object
CBT-specific beneficiary details for RIX 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
CorrespondentBankingOwtState
string
The state of the correspondent bank transfer transaction, as follows: - INVALID: The transfer has failed initial validation checks. - PENDINGCHALLENGE: The tra…
TransactionCancellationReason
string
The reason the scheduled transaction was cancelled.
CorrespondentBankingExternalData
object
External data key-value pair.
2 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
CorrespondentBankingOwtValidationOutcome
object
2 properties 2 required
UKConfirmationOfPayeeResult
object
3 properties 1 required
CorrespondentBankingIndividualAddressAndBirthInfo
object
Birth information for an individual originator.
2 properties 2 required
TransactionSingleCancelRequest
object
1 property
ScheduledTimestamp
string
The epoch timestamp at which the transaction is scheduled to be executed.
CorrespondentBankingOwtCreateRequest
object
10 properties 6 required
CorrespondentBankingOwt
object
15 properties 9 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
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
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.
CorrespondentBankingSEPABeneficiary
object
CBT-specific beneficiary details for SEPA/IBAN wire transfers with Banking Circle FI-to-FI field limits.
9 properties 3 required
Id
string
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
Error
object
2 properties
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.
CorrespondentBankingBankAccountDetails
object
Bank account details for the originator.
2 properties 2 required
SourceInstrumentType
string
Tag
string
The tag field is a custom field that can be used to search and filter.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavr-correspondent-bank-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