Skip to content
/
Cancel send transactions

Weavr Multi Product API (3.63.5)

Weavr Multi API provides a simple and flexible way to issue cards and accounts to your customers.

By integrating Weavr Multi API in your application you can embed banking capabilities within your app and provide a seamless experience for your customers.

Authentication

Each request to the Multi API must include an api-key that represents your account. You can obtain an API Key by registering for a Multi account here.

Almost all endpoints require a secondary authentication token auth_token that represents the user for whom the request is being executed.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://weavr.io
Languages
Servers
Mock server
https://api.weavr.io/_mock/products/multi/openapi
Weavr Sandbox Environment
https://sandbox.weavr.io/multi

Access

Manage authentication for your users.

Operations

Passwords

Manage your users' passwords.

Operations

Authentication Factors

Operations

Step-up Challenges

Operations

Confirmation Challenges

Operations

Corporates

Corporates are identities representing companies. Once on-boarded, Corporates can create and manage their own instruments via your application.

Operations

Consumers

Consumers are identities representing individuals. Once on-boarded, Consumers can create and manage their own instruments via your application.

Operations

Authorised Users

Corporate and Consumer identities can invite authorised users to access their account. Once on-boarded, authorised users can create and manage instruments and transactions on behalf of the identity they are on-boarded with.

In case of Corporate Identities, authorised users are typically employees who have access to company's banking products such as cards and bank accounts.

In case of Consumer Identities, authorised users are typically children/teens whose parents want them to have access to banking products such as cards and bank accounts.

Note that the /users GET endpoints return all users including root users. However, modification operations (create, update, activate, deactivate) on /users endpoints only apply to authorised users. To modify root user details, use the respective /consumers or /corporates endpoints.

Operations

Beneficiaries

Operations

Managed Accounts

Managed Accounts are a type of financial instrument offered by Weavr.

They hold funds for their owner, and can be upgraded to IBANs so as to receive and send funds to instruments outside of the Weavr Platform, via Wire Transfers.

Managed accounts can also be used as source and destination instruments in the transfer and send transactions.

Operations

Managed Cards

Managed Cards are a type of financial instrument offered by Weavr.

You can create virtual or physical cards that are issued to the consumer or corporate identity.

A card created in prepaid mode has its own balance, whereas a card created in debit mode does not have its own balance but taps into the balance of its parent managed account.

Operations

Linked Accounts

Linked Accounts are external bank accounts that users connect to their profiles within the Weavr Platform.

These accounts allow users to link their existing bank accounts, held at external financial institutions, to the Weavr Platform, enabling secure and efficient transfer of funds between their own accounts.

Linked Accounts are designed to streamline the process of moving money between a user’s various bank accounts, providing a convenient and integrated way to manage personal finances across different financial institutions.

Operations

Sends

The Send transaction is used to send funds between managed accounts and managed cards belonging to different identities.

Operations

Get all send transactions

Request

Retrieves all the send transactions performed by the logged-in identity.

Security
auth_token and api-key
Query
offsetinteger(int32)>= 0

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

limitinteger(int32)[ 1 .. 100 ]

The limit of the results for paging, starting at the offset. Limit is always capped at 100.

profileIdstring(ProfileId)^[0-9]+$

Filter by the Send profile. Leave out to fetch all entries.

instrumentIdobject(InstrumentId)

Filter by the source instrument id.

source.idstring(Id)^[0-9]+$

Filter by the source instrument id. Must be specified when source.type is provided.

source.typestring(InstrumentType)

Filter by the source instrument type. Must be specified when source.id is provided.

Enum"managed_cards""managed_accounts"
stateArray of strings(SendState)unique

Filter by the Send transaction state. Leave out to fetch all states.

Items Enum"INVALID""INITIALISED""COMPLETED""REJECTED""FAILED""PENDING""PENDING_CHALLENGE""APPROVED""RETURNED""SCHEDULED"
createdFrominteger(int64)

Filter for send transactions created after createdFrom timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

createdTointeger(int64)

Filter for send transactions created before createdTo timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

executedFrominteger(int64)

Filter for send transactions executed after executedFrom timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

executedTointeger(int64)

Filter for send transactions executed before executedTo timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

tagstring

Filter by the send tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all entries.

curl -i -X GET \
  'https://api.weavr.io/_mock/products/multi/openapi/sends?offset=0&limit=1&profileId=string&id=string&type=managed_cards&source.id=string&source.type=managed_cards&state=INVALID&createdFrom=0&createdTo=0&executedFrom=0&executedTo=0&tag=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
sendArray of objects(Send)
countinteger(int32)

Total number of records (excluding the paging limit).

responseCountinteger(int32)

Total number of records returned in this response.

Response
application/json
{
  "send": [
    { … }
  ],
  "count": 0,
  "responseCount": 0
}

Cancel send transactions

Request

Cancels send transactions that are scheduled to be executed in the future.

Security
auth_token and api-key
Bodyapplication/jsonrequired
cancellationsArray of objects(TransactionCancelRequest)required

Contains the details of the transactions to be cancelled.

cancellations[].​idstring^[0-9]+$required

The id of the transaction.

cancellations[].​cancellationReasonstring(TransactionCancellationReason)<= 50 characters^[ a-zA-Z0-9_-]+$

The reason the scheduled transaction was cancelled.

curl -i -X POST \
  https://api.weavr.io/_mock/products/multi/openapi/sends/bulk/cancel \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "cancellations": [
      {
        "id": "string",
        "cancellationReason": "string"
      }
    ]
  }'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
cancellationsArray of objects(TransactionCancelResponse)required

