POS Listing by Currency

• Endpoint: /vpws/paymentOptions
• 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 within the payment set assigned to the Dealer associated with the AccessToken, filtered by the specified currency.

The service output includes

• POS information assigned to the dealer
• Installment options for each POS
• Commission rates
• Visual fields for UI purposes
• Partner and POS type information

Note: This service only returns active POS terminals assigned to the dealer. General company POS terminals are not listed.

Query Parameters

Parameter	Type	Required	Description
currency	string	Yes	ISO 4217 currency code (e.g.: TRY, USD, EUR)

Example Request

Method: GET
Authorization: Bearer {AccessToken}
URL: https://apiUrl/vpws/paymentOptions?currency=TRY

Header Information

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

Response Structure

The service returns a POS list in array format. Each item represents a POS object.

POS Fields

Field	Type	Description
name	string	POS name
colorCode	string	Color code for UI
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

Logo Fields (logo)

Field	Type	Description
id	string (GUID)	Logo identifier
colorCode	string	Logo background color
isDefault	boolean	Default logo
logoSmall	string	Small size logo path
logoMedium	string/null	Medium size logo
logoBig	string/null	Large size logo
installmentCellColor	string	Installment cell background color

Installment / Commission Fields (commRates[])

Field	Type	Description
installment	int	Number of installments
commApplyTypeId	int	Commission application type ID
processCommRate	number	Commission rate (%)
plusInstallment	int	Campaign/additional installment count
paymentDeferral	int	Deferral period (day/month – per system definition)

Example Response

[
  {
    "name": "Param Axess 10738",
    "colorCode": "#FCAA0F",
    "logo": {
      "id": "e494c327-4425-ed11-98e1-005056b0d2e5",
      "colorCode": "#ffffff",
      "isDefault": true,
      "logoSmall": "~/Content/themes/base/images/apilogo/akbank/axess.png",
      "logoMedium": null,
      "logoBig": null,
      "installmentCellColor": "#fcffcd"
    },
    "commRates": [
      {
        "installment": 1,
        "commApplyTypeId": 10,
        "processCommRate": 0.0000,
        "plusInstallment": 0,
        "paymentDeferral": 0
      },
      {
        "installment": 2,
        "commApplyTypeId": 10,
        "processCommRate": 3.0000,
        "plusInstallment": 0,
        "paymentDeferral": 0
      }
    ],
    "isVisibleCommRate": false,
    "isDefaultPos": false,
    "posTypeId": 20,
    "partnerId": 1200
  }
]

Example cURL

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

Notes & Best Practices

• The currency parameter is required; if not sent, a 400 – P001 error is returned.

• Only active POS terminals assigned to the relevant dealer are listed.

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

• If isVisibleCommRate=false, rates can be hidden in the UI; the API may still return the rates.

• The partnerId field indicates the integration layer to which the transaction will be routed.

• posTypeId is a system classification field; should be checked on the business logic side.

• Commission calculations should be verified at the payment initiation stage.