---
updatedAt: 2026-02-16T08:49:12.000Z
agentTools:
  projectIndex: https://docs.myfatoorah.com/llms.txt
---

# CustomizeSupplierCommissions

Endpoint

## **Overview**

The "CustomizeSupplierCommissions" endpoint is a POST request. It is used to set a customized commission for the supplier based on the payment method that will be used to make the payment. Detailed functionality of how to use this endpoint is explained in the [Multiple Suppliers](https://docs.myfatoorah.com/docs/multiple-suppliers) section.

The endpoint on Swagger is [Supplier\_CustomizeSupplierCommissions](https://apitest.myfatoorah.com/swagger/ui/index#!/Supplier/Supplier_CustomizeSupplierCommissions).

Now, we are going to declare the endpoint and its models along with each accepted parameter and possible value.

> 📘 Request Header
>
> Add **"Authorization": "Bearer \{Token}"** to request header. Token of demo configuration can be found [here](https://docs.myfatoorah.com/docs/test-token).

<hr />

## **Request Model**

The request is a POST request with the following parameters:

| Input Parameter         | Type                                                                                                                      | Description |
| :---------------------- | :------------------------------------------------------------------------------------------------------------------------ | :---------- |
| **SupplierCode**        | integer                                                                                                                   |             |
| **SupplierCommissions** | [SupplierCommissions](https://docs.myfatoorah.com/docs/customizesuppliercommissions#SupplierCommissions) object, optional |             |

<hr />

## SupplierCommissions

This parameter is used for payment methods that have the **authorization and capture** feature enabled.

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Input Parameter
      </th>

      <th>
        Type
      </th>

      <th>
        Value
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        PaymentMethodId
      </td>

      <td>
        integer
      </td>

      <td>

      </td>
    </tr>

    <tr>
      <td>
        CommissionValue
      </td>

      <td>
        integer
      </td>

      <td>
        A fixed value that will be deducted from each transaction.
      </td>
    </tr>

    <tr>
      <td>
        CommissionPercentage
      </td>

      <td>
        integer
      </td>

      <td>
        A percentage value that will be deducted from each transaction.
      </td>
    </tr>

    <tr>
      <td>
        IsPercentageOfNetValue
      </td>

      <td>
        Boolean
      </td>

      <td>
        * \*true\*\*: deduct the percentage from the (total amount - transaction fees)  
        * \*false\*\*: deduct the percentage from the total amount\
          Affects only in case of one supplier in the request.
      </td>
    </tr>
  </tbody>
</Table>

<hr />

## **Response Model**

After viewing the [Response Model](https://docs.myfatoorah.com/docs/response-model) that you will get as a result of your request, here, you will find full details about the **Data** Model of this API endpoint. Let's check it and its contents.

| Response Field    | Type    | Description |
| :---------------- | :------ | :---------- |
| **SupplierCode**  | integer |             |
| **SupplierEmail** | string  |             |
| **Date**          | string  |             |

<hr />

## **Sample Message**

```json Request
{
    "SupplierCode": 11,
    "SupplierCommissions": [
        {
            "PaymentMethodId": 1,
            "CommissionValue": 1,
            "CommissionPercentage": 1,
            "IsPercentageOfNetValue": true
        },
        {
            "PaymentMethodId": 11,
            "CommissionValue": 0.1,
            "CommissionPercentage": 10,
            "IsPercentageOfNetValue": false
        }
    ]
}
```
```json Response
{
    "IsSuccess": true,
    "Message": "The Supplier Updated Successfully!",
    "FieldsErrors": null,
    "Data": {
        "SupplierCode": 11,
        "SupplierEmail": "test@test.com",
        "Date": "2022-06-21T12:25:00.94"
    }
}
```

<hr />