Platform (v1.0.0)

Platform entity representing different payment platforms in the collecting system

Platform Entity

The Platform entity represents different payment platforms supported by the collecting system such as EASY, XPAY, NPG, and PAYTRAIL.

Properties

NameTypeRequiredDescription
platform_idstringRequiredUnique identifier for the platform (primary key)
platform_namestringRequiredName of the payment platform
versionintegerOptionalVersion number of the platform configuration
account_holder_idstringRequiredIdentifier of the account holder associated with this platform

Schema

schema.json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Platform",
"description": "Platform entity representing different payment platforms in the collecting system",
"properties": {
"platform_id": {
"type": "string",
"description": "Unique identifier for the platform (primary key)",
"example": "o7km365nhsqp5glqbi746bj0l0u9ihc3"
},
"platform_name": {
"type": "string",
"description": "Name of the payment platform",
"example": "EASY"
},
"version": {
"type": "integer",
"description": "Version number of the platform configuration",
"example": 1
},
"account_holder_id": {
"type": "string",
"description": "Identifier of the account holder associated with this platform",
"example": "5861813801100"
}
},
"required": ["platform_id", "platform_name", "account_holder_id"],
"additionalProperties": false
}

Overview

The Platform entity is a core domain model that encapsulates information about different payment platforms. It contains platform-specific configuration and behavior that drives how transactions are processed, fees are calculated, and payouts are handled.

Supported Platforms

  • EASY: Easy payment platform
  • XPAY: XPAY payment gateway
  • NPG: Next Payment Gateway
  • PAYTRAIL: Paytrail payment service

Business Rules

  • Platform configurations determine transaction processing behavior
  • Each platform may have specific fee structures and settlement rules
  • Platform settings affect merchant account configurations and operations