Installments / Commission by BIN

Endpoint: /pws/paymentOptions/{binNumber}

Route Parameters

Parameter	Type	Required	Description
binNumber	string	Yes	Card BIN number (6 or 8 digits, leading zeros are preserved)

Query Parameters

Parameter	Type	Required	Description
currency	string	Yes	Currency (e.g. TRY)
paymentSetId	string (GUID)	Yes	Payment set identifier
amount	number	No	(If provided) transaction amount to evaluate amount-based rules

Sample Request

Method: GET
Authorization: Bearer {AccessToken}
URL: https://pgw.netahsilatdemo.com/pws/paymentOptions/415565?currency=TRY&paymentSetId=504978bf-bebd-40c5-89aa-b76f3a20341c&amount=1

Response Structure

At the root level, general rules and the poses list are included.

Root Fields

Field	Type	Description
commApplyTypeId	int	Commission application type ID
installmentLowerLimit	number	(If any) minimum installment limit
threeDLimit	number	(If any) 3D Secure mandatory limit
poses	array	List of eligible POS
generalInstallmentLimit	number/null	General installment limit (if any)

POS Fields

Field	Type	Description
paymentSetPosId	string (GUID)	Payment set–POS relationship identifier
tenantPosId	string (GUID)	Tenant POS identifier
vPosApiId	int	Virtual POS / VPOS API identifier
threeDStatus	int	3D Secure status (according to system definition)
isCvvUse	boolean	Is CVV usage required
isDefaultPos	boolean	Is it the default POS
name	string	POS name
logo	object	Logo information
commRates	array	Installment/commission list (see table below)
posCurrencyDefinitionId	string (GUID)	POS currency definition identifier
creditCardTypeId	int	Card type ID
creditCardProgramId	int	Card program ID
isBusinessCard	boolean	Is it a business card
savedCreditCardUseCvv	boolean	Is CVV required for saved cards
hasCampaign	boolean	Is there a campaign
partnerApiDefinition	int/null	Integrated partner API definition (if any)
binFilterId	string/null	BIN filter identifier (if any)
maxMaturityDayCount	int	Maximum maturity day count
posTypeId	int	POS type ID
nonBinPos	boolean	Non-BIN-specific POS (generic)

Installment / Commission Fields

Field	Type	Description
id	string (GUID)	Rate record identifier
processCommRate	number	Commission rate (percentage)
installment	int	Number of installments
paymentDeferral	int	Deferral (days/months etc., per system definition)
plusInstallment	int	Additional installments
isRequiredCampaign	boolean	Is a campaign required

Sample Response

