POS Listing by BIN

• Endpoint: /vpws/paymentOptions/{binNumber}
• HTTP Method: GET
• Request Content-Type: application/json
• Response Content-Type: application/json
• Authorization: Valid AccessToken required.
  (See: 2. Authentication – Obtaining AccessToken)

Description

This service lists the POS terminals assigned to the dealer and compatible with the relevant currency, filtered by the specified BIN number (first 6 or 8 digits of the card).

The service output includes

• POS terminals filtered by card program/bank match
• Installment and commission rates
• Amount-based rules (if amount parameter is provided)
• POS and partner information

Note: In BIN-based calls, POS terminals incompatible with the card program and bank are not listed.

Route Parameters

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

Query Parameters

Parameter	Type	Required	Description
currency	string	Yes	ISO 4217 currency code (e.g.: TRY, USD, EUR)
amount	number	No	Transaction amount. Used for campaign/limit rule evaluation

Example Request

Method: GET
Authorization: Bearer {AccessToken}
URL: https://api/vpws/paymentOptions/415565?currency=TRY&amount=1500

Header Information

Header Name	Required	Description
Authorization	Yes	Bearer {AccessToken}
Content-Type	No	application/json

Response Structure

The service returns a POS list in the same format as 3.1. However, the list is filtered based on the provided BIN number.

POS Fields

Field	Type	Description
name	string	POS name
colorCode	string	UI color code
logo	object	Logo information
commRates	array	Installment and commission rates
isVisibleCommRate	boolean	Should commission rate be shown in UI
isDefaultPos	boolean	Is it the default POS
posTypeId	int	POS type identifier
partnerId	int	Integrated partner system identifier

Installment / Commission Fields (commRates[])

Field	Type	Description
installment	int	Number of installments
commApplyTypeId	int	Commission application type
processCommRate	number	Commission rate (%)
plusInstallment	int	Additional installments
paymentDeferral	int	Deferral period

Example cURL

curl --location 'https://pgw.netahsilatdemo.com/vpws/paymentOptions/415565?currency=TRY&amount=1500' \
--header 'Authorization: Bearer {AccessToken}'

Notes & Best Practices

• BIN number must be 6 or 8 digits.

• If BIN is not sent, a 400 – P001 error is returned.

• The currency parameter is required.

• If the amount parameter is sent, campaign and limit rules are evaluated accordingly.

• POS terminals incompatible with the BIN are not listed.

• commRates may return empty; this may indicate the POS only supports single payment.

• BIN-based verification before initiating a transaction is recommended.