Custom fees
With Weavr, you can earn revenue from your customers for using your services. To set up custom fees, go to the Weavr Portal > Settings page and find consumer or corporate profileProfile A template defining the configuration for one type of object - corporate identity, consumer identity, managed account, managed card, transfer, or outgoing wire transfer. When you create one of these objects you reference its Profile ID, which tells Weavr which limits, currencies, supported countries, branding, and fees to apply. Your programme ships with one or more Profile IDs per supported object type. configuration.
The system takes custom fees when you trigger an API endpoint request. After you have configured a custom fee, you can use the API to take the fee and deposit it in your revenue account.
To charge a fee to a corporate identity:
- Request
- Response
{
"feeType": "string",
"source": {
"id": "string",
"type": "managed_cards"
}
}
{
"transactionId": {
"type": "AUTHORISATION",
"id": "string"
},
"profileId": "string",
"feeType": "string",
"source": {
"id": "string",
"type": "managed_cards"
},
"availableBalanceAdjustment": {
"currency": "str",
"amount": 0
},
"state": "INITIALISED",
"creationTimestamp": 0
}
To charge a fee to a consumer identity:
- Request
- Response
{
"feeType": "string",
"source": {
"id": "string",
"type": "managed_cards"
}
}
{
"transactionId": {
"type": "AUTHORISATION",
"id": "string"
},
"profileId": "string",
"feeType": "string",
"source": {
"id": "string",
"type": "managed_cards"
},
"availableBalanceAdjustment": {
"currency": "str",
"amount": 0
},
"state": "INITIALISED",
"creationTimestamp": 0
}
Fee configuration
You can configure custom fees only as flat fees in the currencies that you support. When you call our API, you use the fee key to identify the fee to be taken.
Create a fee key
- Log in to the Weavr Portal using your account credentials.
- Navigate to Settings and open the consumer or corporate profileProfile A template defining the configuration for one type of object - corporate identity, consumer identity, managed account, managed card, transfer, or outgoing wire transfer. When you create one of these objects you reference its Profile ID, which tells Weavr which limits, currencies, supported countries, branding, and fees to apply. Your programme ships with one or more Profile IDs per supported object type. configuration.
- In the custom fees section, add a new custom fee by providing the fee key, a description, and the fee amount per supported currency.
- Save the profileProfile A template defining the configuration for one type of object - corporate identity, consumer identity, managed account, managed card, transfer, or outgoing wire transfer. When you create one of these objects you reference its Profile ID, which tells Weavr which limits, currencies, supported countries, branding, and fees to apply. Your programme ships with one or more Profile IDs per supported object type.. The fee key is now available to reference in the
feeKeyfield when calling the charge endpoints documented earlier on this page.
Custom fees are taken on a best-effort basis-if the identity's managed accountsManaged Account An account held at a financial institution that can be created and managed through the Weavr platform. Each account has a balance where customers can hold funds. Optionally, an IBAN can be assigned to enable wire transfers to bank accounts outside of Weavr. do not have sufficient funds to cover the fee, the charge request fails and the fee is not taken. You can retry the charge once funds are available.