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 Payment runs API

A Payment run contains a list of supplier payments. A Payment run can be - created by a user with a `CREATOR` role - confirmed by a user with a `CONTROLLER` role- funded by a user with a `CONTROLLER` roleNote that the Controller user must have their mobile device enrolled to SCA. Before a payment run can be executed, it must be funded. Users with the `CONTROLLER` role must link their company's bank account(s) that are represented as Linked Accounts, which than can be used as the funding source for a payment run.Depending on the bank's constraints it may not be possible to deposit the total amount of funds required for a payment run, in which case the payment run will be automatically split into funding groups. All funding groups must be funded and executed for the payment run to be marked as completed. Note that even if the payment is created successfully, you still need to check its status in order to determine if it is `completed` or`failed`.

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

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

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

10 operations 8 paths 0 schemas 3 GET5 POST2 PUT

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 Payment runs 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, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Payment runs 10

A Payment run contains a list of supplier payments. A Payment run can be - created by a user with a CREATOR role - confirmed by a user with a CONTROLLER role - funded by a user wi…

POST
/v1/payment_runs
Create a payment run
postPaymentRun 1 param body → 200400401403409413422429
GET
/v1/payment_runs
Get payment runs
getPaymentRuns 7 params → 200400401403429500503default
GET
/v1/payment_runs/{payment_run_id}
Get a payment run
getPaymentRunsId 1 param → 200400401403404429500503
PUT
/v1/payment_runs/{payment_run_id}
Update a payment
putPaymentRunsId 1 param body → 204400401403404409429500
POST
/v1/payment_runs/{payment_run_id}/confirm
Confirm a payment run
postPaymentRunsIdConfirm 2 params → 200400401403404409413422
GET
/v1/payment_runs/{payment_run_id}/fund
Get a payment run funding instructions
getPaymentRunsIdFund 2 params → 200400401403404409429500
POST
/v1/payment_runs/{payment_run_id}/cancel
Cancel a payment run
postPaymentRunsIdCancel 2 params → 204400401403404409413422
PUT
/v1/payment_runs/{payment_run_id}/cancel/payments
Cancel a payment
putCancelPaymentRunPayment 2 params body → 204400401403404409413422
POST
/v1/payment_runs/{payment_run_id}/restart
Restart a payment run
postRestartPaymentRun 2 params → 204400401403404409413422
POST
/v1/payment_runs/{payment_run_id}/group/{group_reference}/cancel
Cancel a payment run group
postCancelPaymentRunGroup 3 params → 204400401403404409413422

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavr-payment-runs-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