{  
    "commApplyTypeId": 10,  
    "installmentLowerLimit": 0.00,  
    "threeDLimit": 0.00,  
    "poses": [  
        {  
            "paymentSetPosId": "ab1c9260-00f5-4739-b5d3-3f1d902a2a14",  
            "tenantPosId": "384badef-11ec-ee11-98f2-005056b0d2e5",  
            "vPosApiId": 4200,  
            "threeDStatus": 1,  
            "isCvvUse": true,  
            "isDefaultPos": true,  
            "name": "QnbFinansBank Yeni",  
            "logo": {  
                "id": "00000000-0000-0000-0000-000000000000",  
                "colorCode": "#d0d0d0",  
                "isDefault": true,  
                "logoSmall": "~/Content/themes/base/images/apilogo/diger/kart.png",  
                "logoMedium": null,  
                "logoBig": null,  
                "installmentCellColor": "#e9e9e9"  
            },  
            "commRates": [  
                {  
                    "id": "a6774569-cda9-f011-98fc-005056b0d2e5",  
                    "processCommRate": 0.00,  
                    "installment": 1,  
                    "paymentDeferral": 0,  
                    "plusInstallment": 0,  
                    "isRequiredCampaign": false  
                }  
            ],  
            "posCurrencyDefinitionId": "8e6cc739-83e0-4af5-accf-a55476e758c6",  
            "creditCardTypeId": 20,  
            "creditCardProgramId": 40,  
            "isBusinessCard": false,  
            "savedCreditCardUseCvv": false,  
            "hasCampaign": false,  
            "partnerApiDefinition": null,  
            "binFilterId": null,  
            "maxMaturityDayCount": 0,  
            "posTypeId": 10,  
            "nonBinPos": true  
        },  
        {  
            "paymentSetPosId": "43ff0d6e-5649-4150-a164-e1f52465ff65",  
            "tenantPosId": "91cabf3e-ff9e-ee11-98ef-005056b0d2e5",  
            "vPosApiId": 12030,  
            "threeDStatus": 3,  
            "isCvvUse": true,  
            "isDefaultPos": false,  
            "name": "Param CardFinans 10738 ",  
            "logo": {  
                "id": "0195c327-4425-ed11-98e1-005056b0d2e5",  
                "colorCode": "#ffffff",  
                "isDefault": true,  
                "logoSmall": "~/Content/themes/base/images/apilogo/finansbank/cardfinans.png",  
                "logoMedium": null,  
                "logoBig": null,  
                "installmentCellColor": "#dcc0d8"  
            },  
            "commRates": [  
                {  
                    "id": "c92b5dd2-e7af-f011-98fc-005056b0d2e5",  
                    "processCommRate": 1.7500,  
                    "installment": 1,  
                    "paymentDeferral": 0,  
                    "plusInstallment": 0,  
                    "isRequiredCampaign": true  
                },  
                {  
                    "id": "e12b5dd2-e7af-f011-98fc-005056b0d2e5",  
                    "processCommRate": 5.0000,  
                    "installment": 3,  
                    "paymentDeferral": 0,  
                    "plusInstallment": 0,  
                    "isRequiredCampaign": true  
                }  
            ],  
            "posCurrencyDefinitionId": "8e6cc739-83e0-4af5-accf-a55476e758c6",  
            "creditCardTypeId": 20,  
            "creditCardProgramId": 40,  
            "isBusinessCard": false,  
            "savedCreditCardUseCvv": false,  
            "hasCampaign": true,  
            "partnerApiDefinition": 400,  
            "binFilterId": null,  
            "maxMaturityDayCount": 0,  
            "posTypeId": 20,  
            "nonBinPos": true  
        }  
    ],  
    "generalInstallmentLimit": null  
}

Sample cURL

curl --location 'https://pgw.netahsilatdemo.com/pws/paymentOptions/41556501111?currency=TRY&paymentSetId=504978bf-bebd-40c5-89aa-b76f3a20341c&amount=1' \  
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJwd3N2MS5hcGkiLCJlcnB2MS5hcGkiLCJjYXR2MS5hcGkiLCJ2ZW5kb3J2MS5hcGkiXSwiYWN0b3J0Ijoic2VydmljZSIsInJvbGUiOiJzZXJ2aWNlIiwiVW5pcXVlIjoiZmU2OGQ5ZjEtMjYyNy00NTdlLThkMmUtNDJkNGMyM2JhZTlhIiwiVGVuYW50SWQiOiI2NzA2ODNjMS0yZmUwLTQ4NDYtODdiMi02Y2JhOWI3OTNhYjIiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL2V4cGlyYXRpb24iOiI2Mzg5Njk2OTI3Mjg4NTEwMjYiLCJuYmYiOjE3NjExOTk2NzIsImV4cCI6MTc2MTM3MjQ3MiwiaWF0IjoxNzYxMTk5NjcyLCJpc3MiOiJzc28uYXBpIiwiYXVkIjoiZWNvenVtLnNzbyJ9.HXpxywhXCFfGclnFEBpOTOCdihT7ftMPyWtQEv2_Oak'

Notes & Best Practices

• BIN usage: In the /pws/paymentOptions/{binNumber} call, the BIN filters POS entries based on card program/bank matching.
• Amount-based rules: When amount is provided, campaign/limit rules (if any) may be evaluated accordingly.
• Visual fields: Fields such as colorCode, logo, installmentCellColor are for UI purposes and do not affect business logic.
• Commission display: If isVisibleCommRate=false, rates may be hidden in the UI; the API may still return the rates.
• Payment set synchronization: With paymentSetId, POS/commission data is returned according to the definitions in the payment set; inactive POS entries or unconfigured installments may not appear in the list.