Get Commission Fee

GET /v1/commission-fees/{id}

Path parameters

id string(uuid) Required

The id of the commission fee.

Responses

200 application/json

Request succeeded.
Hide response attributes Show response attributes object
- id string(uuid)
  
  The unique id.
- createdTimestamp string(date-time) | null
  
  The date and time of creation in UTC time.
- modifiedTimestamp string(date-time) | null
  
  The date and time last modification in UTC time.
- percentage number(double)
  
  The percentage of the commission. This will be specified as a decimal. For example, 5% will be specified as 0.05.
- amount number(currency)
  
  The amount of the fee.
- calculationMethodCode string | null
  
  The code for the method used to calculate the fee.
  
  Values are A or P.
- taxAmount number(currency)
  
  The amount of tax applied to the fee.
- taxPercentage number(double)
  
  The tax rate applied to the fee. This will be specified as a decimal. For example, 5% will be specified as 0.05.
- paymentMethodCode string | null
  
  The code for the method used to pay the fee.
- fee object
  
  A read only representation of a fee associated with a transaction.
  
  Additional properties are NOT allowed.
  
  Hide fee attributes Show fee attributes object
  
  shortName string | null
  
  The short name of the fee.
  
  name string | null
  
  The name of the fee.
400 application/json

Invalid request. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.
401 application/json

Unauthorized. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.
403 application/json

Permission denied. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.
404 application/json

Not found. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.

GET /v1/commission-fees/{id}

curl \
 --request GET 'https://api.lwolf.com/backoffice/v1/commission-fees/{id}'

Response examples (200)

{
  "id": "string",
  "createdTimestamp": "string",
  "modifiedTimestamp": "string",
  "percentage": 0,
  "amount": 0,
  "calculationMethodCode": "A",
  "taxAmount": 0,
  "taxPercentage": 0,
  "paymentMethodCode": "string",
  "fee": {
    "shortName": "string",
    "name": "string"
  }
}

Response examples (400)

{
  "id": "string",
  "code": 0,
  "message": "string",
  "details": [
    "string"
  ]
}

Response examples (401)

{
  "id": "string",
  "code": 0,
  "message": "string",
  "details": [
    "string"
  ]
}

Response examples (403)

{
  "id": "string",
  "code": 0,
  "message": "string",
  "details": [
    "string"
  ]
}

Response examples (404)

{
  "id": "string",
  "code": 0,
  "message": "string",
  "details": [
    "string"
  ]
}