Acquire a token granting you access to perform sensitive operations on behalf of an identity.
Weavr Multi Product BackOffice API (v3)
Weavr Multi Back Office API allows you, as an innovator, to perform various back office operations concerning identities and their instruments, without requiring the users to be logged in.
A token is to be obtained through the access_token method, and this will allow relevant operations to be performed on behalf of this same identity.
Download OpenAPI description
Overview
URL
Languages
Servers
Mock server
https://api.weavr.io/_mock/products/multi-backoffice/openapi
Weavr Sandbox Environment
https://sandbox.weavr.io/multi/backoffice
Request
Charge a fee to the corporate identified by the auth token, 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
- Mock serverhttps://api.weavr.io/_mock/products/multi-backoffice/openapi/corporates/fees/charge
- Weavr Sandbox Environmenthttps://sandbox.weavr.io/multi/backoffice/corporates/fees/charge
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.weavr.io/_mock/products/multi-backoffice/openapi/corporates/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"
}
}'Success
Bodyapplication/json
The unique identifier of the transaction.
| Enum Value | Description |
|---|---|
| AUTHORISATION | |
| SETTLEMENT | |
| MANUAL_TRANSACTION | For a manual transaction, the
|
| TRANSFER | |
| SEND | |
| DEPOSIT | |
| AUTHORISATION_REVERSAL | |
| AUTHORISATION_EXPIRY | |
| AUTHORISATION_DECLINE | |
| AUTHORISATION_MANUAL_CLOSE | |
The profile Id which a specific identity, instrument or transaction type is linked to.
The object representing a monetary amount in a particular currency.
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
The transaction entry state.
Enum"INITIALISED""COMPLETED""REJECTED""FAILED""PENDING""SCHEDULED""CANCELLED"
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 }
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. These accounts can also be used as sources and destinations in the transfer transaction.
With the access_token representing the identity and the consent of the identity, you will be able to operations on the identity's managed accounts, such as getting a managed account's details and retrieving its statement.
Operations
Managed Cards are a type of financial instrument offered by Weavr. Cards created in prepaid mode have their own balance, whereas those created in debit mode tap into the balance of their parent Managed Accounts. Apart from being used at merchants for puchases, prepaid mode cards can also be used as sources and destinations in the transfer transaction.
With the access_token representing the identity and the consent of the identity, you will be able to perform operations on the identity's Managed Cards, such as getting a Managed Card's details and managing its spend rules.
Operations