Skip to main content
API docs by Redocly

Fees Manager API (v1)

Download OpenAPI specification:Download

API for manage rules to apply fees (v1.0.154)

Diagnostics

GetDiagnosticsInfo

Get current platform diagnostics data

Responses

Response samples

Content type
No sample

Playground

CalculateFees

Calculates fees for provided operation details

Request Body schema:
required

Request with operation details

partnerKey
required
string non-empty

Key of partner where fee should be calculated

dealerKey
string or null

Key of dealer where fee should be calculated

operationType
required
string non-empty

Operation type

storeId
string or null <uuid>

Optional store identifier

amount
number <double> >= 0

Amount of operation

operationDate
string <date-time>

Date/time of operation initialization

Responses

Request samples

Content type
{
  • "partnerKey": "string",
  • "dealerKey": "string",
  • "operationType": "string",
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "amount": 0.1,
  • "operationDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
No sample

ExplainCalculation

Executes calculation of fees using provided operation details and provides explanation for each rule evaluated during calculation process

Request Body schema:
required

Request with operation details

partnerKey
required
string non-empty

Key of partner where fee should be calculated

dealerKey
string or null

Key of dealer where fee should be calculated

operationType
required
string non-empty

Operation type

storeId
string or null <uuid>

Optional store identifier

amount
number <double> >= 0

Amount of operation

operationDate
string <date-time>

Date/time of operation initialization

Responses

Request samples

Content type
{
  • "partnerKey": "string",
  • "dealerKey": "string",
  • "operationType": "string",
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "amount": 0.1,
  • "operationDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
No sample

Rules

GetAllFeeRules

Returns a list of all fee rules available on authenticated partner

query Parameters
fromDate
string <date-time>
toDate
string <date-time>
pageSize
integer <int32>
Default: 50
pageNumber
integer <int32>
Default: 0

Responses

Response samples

Content type
No sample

CreateFeeRule

Creates a new rule, on partner, dealer or store, using provided data, that apply fee on single operation type

Request Body schema:
required

Request containing the rule data

operationType
required
string non-empty

Operation type associated with the rule

beneficiary
required
string non-empty

Code of beneficiary that will get the fees added by this rule (Ex. FLOWE, PARTNER, DEALER)

debtor
required
string non-empty

Entity that will pay the fee. Values: Customer, Store, Dealer, Partner, Flowe

code
required
string non-empty

Unique code of the rule (should never change)

dealerKey
string or null

Key of the dealer where the rule is active

storeId
string or null <uuid>

Store where the rule is active

name
required
string non-empty

Short description of the rule

description
required
string non-empty

More extended description of the rule

startValidity
string or null <date-time>

The date from which the rule is active; if null, rule was always valid

endValidity
string or null <date-time>

The date until which the rule is active; if null, rule will be always valid

minOperationAmount
number or null <double>

Minum amount of single operation that activates the rule. Ex1. Deposit operation: 15 eur, Rule with MinOperationAmount 10 eur => Rule Active. Ex2. Deposit operation: 15 euro, Rule with MinOperationAmount 20 eur => Rule Skipped

maxOperationAmount
number or null <double>

Maximum amount of single operation that activates the rule. Ex1. Deposit operation: 15 eur, Rule with MaxOperationAmount 10 eur => Rule Skipped. Ex2. Deposit operation: 15 euro, Rule with MaxOperationAmount 20 eur => Rule Active

minPartnerOperationsCount
integer or null <int32>

Minimum count of operations complete on partner that activates the rule. Ex. Fingroove with 1500 operations, Rule with 1000 MinPartnerOperationsCount => Rule Active

maxPartnerOperationsCount
integer or null <int32>

Maximum count of operations complete on partner that activates the rule. Ex. Fingroove with 1500 operations, Rule with 2000 MaxPartnerOperationsCount => Rule Active

calculationType
required
string non-empty

Type of calculation that is used for current rule (sum fixed, sum percentage, override fixed, ect)

calculationPrimaryValue
required
number <double> >= 0

Value used for calculation. This value rapresents fixed amount summed to fees, or percentage of operation than has overriden total fees, etc.

Responses

Request samples

Content type
{
  • "operationType": "string",
  • "beneficiary": "string",
  • "debtor": "string",
  • "code": "string",
  • "dealerKey": "string",
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "name": "string",
  • "description": "string",
  • "startValidity": "2019-08-24T14:15:22Z",
  • "endValidity": "2019-08-24T14:15:22Z",
  • "minOperationAmount": 0.1,
  • "maxOperationAmount": 0.1,
  • "minPartnerOperationsCount": 0,
  • "maxPartnerOperationsCount": 0,
  • "calculationType": "string",
  • "calculationPrimaryValue": 0.1
}

Response samples

Content type
No sample

GetDealerRules

Returns a list of all fee rules available on authenticated partner for a given dealer

path Parameters
dealerKey
required
string

Dealer identifier

Responses

Response samples

Content type
No sample

GetStoreRules

Returns a list of all fee rules available on authenticated partner for a given dealer

path Parameters
dealerKey
required
string

Dealer identifier

storeId
required
string <uuid>

Store identifier

Responses

Response samples

Content type
No sample

GetFeeRule

Returns a single fee rule existing on storage

path Parameters
ruleId
required
string <uuid>

Fee rule identifier

Responses

Response samples

Content type
No sample

UpdateFeeRule

Updates a existing rule, on partner, dealer or store, using provided data, that apply fee on single operation type

path Parameters
ruleId
required
string <uuid>

Fee rule identifier

Request Body schema:
required

Request containing the rule data

name
required
string non-empty

Short description of the rule

description
required
string non-empty

More extended description of the rule

debtor
required
string non-empty

Entity that will pay the fee. Values: Customer, Store, Dealer, Partner, Flowe

beneficiary
required
string non-empty

Entity that will receive the fee. Values: FLOWE, PARTNER, DEALER

startValidity
string or null <date-time>

The date from which the rule is active; if null, rule was always valid

endValidity
string or null <date-time>

The date until which the rule is active; if null, rule will be always valid

minOperationAmount
number or null <double>

Minum amount of single operation that activates the rule. Ex1. Deposit operation: 15 eur, Rule with MinOperationAmount 10 eur => Rule Active. Ex2. Deposit operation: 15 euro, Rule with MinOperationAmount 20 eur => Rule Skipped

maxOperationAmount
number or null <double>

Maximum amount of single operation that activates the rule. Ex1. Deposit operation: 15 eur, Rule with MaxOperationAmount 10 eur => Rule Skipped. Ex2. Deposit operation: 15 euro, Rule with MaxOperationAmount 20 eur => Rule Active

minPartnerOperationsCount
integer or null <int32>

Minimum count of operations complete on partner that activates the rule. Ex. Fingroove with 1500 operations, Rule with 1000 MinPartnerOperationsCount => Rule Active

maxPartnerOperationsCount
integer or null <int32>

Maximum count of operations complete on partner that activates the rule. Ex. Fingroove with 1500 operations, Rule with 2000 MaxPartnerOperationsCount => Rule Active

calculationType
required
string non-empty

Type of calculation that is used for current rule (sum fixed, sum percentage, override fixed, ect)

calculationPrimaryValue
required
number <double> >= 0

Value used for calculation. This value rapresents fixed amount summed to fees, or percentage of operation than has overriden total fees, etc.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "debtor": "string",
  • "beneficiary": "string",
  • "startValidity": "2019-08-24T14:15:22Z",
  • "endValidity": "2019-08-24T14:15:22Z",
  • "minOperationAmount": 0.1,
  • "maxOperationAmount": 0.1,
  • "minPartnerOperationsCount": 0,
  • "maxPartnerOperationsCount": 0,
  • "calculationType": "string",
  • "calculationPrimaryValue": 0.1
}

Response samples

Content type
No sample

DeleteFeeRule

Deletes an existing fee rule

path Parameters
ruleId
required
string <uuid>

Identifier of the rule to delete

Responses

Response samples

Content type
No sample

SwapFeeRulePriorities

Swaps the execution priority between two rules

path Parameters
firstRuleId
required
string <uuid>

First fee rule identifier

secondRuleId
required
string <uuid>

Second fee rule identifier

Responses

Response samples

Content type
No sample