Changelog
Start typing to search…
Back to All

20.08.2025

4 days ago by Meir ifrach

🆕 New Endpoints

Merchants Management

We've added comprehensive merchant management capabilities to help you better organize and control your merchant accounts.

GET /merchants

  • Summary: Get merchants
  • Description: Retrieve a list of merchants with optional filtering and pagination
  • New Query Parameters:
    • merchantUuid: Filter by specific merchant UUID
    • Standard pagination (limit, page) and date filtering (startDate, endDate)
  • Response: Array of merchant objects with status information

POST /merchants

  • Summary: Create merchant
  • Description: Create a new merchant with business profile information
  • Request Body:
    • merchantName (required): The name of the merchant
    • websiteUrl (optional): The merchant's website URL
    • referenceId (optional): External reference ID for the merchant
  • Response: Returns the newly created merchant's UUID

DELETE /merchants

  • Summary: Deactivate merchant
  • Description: Deactivate a merchant (merchant is not removed, only deactivated)
  • Request Body:
    • deactivationType: Either "posting_date" or "due_date"
    • deactivationDate: When the deactivation should take effect

Integrations Management

New integration management system for handling PSP (Payment Service Provider) connections.

GET /integrations

  • Summary: Get integrations
  • Description: Retrieve a list of integrations with optional filtering and pagination
  • New Query Parameters:
    • integrationId: Filter by specific integration ID
    • Standard pagination and date filtering support
  • Response: Array of integration objects with connection status

POST /integrations

  • Summary: Create integration
  • Description: Create a new payment integration with PSP
  • Request Body:
    • externalIdentifier (required): External identifier for the integration
    • integrationName (required): Name of the integration
    • source (required): PSP type (stripe, braintree, paypal, adyen)
    • secretType (required): Authentication method (APIKEY_ONLY, PUBLIC_SECRET_KEY, BASIC_AUTH, USERNAME_PASSWORD, HMAC, APIKEY)
    • secretPayload (required): PSP-specific configuration object
  • Response: Returns the newly created integration ID

**DELETE /integrations/<ID>**

  • Summary: Deactivate integration
  • Description: Deactivate an integration (integration is not removed, only deactivated)
  • Path Parameter: id - Integration ID to deactivate
  • Request Body:
    • integrationId: Integration ID to deactivate
    • deactivationType: Either "posting_date" or "due_date"
    • deactivationDate: When the deactivation should take effect

🔄 Updated Endpoints

🏷️ New API Organization

  • Tags Added: All endpoints now include proper tags for better API organization:
    • Chargebacks - All chargeback-related operations
    • Files - File upload operations
    • Data Subjects - Data privacy operations
    • Merchants - Merchant management operations
    • Integrations - Integration management operations

📊 New Data Models

Merchant Models

  • MerchantResponseDto: Complete merchant information with status
  • MerchantOverallStatus: Enum with merchant states (SetupIncomplete, Active, Inactive, etc.)
  • CreateMerchantDto: Request model for creating merchants
  • CreateMerchantResponseDto: Response model with new merchant UUID
  • DeactivateMerchantDto: Request model for merchant deactivation

Integration Models

  • IntegrationResponseDto: Complete integration information with status
  • SupportedPSP: Enum of supported payment service providers
  • MerchantIntegrationSourceStatus: Integration status tracking
  • IntegrationConnectionTypeEnum: Authentication methods with detailed documentation
  • CreateIntegrationDto: Request model for creating integrations
  • CreateIntegrationResponseDto: Response model with new integration ID
  • DeactivateIntegrationDto: Request model for integration deactivation

Shared Models

  • DeactivationType: Enum for deactivation timing options (posting_date, due_date)

🔧 Integration Authentication Types

The new integration system supports multiple authentication methods:

  • APIKEY_ONLY: Single API key authentication
  • PUBLIC_SECRET_KEY: Public and secret key pair authentication
  • BASIC_AUTH: Basic authentication with client credentials
  • USERNAME_PASSWORD: Username and password authentication
  • HMAC: HMAC signature based authentication
  • APIKEY: API key with additional store-specific fields

Each authentication type has specific required and optional fields, making it flexible for different PSP requirements.