Skip to main content

Basic Information

This document has been prepared to integrate the Finrota Dealer Payment Web Service (VPWS) REST API services into your system, enabling end-to-end management of dealer payment processes.

Unlike PWS, VPWS enables payment operations to be performed directly under the Dealer identity rather than the company (site owner).

Purpose

Dealers can

  • List their own payment sets and POS rates
  • Initiate and complete payments on their own behalf
  • Query details of completed transactions
  • Execute reference-based cancellation and refund operations

through a single, holistic, and secure API structure.

What Is It For?

Finrota's payment infrastructure enables dealer-based financial operations to be executed in integration with the central system.

VPWS supports the following main functionalities

  • Listing payment sets and POS rates assigned to the dealer
  • Initiating payments on behalf of the dealer (3D / non-3D)
  • Querying transaction details in an ERP-compatible format
  • Performing cancellation and refund operations via referenceCode or clientReferenceCode

Key Differences from PWS

PWSVPWS
Transactions are made on behalf of the company (tenant/site owner)Transactions are made under the dealer identity
ApiKey is company-basedApiKey is dealer-based
agentCode is typically the customer codeagentCode is associated with the dealer identity
Company POS definitions are usedDealer-assigned POS terminals are used

How Does It Connect?

  • All services operate over the HTTPS/REST protocol.
  • Data exchange is performed in JSON format with the UTF-8 character set.
  • All calls must be encrypted with TLS 1.2+.

Security

  • Bearer Token–based authorization (AccessToken) is mandatory.
  • Each request must include a valid AccessToken.
  • Calls made with an expired token return 401 Unauthorized.
  • Dealer-based authorization is applied; each token is valid only for operations belonging to the respective dealer.
  • For token acquisition and renewal, see: 2. Authentication

Environments

EnvironmentURLDescription
Demo Environment (Sandbox)Test and development environment; no real financial transactions are performed.
Live Environment (Production)Environment where real payment transactions are processed.