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 Simulator API

Simulators enable you to trigger processes in Sandbox that in Production are triggered from an external action rather than from your application. this way you can test scenarios that otherwise you would only encounter in the Live environment.*Note: These endpoints are only available on Sandbox and won’t work in the Live environment.*

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

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

This API exposes 7 operations across 7 paths. 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.

7 operations 7 paths 0 schemas 7 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 Simulator 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 7

Across 7 paths, the API surfaces 7 operations — 7 POST. Each is listed below with its method, path, parameters, and response codes.

Simulator 7

Simulators enable you to trigger processes in Sandbox that in Production are triggered from an external action rather than from your application. this way you can test scenarios t…

POST
/simulate/v1/payment_runs/{payment_run_id}/fund_group/{reference}
Simulate Fund a Payment run
postFundPaymentRunGroup 2 params → 201400401403404409500503
POST
/simulate/v1/linked_accounts
Simulate Creating a Linked Account via Open Banking
postLinkedAccounts body → 201400401403409500503default
POST
/simulate/v1/linked_accounts/{linked_account_id}/fund
Simulate Control Check via Test Funding Transaction
postSimulateLinkedAccountFundVerification 1 param → 204400401403404409500503
POST
/simulate/v1/buyers/{buyer_id}/verify
Simulate Buyer KYB Verify
verifyBuyerKyb 1 param → 204400401403404500503default
POST
/simulate/v1/consents/{linked_account_id}/change_status
Simulate AIS consent status change
postSimulateConsentStatusChange 1 param body → 204400401403404409500503
POST
/simulate/v1/payment_run_sca/{payment_run_id}/challenges/otp/{channel}
Simulate issuing a Payment Run SCA Challenge
issuePaymentRunChallengeSimulate 2 params → 204400401403404409429500
POST
/simulate/v1/payment_run_sca/{payment_run_id}/challenges/otp/{channel}/verify
Simulate verifying a payment run SCA Challenge
verifyPaymentRunChallengeSimulate 2 params body → 204400401403404409429500

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavr-simulator-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