Installments / Commission - General List
Endpoint: /pws/paymentOptions
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| currency | string | Yes | Currency (e.g. TRY, USD) |
| paymentSetId | string (GUID) | Yes | Payment set identifier |
Sample Request
Method: GET
Authorization: Bearer {AccessToken}
URL: https://pgw.netahsilatdemo.com/pws/paymentOptions?currency=TRY&paymentSetId=504978bf-bebd-40c5-89aa-b76f3a20341c
Response Structure (List)
Returns a list of POS entries. For each POS, basic fields and commRates (installment/commission) are included.
POS Fields
| Field | Type | Description |
|---|---|---|
| name | string | POS name (bank/provider name) |
| colorCode | string | POS color (for UI purposes) |
| logo | object | Logo information (small/medium/large paths etc.) |
| commRates | array | Installment options and rates |
| isVisibleCommRate | boolean | Should the commission rate be displayed in UI |
| isDefaultPos | boolean | Is it the default POS |
Logo Fields
| Field | Type | Description |
|---|---|---|
| id | string (GUID) | Logo identifier |
| colorCode | string | Background color of the logo |
| isDefault | boolean | Default logo |
| logoSmall/Medium/Big | string | Logo image paths |
| installmentCellColor | string | Cell color for installments in UI |
Installment / Commission Fields
| Field | Type | Description |
|---|---|---|
| installment | int | Number of installments |
| commApplyTypeId | int | Commission application type ID |
| processCommRate | number | Commission rate (percentage) |
| plusInstallment | int | Campaign/additional installment count (if any) |
- Sample Response
- Sample cURL
[
{
"name": "IyzicoWorld ",
"colorCode": "#701f7e",
"logo": {
"id": "f394c327-4425-ed11-98e1-005056b0d2e5",
"colorCode": "#ffffff",
"isDefault": true,
"logoSmall": "~/Content/themes/base/images/apilogo/yapikredi/world.png",
"logoMedium": null,
"logoBig": null,
"installmentCellColor": "#f5ecfe"
},
"commRates": [
{
"installment": 1,
"commApplyTypeId": 10,
"processCommRate": 0.0000,
"plusInstallment": 0
},
{
"installment": 2,
"commApplyTypeId": 10,
"processCommRate": 1.0600,
"plusInstallment": 0
}
],
"isVisibleCommRate": false,
"isDefaultPos": false
},
{
"name": "QnbFinansBank Yeni",
"colorCode": "#dcc0d8",
"logo": {
"id": "ff93c327-4425-ed11-98e1-005056b0d2e5",
"colorCode": "#ffffff",
"isDefault": false,
"logoSmall": "~/Content/themes/base/images/apilogo/finansbank/qnbfinansbank.png",
"logoMedium": null,
"logoBig": null,
"installmentCellColor": "#dcc0d8"
},
"commRates": [
{
"installment": 1,
"commApplyTypeId": 10,
"processCommRate": 1.0000,
"plusInstallment": 0
},
{
"installment": 2,
"commApplyTypeId": 10,
"processCommRate": 2.0000,
"plusInstallment": 3
},
{
"installment": 3,
"commApplyTypeId": 10,
"processCommRate": 3.0000,
"plusInstallment": 4
}
],
"isVisibleCommRate": false,
"isDefaultPos": false
}
]
curl --location 'https://pgw.netahsilatdemo.com/pws/paymentOptions?currency=TRY&paymentSetId=504978bf-bebd-40c5-89aa-b76f3a20341c' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJwd3N2MS5hcGkiLCJlcnB2MS5hcGkiLCJjYXR2MS5hcGkiLCJ2ZW5kb3J2MS5hcGkiXSwiYWN0b3J0Ijoic2VydmljZSIsInJvbGUiOiJzZXJ2aWNlIiwiVW5pcXVlIjoiNzk5NDYwMDctNDQ5Yi00ZWFlLTgyMTYtM2MwMzRhNTMxNDEzIiwiVGVuYW50SWQiOiI2NzA2ODNjMS0yZmUwLTQ4NDYtODdiMi02Y2JhOWI3OTNhYjIiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL2V4cGlyYXRpb24iOiI2Mzg5NjkxOTYwMDEzNTgzODEiLCJuYmYiOjE3NjExNTAwMDAsImV4cCI6MTc2MTMyMjgwMCwiaWF0IjoxNzYxMTUwMDAwLCJpc3MiOiJzc28uYXBpIiwiYXVkIjoiZWNvenVtLnNzbyJ9.HfY_FKNwpFrV2xG-OAcxDwh2DusG0E2NkzmOEeRwI6E'