Skip to main content

Endpoint Reference Guide

Endpoint Reference Guide​

NoEndpointHTTP MethodAuthorizationDescription
3.1./pws/paymentSetGETAccessToken requiredLists defined payment sets, POS terminals, and rates.
3.2.1./pws/paymentOptionsGETAccessToken requiredLists POS installment/commission rates for the specified currency and payment set.
3.2.2./pws/paymentOptions/{BinNumber}GETAccessToken requiredReturns a filtered list of POS terminals and rates based on the BIN number.
3.3./pws/paymentPOSTAccessToken requiredInitiates and completes a 3D or non-3D payment request.
3.4./pws/payment/transactionGET / POSTAccessToken requiredRetrieves payment transaction details using the specified referenceNumber or transactionId. Compatible with ERP GetPayment.
3.5./pws/payment/cancelPOSTAccessToken requiredCancels a successful transaction using the specified referenceCode.
3.6./pws/payment/refundPOSTAccessToken requiredPerforms a full or partial refund using the specified referenceCode.

Additional Information​

CategoryDescription
AuthenticationBearer Token (AccessToken) is mandatory for all services. The token must be obtained from the Payment service.
Data FormatRequests and responses are sent in application/json format with the UTF-8 character set.
SecurityAll requests must be made over HTTPS (TLS 1.2+). Card information is masked in accordance with PCI-DSS requirements.
Environment Information• Sandbox (Test): https://pgw.netahsilatdemo.com • Prod (Live): https://pgw.netahsilat.com
TimestampDate/time fields are returned in ISO 8601 format (yyyy-MM-ddTHH:mm:ss.fffZ).
CurrencyThe currencyCode parameter follows the ISO 4217 standard (e.g., TRY, USD, EUR).
Installment LimitsVary by POS; returned under commRates with the installment and processCommRate fields.

Security Warnings​

  • Card data must be sent only at the time of payment; storage is prohibited under KVKK and PCI-DSS.

  • Real card information must not be used in the test environment.

  • Tokens must be generated only with authorized user or dealer credentials.

  • Fields such as cardNumber, email, and fullName included in responses must be anonymized in test scenarios.

Documentation Structure Recommendation​

In the full integration documentation, the following order is recommended:

  • Basic Information
  • Authentication (Obtaining an AccessToken)
  • Service Endpoints All payment APIs from 3.1 to 3.6
  • General Error Model & CodesPagination & Filtering Rules
  • FAQ (Frequently Asked Questions)
  • Appendix: Endpoint Reference Guide (this section)