Skip to content
/
Remove beneficiaries

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

Get all beneficiaries

Request

Retrieves the beneficiaries that match the query parameters.

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.

batchIdArray of stringsunique

Search by the beneficiary batch id.

groupArray of stringsunique

Search by the beneficiary group.

curl -i -X GET \
  'https://api.weavr.io/_mock/products/multi/openapi/beneficiaries?offset=0&limit=1&batchId=string&group=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
beneficiariesArray of objects(Beneficiary)
countinteger(int32)

The total number of records (excluding the paging limit).

responseCountinteger(int32)

The total number of records returned in this response (always capped at 100).

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

Remove beneficiaries

Request

Removes one or more beneficiaries from the beneficiaries list identified by the id path parameter used in the array.

Security
auth_token and api-key
Headers
idempotency-refstring

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

Bodyapplication/jsonrequired
beneficiaryIdsArray of stringsnon-emptyrequired

A list of Beneficiary Ids.

curl -i -X POST \
  https://api.weavr.io/_mock/products/multi/openapi/beneficiaries/remove \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string' \
  -d '{
    "beneficiaryIds": [
      "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
operationBatchIdobject(BeneficiaryOperationBatchId)required
operationBatchId.​batchIdstring^[0-9]+$required

The unique identifier of a Beneficiary.

operationBatchId.​operationstring(BeneficiaryBatchOperation)required

Describes the operation that has occurred on a beneficiary batch.

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

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

statestring(BeneficiaryBatchState)required
Enum"INITIALISED""FAILED""PENDING_CHALLENGE""CHALLENGE_FAILED""CHALLENGE_COMPLETED""COMPLETED"
Response
application/json
{
  "operationBatchId": {
    "batchId": "string",
    "operation": "CREATE"
  },
  "tag": "string",
  "state": "INITIALISED"
}

Get a beneficiary

Request

Retrieves a beneficiary identified by the id path parameter

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

The unique identifier of a beneficiary.

curl -i -X GET \
  'https://api.weavr.io/_mock/products/multi/openapi/beneficiaries/{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
trustLevelstring(BeneficiaryTrustLevel)required

The value that determines whether a Beneficiary is trusted or not.

Value"TRUSTED"
externalRefsArray of strings

The id of the entity as it is represented on the caller system.

groupstring<= 150 characters

A custom field that can be used to categorise a beneficiary for easier searching and filtering.

beneficiaryInformationBusinessBeneficiaryType (object) or ConsumerBeneficiaryType (object)required

The object representing the beneficiary details.

One of:

The object representing the beneficiary details.

beneficiaryInformation.​businessNamestringrequired

The business beneficiary name. The allowed length and pattern is dependent on the beneficiary details type:

InstrumentDetailsBeneficiary or BankAccountDetailsBeneficiary with IBANDetails: >= 1 character and <= 150 characters

BankAccountDetailsBeneficiary with FasterPaymentsBankDetailsOrBACSBankDetails: >= 1 character and <= 140 characters with a pattern of ^[a-zA-Z0-9\/\-?:().,’+\s#=!"%&*<>;\{@\r\n]*$ (please note that the ’ symbol is the unicode value U+2019 (right single quotation mark) and not the unicode value U+0027 (apostrophe))

beneficiaryDetailsInstrumentDetailsBeneficiary (object) or BankAccountDetailsBeneficiary (object)required

The object representing the beneficiary instrument details.

One of:

Represents a Weavr beneficiary instrument typically used in Send transactions.

beneficiaryDetails.​instrumentobject(InstrumentId)required
beneficiaryDetails.​instrument.​idstring(Id)^[0-9]+$required
beneficiaryDetails.​instrument.​typestring(InstrumentType)required
Enum"managed_cards""managed_accounts"
idstring^[0-9]+$required

The unique identifier of a Beneficiary.

relatedOperationBatchesArray of objects(BeneficiaryOperationBatchId)required

The object representing the list of batch IDs and the operations that occurred for each batch.

relatedOperationBatches[].​batchIdstring^[0-9]+$required

The unique identifier of a Beneficiary.

relatedOperationBatches[].​operationstring(BeneficiaryBatchOperation)required

Describes the operation that has occurred on a beneficiary batch.

Enum"CREATE""REMOVE"
statestring(BeneficiaryState)required
Enum"INITIALISED""INVALID""PENDING_CHALLENGE""CHALLENGE_FAILED""ACTIVE""REMOVED"
validationFailurestring(BeneficiaryValidationFailure)
Enum"INSTRUMENT_DETAILS_NOT_FOUND""BENEFICIARY_DETAILS_ALREADY_EXIST""BENEFICIARY_BELONGS_TO_SAME_IDENTITY"
Response
application/json
{
  "trustLevel": "TRUSTED",
  "externalRefs": [
    "string"
  ],
  "group": "string",
  "beneficiaryInformation": {
    "businessName": "string"
  },
  "beneficiaryDetails": {
    "instrument": { … }
  },
  "id": "string",
  "relatedOperationBatches": [
    { … }
  ],
  "state": "INITIALISED",
  "validationFailure": "INSTRUMENT_DETAILS_NOT_FOUND"
}

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

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