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 Trusted Payees API

Manage a list of trusted payees for Outgoing wire transfers and Sends.Aside from convenience and a reduced chance of making errors when making transactions,this allows for the introduction an SCA exemption, where the account holder can requestthat transactions to `TRUSTED` payees to be exempted from the requirement to passan SCA challenge every time.

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

Tagged areas include Trusted Payees. The published artifact set on APIs.io includes an OpenAPI specification.

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

9 operations 8 paths 24 schemas 4 GET5 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 Trusted Payees 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 9

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

Trusted Payees 9

Manage a list of trusted payees for Outgoing wire transfers and Sends. Aside from convenience and a reduced chance of making errors when making transactions, this allows for the i…

POST
/beneficiaries
Add payees
beneficiaryBatchCreate 1 param body → 200400401403404429500503
GET
/beneficiaries
Get all payees
beneficiariesGet 4 params → 200400401403429500503default
POST
/beneficiaries/remove
Remove payees
beneficiaryBatchRemove 1 param body → 200400401403404429500503
GET
/beneficiaries/{id}
Get a payee
beneficiaryGet 1 param → 200400401403404429500503
GET
/beneficiaries/batch
Get all payee batches
beneficiaryBatchesGet 5 params → 200400401403429500503default
GET
/beneficiaries/batch/{id}
Get a batch of payees
beneficiaryBatchGet 1 param → 200400401403404429500503
POST
/beneficiaries/batch/{id}/challenges/otp/{channel}
Issue OTP to verify batch
beneficiaryBatchSCAChallenge 2 params → 204400401403405409429500
POST
/beneficiaries/batch/{id}/challenges/otp/{channel}/verify
Verify batch using OTP
beneficiaryBatchSCAVerify 2 params body → 204400401403409429500503
POST
/beneficiaries/batch/{id}/challenges/push/{channel}
Issue push to verify batch
beneficiaryBatchSCAChallengePush 2 params → 204400401403405409429500

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are BankAccountDetailsBeneficiary (5 properties), BasicBeneficiary (5 properties), BeneficiaryBatch (3 properties), FasterPaymentsBankDetailsOrBACSBankDetails (3 properties). Each schema is shown below with its type and property counts.

BeneficiaryTrustLevel
string
The value that determines whether a Beneficiary is trusted or not.
FasterPaymentsBankDetailsOrBACSBankDetails
object
Bank details used in case the wire transfer is executed over Faster Payments.
3 properties 2 required
BankAccountDetailsBeneficiary
object
Represent the beneficiary bank account typically used in Outgoing Wire Transfer transactions.
5 properties 1 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
BusinessBeneficiaryType
object
1 property 1 required
BeneficiaryBatchState
string
BeneficiaryValidationFailure
string
IBANDetails
object
Bank details used in case the wire transfer is executed over SEPA or RIX
2 properties 1 required
BeneficiaryBatchOperation
string
BeneficiaryBatch
object
3 properties 2 required
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…
Nonce
string
A randomly generated one-time use code.
ConsumerBeneficiaryType
object
3 properties 1 required
InstrumentDetailsBeneficiary
object
Represents a Weavr beneficiary instrument typically used in Send transactions.
1 property 1 required
SCAOtpChannel
string
- "SMS": The one-time-password is sent as a text message
BasicBeneficiary
object
5 properties 3 required
InstrumentType
string
InstrumentId
object
2 properties 2 required
Id
string
Beneficiary
BeneficiaryOperationBatchId
object
2 properties 2 required
Error
object
2 properties
BeneficiaryState
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-trusted-payees-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