PlatformCreateCommand (v1.0.0)

Command to create a new platform in the collecting system

PlatformCreateCommand

Creates a new Platform aggregate that represents a payment platform configuration in the collecting system.

Schema

schema.json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "PlatformCreateCommand",
"description": "Command to create a new platform in the collecting system",
"properties": {
"id": {
"type": "object",
"description": "Platform identifier",
"properties": {
"value": {
"type": "string",
"description": "The unique platform ID"
}
},
"required": ["value"]
},
"platformName": {
"type": "string",
"description": "The name of the platform (e.g., easy, xpay, npg, paytrail)"
}
},
"required": ["id", "platformName"],
"additionalProperties": false
}

Purpose

This command initializes a new platform configuration that can be used for payment processing, defining platform-specific settings and associations with account holders.

Key Attributes

  • Platform ID: Unique identifier for the platform
  • Platform Name: Name of the payment platform (e.g., EASY, XPAY, NPG, PAYTRAIL)
  • Account Holder ID: Identifier of the account holder associated with this platform
  • Version: Optional version number for the platform configuration

Supported Platforms

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

Business Rules

  • Platform ID must be unique across the system
  • Platform name must be specified and non-empty
  • Account holder ID must reference a valid account holder
  • Platform configurations determine transaction processing behavior

Result

When successful, this command produces a PlatformCreatedEvent and stores the platform configuration for use in payment processing.