Skip to content
/
Charge fee to a consumer

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

Get KYC for a consumer

Request

Returns the KYC status for the logged-in consumer.

Security
auth_token and api-key
curl -i -X GET \
  https://api.weavr.io/_mock/products/multi/openapi/consumers/kyc \
  -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
fullDueDiligencestring(KyiStatus)required

The status of the Due Diligence for the consumer.

Enum"NOT_STARTED""INITIATED""PENDING_REVIEW""APPROVED""REJECTED"
ongoingFullDueDiligencestring(KyiStatus)required

The status of the ongoing Due Diligence process for the consumer

Enum"NOT_STARTED""INITIATED""PENDING_REVIEW""APPROVED""REJECTED"
kycLevelstring(KycLevel)Deprecated

The KYC level, which determines what KYC information will be requested from the consumer:

  • KYC_LEVEL_1: The most basic level of KYC required.
  • KYC_LEVEL_2: Full due diligence level 2
Enum"KYC_LEVEL_1""KYC_LEVEL_2"
ongoingKycLevelstring(KycLevel)Deprecated

The KYC level, which determines what KYC information will be requested from the consumer:

  • KYC_LEVEL_1: The most basic level of KYC required.
  • KYC_LEVEL_2: Full due diligence level 2
Enum"KYC_LEVEL_1""KYC_LEVEL_2"
Response
application/json
{
  "fullDueDiligence": "NOT_STARTED",
  "kycLevel": "KYC_LEVEL_1",
  "ongoingFullDueDiligence": "NOT_STARTED",
  "ongoingKycLevel": "KYC_LEVEL_1"
}

Charge fee to a consumer

Request

Charge a fee to the logged-in consumer based on a pre-defined custom fee. Custom fees can be configured in the Multi Portal.

The fees collected will be deposited into your Revenue Account. The balance and transaction history of your revenue account can be viewed in the Multi Portal.

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
feeTypestringrequired

The fee type as defined in the Multi Portal.

sourceobject(InstrumentId)required

The instrument from where the fee should be deducted.

source.​idstring(Id)^[0-9]+$required
source.​typestring(InstrumentType)required
Enum"managed_cards""managed_accounts"
curl -i -X POST \
  https://api.weavr.io/_mock/products/multi/openapi/consumers/fees/charge \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string' \
  -d '{
    "feeType": "string",
    "source": {
      "id": "string",
      "type": "managed_cards"
    }
  }'

Responses

Success

Headers
request-refstringrequired

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

Bodyapplication/json
transactionIdobject(TransactionId)required

The unique identifier of the transaction.

transactionId.​typestringrequired
Enum ValueDescription
AUTHORISATION
SETTLEMENT
MANUAL_TRANSACTION

For a manual transaction, the additionalFields: note will contain a description with the reason for the transaction. This will start with one of the following prefixes:

  • Account Closure
  • Chargebacks - Represented
  • Chargebacks - Won
  • Deleted Card - Transfer from
  • Deleted Card - Transfer to
  • Duplicate Authorisation Issue
  • Duplicate Settlement Issue
  • Expired Card - Transfer from
  • Expired Card - Transfer to
  • Forex Padding Release Issue
  • Funds Redemption & Account Closure
  • Manual Auth Expiry
  • Missing Settlement Issue
  • Negative Card Balance
  • Reversal - Duplicate Transaction
  • Reversal - Manual Auth Expiry
  • Reversal - Manual Transaction
  • Amend Balance - Auth Expiry
  • Balance Adjustment
  • Completing Deposit
  • Duplicate Deposit
TRANSFER
SEND
DEPOSIT
AUTHORISATION_REVERSAL
AUTHORISATION_EXPIRY
AUTHORISATION_DECLINE
AUTHORISATION_MANUAL_CLOSE
transactionId.​idstring^[0-9]+$required
profileIdstringrequired

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

feeTypestringrequired

The fee type as defined in the Multi Portal, and as sent in the request.

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

The object representing a monetary amount in a particular currency.

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

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

availableBalanceAdjustment.​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.

statestring(TransactionState)required

The transaction entry state.

Enum"INITIALISED""COMPLETED""REJECTED""FAILED""PENDING""SCHEDULED""CANCELLED"
creationTimestampinteger(int64)required
Response
application/json
{
  "transactionId": {
    "type": "AUTHORISATION",
    "id": "string"
  },
  "profileId": "string",
  "feeType": "string",
  "source": {
    "id": "string",
    "type": "managed_cards"
  },
  "availableBalanceAdjustment": {
    "currency": "str",
    "amount": 0
  },
  "state": "INITIALISED",
  "creationTimestamp": 0
}

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

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