Contains the cancellation details for each of the transactions.

cancellations[].​idstring^[0-9]+$required

The id of the transaction.

cancellations[].​statestringrequired
Enum"SUCCESS""ERROR"
cancellations[].​errorCodestring

Indicates the reason why the cancel operation could not be executed. May be included in the response if the state is "ERROR".

  • "GENERIC": A generic error has occurred.
  • "TRANSACTION_NOT_SCHEDULED": The transaction is not in state SCHEDULED.
  • "FORBIDDEN": The current user is not allowed to access this transaction.
  • "NOT_FOUND": The transaction does not exist.
Enum"GENERIC""TRANSACTION_NOT_SCHEDULED""FORBIDDEN""NOT_FOUND"
Response
application/json
{
  "cancellations": [
    { … }
  ]
}

Get a send transaction

Request

Retrieve the send transaction identified by the id path parameter.

Security
auth_token and api-key
Path
idstring^[0-9]+$required

The unique identifier of the Send transaction.

curl -i -X GET \
  'https://api.weavr.io/_mock/products/multi/openapi/sends/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
idstring^[0-9]+$required

The unique identifier of a send transaction.

profileIdstring(ProfileId)^[0-9]+$required

The profile Id which a specific identity, instrument or transaction type is linked to.

Profiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.

You can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

tagstring(Tag)<= 50 characters^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

sourceobject(InstrumentId)required

The source managed account or card from where the funds were sent.

source.​idstring(Id)^[0-9]+$required
source.​typestring(InstrumentType)required
Enum"managed_cards""managed_accounts"
sourceFeeobject

The object representing a monetary amount in a particular currency.

destinationInstrumentId (object) or BeneficiaryId (object)

The destination managed account or card to where the funds were sent.

One of:

The destination managed account or card to where the funds were sent.

destinationAmountobject(CurrencyAmount)required

The amount, in same currency as source and destination, that was sent from the source to the destination instrument.

destinationAmount.​currencystring(Currency)= 3 characters^[A-Z]*$required

The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.

destinationAmount.​amountinteger(int64)required

The monetary amount, scaled to the lowest denomination of the currency.

Example, an amount of 1000 for a EUR currency is actually 1000 Euro cents or EUR 10.00.

destinationFeeobject

The object representing a monetary amount in a particular currency.

transactionAmountobjectrequired

The object representing a monetary amount in a particular currency.

transactionAmount.​currencystring(Currency)= 3 characters^[A-Z]*$required

The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.

transactionAmount.​amountinteger(int64)required

The monetary amount, scaled to the lowest denomination of the currency.

Example, an amount of 1000 for a EUR currency is actually 1000 Euro cents or EUR 10.00.

descriptionstring<= 255 characters^[a-zA-Z0-9\/\-?:().$_,'+\s#=!"%&*<>;\{@\r\n]...

The description details that are passed to the beneficiary.

statestring(SendState)required

The state of the send transaction, as follows:

  • INVALID: The send transaction has failed initial validation checks.
  • INITIALISED: The initial state of a send transaction when SCA is not required.
  • PENDING_CHALLENGE: The send transaction requires the completion of a transaction confirmation challenge before it can be submitted.
  • PENDING: The send transaction has exceeded the destination limit and is pending treasury approval.
  • APPROVED: The send transaction that was submitted has been approved.
  • COMPLETED: The requested funds have been sent from the source instrument.
  • REJECTED: The send transaction that was submitted was rejected.
  • FAILED: There was an issue with the send transaction, and the transaction has failed.
  • RETURNED: The send transaction has been returned to the sender.
  • SCHEDULED: The send transaction will be executed at the scheduled time.
  • CANCELLED: The scheduled send transaction has been cancelled.
Enum"INVALID""INITIALISED""COMPLETED""REJECTED""FAILED""PENDING""PENDING_CHALLENGE""APPROVED""RETURNED""SCHEDULED"
challengeExemptionReasonstring(ChallengeExemptionReason)

The Reason the transaction was exempted from SCA verification

Enum"LOW_VALUE""TRUSTED_BENEFICIARY"
creationTimestampinteger(int64)required

The time when the transaction was created, expressed in Epoch timestamp using millisecond precision.

scheduledTimestampstring(ScheduledTimestamp)^[0-9]+$

The epoch timestamp at which the transaction is scheduled to be executed.

executionTimestampstring(ExecutionTimestamp)^[0-9]+$

The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.

cancellationReasonstring(TransactionCancellationReason)<= 50 characters^[ a-zA-Z0-9_-]+$

The reason the scheduled transaction was cancelled.

Response
application/json
{
  "id": "string",
  "profileId": "string",
  "tag": "string",
  "source": {
    "id": "string",
    "type": "managed_cards"
  },
  "sourceFee": {
    "currency": "str",
    "amount": 0
  },
  "destination": {
    "id": "string",
    "type": "managed_cards"
  },
  "destinationAmount": {
    "currency": "str",
    "amount": 0
  },
  "destinationFee": {
    "currency": "str",
    "amount": 0
  },
  "transactionAmount": {
    "currency": "str",
    "amount": 0
  },
  "description": "string",
  "state": "INVALID",
  "challengeExemptionReason": "LOW_VALUE",
  "creationTimestamp": 0,
  "scheduledTimestamp": "string",
  "executionTimestamp": "string",
  "cancellationReason": "string"
}

Transfers

The Transfer transaction is used to transfer funds between managed accounts and managed cards belonging to same identity.

Operations

Outgoing Wire Transfers

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

Operations

Incoming Wire Transfers

Webhooks

Operations

Operations

Manage

Operations