Skip to content

Fees

Charge and retrieve in-platform fees.

Operations

Charge fee to a corporate

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

curl -i -X POST \
  https://sandbox.weavr.io/multi/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"
    }
  }'

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.

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
availableBalanceAdjustmentobject(CurrencyAmount)required

The object representing a monetary amount in a particular currency.

statestring(TransactionState)required

The transaction entry state.

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